aws-sdk-for-zig/codegen/models/ecs.2014-11-13.json

9319 lines
665 KiB
JSON
Raw Normal View History

2021-05-30 01:17:45 +00:00
{
"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": "<p>You do not have authorization to perform the requested action.</p>",
"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": "<fullname>Amazon Elastic Container Service</fullname>\n\t\t <p>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.</p>\n\t\t <p>Amazon 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.</p>\n\t\t <p>You 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.</p>",
"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": "<p>The unique identifier for the attachment.</p>"
}
},
"type": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The type of the attachment, such as <code>ElasticNetworkInterface</code>.</p>"
}
},
"status": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p> The status of the attachment. Valid values are <code>PRECREATED</code>,\n\t\t\t\t<code>CREATED</code>, <code>ATTACHING</code>, <code>ATTACHED</code>,\n\t\t\t\t<code>DETACHING</code>, <code>DETACHED</code>, and <code>DELETED</code>.</p>"
}
},
"details": {
"target": "com.amazonaws.ecs#AttachmentDetails",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object representing a container instance or task attachment.</p>"
}
},
"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": "<p>The Amazon Resource Name (ARN) of the attachment.</p>",
"smithy.api#required": {}
}
},
"status": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The status of the attachment.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object representing a change in state for a task attachment.</p>"
}
},
"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": "<p>The name of the attribute. The <code>name</code> 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.</p>",
"smithy.api#required": {}
}
},
"value": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The value of the attribute. The <code>value</code> 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.</p>"
}
},
"targetType": {
"target": "com.amazonaws.ecs#TargetType",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"targetId": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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).</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes\">Attributes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"com.amazonaws.ecs#AttributeLimitExceededException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.ecs#String"
}
},
"traits": {
"smithy.api#documentation": "<p>You can apply up to 10 custom attributes per resource. You can view the attributes of\n\t\t\ta resource with <a>ListAttributes</a>. You can remove existing attributes on\n\t\t\ta resource with <a>DeleteAttributes</a>.</p>",
"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": "<p>The Amazon Resource Name (ARN) that identifies the Auto Scaling group.</p>",
"smithy.api#required": {}
}
},
"managedScaling": {
"target": "com.amazonaws.ecs#ManagedScaling",
"traits": {
"smithy.api#documentation": "<p>The managed scaling settings for the Auto Scaling group capacity provider.</p>"
}
},
"managedTerminationProtection": {
"target": "com.amazonaws.ecs#ManagedTerminationProtection",
"traits": {
"smithy.api#documentation": "<p>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.</p>\n\t\t <important>\n\t\t\t <p>When using managed termination protection, managed scaling must also be used\n\t\t\t\totherwise managed termination protection will not work.</p>\n\t\t </important>\n\t\t <p>When 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 <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection\">Instance Protection</a> in the <i>AWS Auto Scaling User Guide</i>.</p>\n\t\t <p>When managed termination protection is disabled, your Amazon EC2 instances are not\n\t\t\tprotected from termination when the Auto Scaling group scales in.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The details of the Auto Scaling group for the capacity provider.</p>"
}
},
"com.amazonaws.ecs#AutoScalingGroupProviderUpdate": {
"type": "structure",
"members": {
"managedScaling": {
"target": "com.amazonaws.ecs#ManagedScaling",
"traits": {
"smithy.api#documentation": "<p>The managed scaling settings for the Auto Scaling group capacity provider.</p>"
}
},
"managedTerminationProtection": {
"target": "com.amazonaws.ecs#ManagedTerminationProtection",
"traits": {
"smithy.api#documentation": "<p>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.</p>\n\t\t <important>\n\t\t\t <p>When using managed termination protection, managed scaling must also be used\n\t\t\t\totherwise managed termination protection will not work.</p>\n\t\t </important>\n\t\t <p>When 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 <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection\">Instance Protection</a> in the <i>AWS Auto Scaling User Guide</i>.</p>\n\t\t <p>When managed termination protection is disabled, your Amazon EC2 instances are not\n\t\t\tprotected from termination when the Auto Scaling group scales in.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The details of the Auto Scaling group capacity provider to update.</p>"
}
},
"com.amazonaws.ecs#AwsVpcConfiguration": {
"type": "structure",
"members": {
"subnets": {
"target": "com.amazonaws.ecs#StringList",
"traits": {
"smithy.api#documentation": "<p>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 <code>AwsVpcConfiguration</code>.</p>\n\t\t \n\t\t <note>\n\t\t\t <p>All specified subnets must be from the same VPC.</p>\n\t\t </note>",
"smithy.api#required": {}
}
},
"securityGroups": {
"target": "com.amazonaws.ecs#StringList",
"traits": {
"smithy.api#documentation": "<p>The 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\t<code>AwsVpcConfiguration</code>.</p>\n\t\t \n\t\t <note>\n\t\t\t <p>All specified security groups must be from the same VPC.</p>\n\t\t </note>"
}
},
"assignPublicIp": {
"target": "com.amazonaws.ecs#AssignPublicIp",
"traits": {
"smithy.api#documentation": "<p>Whether the task's elastic network interface receives a public IP address. The default\n\t\t\tvalue is <code>DISABLED</code>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object representing the networking details for a task or service.</p>"
}
},
"com.amazonaws.ecs#BlockedException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.ecs#String"
}
},
"traits": {
"smithy.api#documentation": "<p>Your AWS account has been blocked. For more information, contact <a href=\"http://aws.amazon.com/contact-us/\">AWS Support</a>.</p>",
"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": "<p>The Amazon Resource Name (ARN) that identifies the capacity provider.</p>"
}
},
"name": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The name of the capacity provider.</p>"
}
},
"status": {
"target": "com.amazonaws.ecs#CapacityProviderStatus",
"traits": {
"smithy.api#documentation": "<p>The current status of the capacity provider. Only capacity providers in an\n\t\t\t\t<code>ACTIVE</code> state can be used in a cluster. When a capacity provider is\n\t\t\tsuccessfully deleted, it will have an <code>INACTIVE</code> status.</p>"
}
},
"autoScalingGroupProvider": {
"target": "com.amazonaws.ecs#AutoScalingGroupProvider",
"traits": {
"smithy.api#documentation": "<p>The Auto Scaling group settings for the capacity provider.</p>"
}
},
"updateStatus": {
"target": "com.amazonaws.ecs#CapacityProviderUpdateStatus",
"traits": {
"smithy.api#documentation": "<p>The update status of the capacity provider. The following are the possible states that\n\t\t\twill be returned.</p>\n\t\t <dl>\n <dt>DELETE_IN_PROGRESS</dt>\n <dd>\n\t\t\t\t\t <p>The capacity provider is in the process of being deleted.</p>\n\t\t\t\t </dd>\n <dt>DELETE_COMPLETE</dt>\n <dd>\n\t\t\t\t\t <p>The capacity provider has been successfully deleted and will have an\n\t\t\t\t\t\t\t<code>INACTIVE</code> status.</p>\n\t\t\t\t </dd>\n <dt>DELETE_FAILED</dt>\n <dd>\n\t\t\t\t\t <p>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.</p>\n\t\t\t\t </dd>\n </dl>"
}
},
"updateStatusReason": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The update status reason. This provides further details about the update status for\n\t\t\tthe capacity provider.</p>"
}
},
"tags": {
"target": "com.amazonaws.ecs#Tags",
"traits": {
"smithy.api#documentation": "<p>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.</p> \n <p>The following basic restrictions apply to tags:</p>\n <ul>\n <li>\n <p>Maximum number of tags per resource - 50</p>\n </li>\n <li>\n <p>For each resource, each tag key must be unique, and each tag key can have only\n one value.</p>\n </li>\n <li>\n <p>Maximum key length - 128 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>Maximum value length - 256 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>If 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: + - = . _ : / @.</p>\n </li>\n <li>\n <p>Tag keys and values are case-sensitive.</p>\n </li>\n <li>\n <p>Do not use <code>aws:</code>, <code>AWS:</code>, 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.</p>\n </li>\n </ul>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The details of a capacity provider.</p>"
}
},
"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": "<p>The short name of the capacity provider.</p>",
"smithy.api#required": {}
}
},
"weight": {
"target": "com.amazonaws.ecs#CapacityProviderStrategyItemWeight",
"traits": {
"smithy.api#documentation": "<p>The <i>weight</i> 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\t<code>weight</code> value is taken into consideration after the <code>base</code>\n\t\t\tvalue, if defined, is satisfied.</p>\n\t\t <p>If no <code>weight</code> value is specified, the default value of <code>0</code> 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 <code>0</code> 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 <code>0</code>, any <code>RunTask</code> or <code>CreateService</code> actions\n\t\t\tusing the capacity provider strategy will fail.</p>\n\t\t <p>An example scenario for using weights is defining a strategy that contains two\n\t\t\tcapacity providers and both have a weight of <code>1</code>, then when the\n\t\t\t\t<code>base</code> 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 <code>1</code> for\n\t\t\t\t<i>capacityProviderA</i> and a weight of <code>4</code> for\n\t\t\t\t<i>capacityProviderB</i>, then for every one task that is run using\n\t\t\t\t<i>capacityProviderA</i>, four tasks would use\n\t\t\t\t<i>capacityProviderB</i>.</p>"
}
},
"base": {
"target": "com.amazonaws.ecs#CapacityProviderStrategyItemBase",
"traits": {
"smithy.api#documentation": "<p>The <i>base</i> 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 <i>base</i> defined. If no value is specified, the\n\t\t\tdefault value of <code>0</code> is used.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The details of a capacity provider strategy. A capacity provider strategy can be set\n\t\t\twhen using the <a>RunTask</a> or <a>CreateCluster</a> APIs or as\n\t\t\tthe default capacity provider strategy for a cluster with the <a>CreateCluster</a> API.</p>\n\t\t <p>Only capacity providers that are already associated with a cluster and have an\n\t\t\t\t<code>ACTIVE</code> or <code>UPDATING</code> status can be used in a capacity\n\t\t\tprovider strategy. The <a>PutClusterCapacityProviders</a> API is used to\n\t\t\tassociate a capacity provider with a cluster.</p>\n\t\t <p>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 <a>CreateCapacityProvider</a> API operation.</p>\n\t\t <p>To use a AWS Fargate capacity provider, specify either the <code>FARGATE</code> or\n\t\t\t\t<code>FARGATE_SPOT</code> 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.</p>"
}
},
"com.amazonaws.ecs#CapacityProviderStrategyItemBase": {
"type": "integer",
"traits": {
"smithy.api#range": {
"min": 0,
"max": 100000
}
}
},
"com.amazonaws.ecs#CapacityProviderStrategyItemWeight": {
"type": "integer",
"traits": {
"smithy.api#range": {
"min": 0,
"max": 1000
}
}
},
"com.amazonaws.ecs#CapacityProviderUpdateStatus": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "DELETE_IN_PROGRESS",
"name": "DELETE_IN_PROGRESS"
},
{
"value": "DELETE_COMPLETE",
"name": "DELETE_COMPLETE"
},
{
"value": "DELETE_FAILED",
"name": "DELETE_FAILED"
},
{
"value": "UPDATE_IN_PROGRESS",
"name": "UPDATE_IN_PROGRESS"
},
{
"value": "UPDATE_COMPLETE",
"name": "UPDATE_COMPLETE"
},
{
"value": "UPDATE_FAILED",
"name": "UPDATE_FAILED"
}
]
}
},
"com.amazonaws.ecs#CapacityProviders": {
"type": "list",
"member": {
"target": "com.amazonaws.ecs#CapacityProvider"
}
},
"com.amazonaws.ecs#ClientException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.ecs#String"
}
},
"traits": {
"smithy.api#documentation": "<p>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.</p>",
"smithy.api#error": "client"
}
},
"com.amazonaws.ecs#Cluster": {
"type": "structure",
"members": {
"clusterArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the Region of the cluster, the AWS account ID of the cluster owner, the <code>cluster</code> namespace, and then the cluster name. For example, <code>arn:aws:ecs:region:012345678910:cluster/test</code>.</p>"
}
},
"clusterName": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>A user-generated string that you use to identify your cluster.</p>"
}
},
"configuration": {
"target": "com.amazonaws.ecs#ClusterConfiguration",
"traits": {
"smithy.api#documentation": "<p>The execute command configuration for the cluster.</p>"
}
},
"status": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The status of the cluster. The following are the possible states that will be\n\t\t\treturned.</p>\n\t\t <dl>\n <dt>ACTIVE</dt>\n <dd>\n\t\t\t\t\t <p>The cluster is ready to accept tasks and if applicable you can register\n\t\t\t\t\t\tcontainer instances with the cluster.</p>\n\t\t\t\t </dd>\n <dt>PROVISIONING</dt>\n <dd>\n\t\t\t\t\t <p>The cluster has capacity providers associated with it and the resources\n\t\t\t\t\t\tneeded for the capacity provider are being created.</p>\n\t\t\t\t </dd>\n <dt>DEPROVISIONING</dt>\n <dd>\n\t\t\t\t\t <p>The cluster has capacity providers associated with it and the resources\n\t\t\t\t\t\tneeded for the capacity provider are being deleted.</p>\n\t\t\t\t </dd>\n <dt>FAILED</dt>\n <dd>\n\t\t\t\t\t <p>The 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.</p>\n\t\t\t\t </dd>\n <dt>INACTIVE</dt>\n <dd>\n\t\t\t\t\t <p>The cluster has been deleted. Clusters with an <code>INACTIVE</code>\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 <code>INACTIVE</code> clusters persisting.</p>\n\t\t\t\t </dd>\n </dl>"
}
},
"registeredContainerInstancesCount": {
"target": "com.amazonaws.ecs#Integer",
"traits": {
"smithy.api#documentation": "<p>The number of container instances registered into the cluster. This includes container\n\t\t\tinstances in both <code>ACTIVE</code> and <code>DRAINING</code> status.</p>"
}
},
"runningTasksCount": {
"target": "com.amazonaws.ecs#Integer",
"traits": {
"smithy.api#documentation": "<p>The number of tasks in the cluster that are in the <code>RUNNING</code> state.</p>"
}
},
"pendingTasksCount": {
"target": "com.amazonaws.ecs#Integer",
"traits": {
"smithy.api#documentation": "<p>The number of tasks in the cluster that are in the <code>PENDING</code> state.</p>"
}
},
"activeServicesCount": {
"target": "com.amazonaws.ecs#Integer",
"traits": {
"smithy.api#documentation": "<p>The number of services that are running on the cluster in an <code>ACTIVE</code>\n\t\t\tstate. You can view these services with <a>ListServices</a>.</p>"
}
},
"statistics": {
"target": "com.amazonaws.ecs#Statistics",
"traits": {
"smithy.api#documentation": "<p>Additional information about your clusters that are separated by launch type,\n\t\t\tincluding:</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>runningEC2TasksCount</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>RunningFargateTasksCount</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>pendingEC2TasksCount</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>pendingFargateTasksCount</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>activeEC2ServiceCount</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>activeFargateServiceCount</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>drainingEC2ServiceCount</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>drainingFargateServiceCount</p>\n\t\t\t </li>\n </ul>"
}
},
"tags": {
"target": "com.amazonaws.ecs#Tags",
"traits": {
"smithy.api#documentation": "<p>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.</p>\n\t\t <p>The following basic restrictions apply to tags:</p>\n <ul>\n <li>\n <p>Maximum number of tags per resource - 50</p>\n </li>\n <li>\n <p>For each resource, each tag key must be unique, and each tag key can have only\n one value.</p>\n </li>\n <li>\n <p>Maximum key length - 128 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>Maximum value length - 256 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>If 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: + - = . _ : / @.</p>\n </li>\n <li>\n <p>Tag keys and values are case-sensitive.</p>\n </li>\n <li>\n <p>Do not use <code>aws:</code>, <code>AWS:</code>, 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.</p>\n </li>\n </ul>"
}
},
"settings": {
"target": "com.amazonaws.ecs#ClusterSettings",
"traits": {
"smithy.api#documentation": "<p>The settings for the cluster. This parameter indicates whether CloudWatch Container Insights\n\t\t\tis enabled or disabled for a cluster.</p>"
}
},
"capacityProviders": {
"target": "com.amazonaws.ecs#StringList",
"traits": {
"smithy.api#documentation": "<p>The capacity providers associated with the cluster.</p>"
}
},
"defaultCapacityProviderStrategy": {
"target": "com.amazonaws.ecs#CapacityProviderStrategy",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"attachments": {
"target": "com.amazonaws.ecs#Attachments",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"attachmentsStatus": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The status of the capacity providers associated with the cluster. The following are\n\t\t\tthe states that will be returned:</p>\n\t\t <dl>\n <dt>UPDATE_IN_PROGRESS</dt>\n <dd>\n\t\t\t\t\t <p>The 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.</p>\n\t\t\t\t </dd>\n <dt>UPDATE_COMPLETE</dt>\n <dd>\n\t\t\t\t\t <p>The capacity providers have successfully updated.</p>\n\t\t\t\t </dd>\n <dt>UPDATE_FAILED</dt>\n <dd>\n\t\t\t\t\t <p>The capacity provider updates failed.</p>\n\t\t\t\t </dd>\n </dl>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A 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.</p>"
}
},
"com.amazonaws.ecs#ClusterConfiguration": {
"type": "structure",
"members": {
"executeCommandConfiguration": {
"target": "com.amazonaws.ecs#ExecuteCommandConfiguration",
"traits": {
"smithy.api#documentation": "<p>The details of the execute command configuration.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The execute command configuration for the cluster.</p>"
}
},
"com.amazonaws.ecs#ClusterContainsContainerInstancesException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.ecs#String"
}
},
"traits": {
"smithy.api#documentation": "<p>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\t<a>DeregisterContainerInstance</a>.</p>",
"smithy.api#error": "client"
}
},
"com.amazonaws.ecs#ClusterContainsServicesException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.ecs#String"
}
},
"traits": {
"smithy.api#documentation": "<p>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 <a>UpdateService</a> and <a>DeleteService</a>.</p>",
"smithy.api#error": "client"
}
},
"com.amazonaws.ecs#ClusterContainsTasksException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.ecs#String"
}
},
"traits": {
"smithy.api#documentation": "<p>You cannot delete a cluster that has active tasks.</p>",
"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": "<p>The specified cluster could not be found. You can view your available clusters with\n\t\t\t\t<a>ListClusters</a>. Amazon ECS clusters are Region-specific.</p>",
"smithy.api#error": "client"
}
},
"com.amazonaws.ecs#ClusterSetting": {
"type": "structure",
"members": {
"name": {
"target": "com.amazonaws.ecs#ClusterSettingName",
"traits": {
"smithy.api#documentation": "<p>The name of the cluster setting. The only supported value is\n\t\t\t\t<code>containerInsights</code>.</p>"
}
},
"value": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The value to set for the cluster setting. The supported values are\n\t\t\t\t<code>enabled</code> and <code>disabled</code>. If <code>enabled</code> is\n\t\t\tspecified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be\n\t\t\tdisabled unless the <code>containerInsights</code> account setting is enabled. If a\n\t\t\tcluster value is specified, it will override the <code>containerInsights</code> value\n\t\t\tset with <a>PutAccountSetting</a> or <a>PutAccountSettingDefault</a>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The settings to use when creating a cluster. This parameter is used to enable CloudWatch\n\t\t\tContainer Insights for a cluster.</p>"
}
},
"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": "<p>The Amazon Resource Name (ARN) of the container.</p>"
}
},
"taskArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The ARN of the task.</p>"
}
},
"name": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The name of the container.</p>"
}
},
"image": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The image used for the container.</p>"
}
},
"imageDigest": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The container image manifest digest.</p>\n\t\t <note>\n\t\t\t <p>The <code>imageDigest</code> is only returned if the container is using an image\n\t\t\t\thosted in Amazon ECR, otherwise it is omitted.</p>\n\t\t </note>"
}
},
"runtimeId": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The ID of the Docker container.</p>"
}
},
"lastStatus": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The last known status of the container.</p>"
}
},
"exitCode": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>The exit code returned from the container.</p>"
}
},
"reason": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>A short (255 max characters) human-readable string to provide additional details about\n\t\t\ta running or stopped container.</p>"
}
},
"networkBindings": {
"target": "com.amazonaws.ecs#NetworkBindings",
"traits": {
"smithy.api#documentation": "<p>The network bindings associated with the container.</p>"
}
},
"networkInterfaces": {
"target": "com.amazonaws.ecs#NetworkInterfaces",
"traits": {
"smithy.api#documentation": "<p>The network interfaces associated with the container.</p>"
}
},
"healthStatus": {
"target": "com.amazonaws.ecs#HealthStatus",
"traits": {
"smithy.api#documentation": "<p>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\t<code>UNKNOWN</code>.</p>"
}
},
"managedAgents": {
"target": "com.amazonaws.ecs#ManagedAgents",
"traits": {
"smithy.api#documentation": "<p>The details of any Amazon ECS managed agents associated with the container.</p>"
}
},
"cpu": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The number of CPU units set for the container. The value will be <code>0</code> if no\n\t\t\tvalue was specified in the container definition when the task definition was\n\t\t\tregistered.</p>"
}
},
"memory": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The hard limit (in MiB) of memory set for the container.</p>"
}
},
"memoryReservation": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The soft limit (in MiB) of memory set for the container.</p>"
}
},
"gpuIds": {
"target": "com.amazonaws.ecs#GpuIds",
"traits": {
"smithy.api#documentation": "<p>The IDs of each GPU assigned to the container.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A Docker container that is part of a task.</p>"
}
},
"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": "<p>The name of a container. If you are linking multiple containers together in a task\n\t\t\tdefinition, the <code>name</code> of one container can be entered in the\n\t\t\t\t<code>links</code> 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 <code>name</code> in the\n\t\t\t<a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the\n\t\t\t\t<code>--name</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker\n\t\t\trun</a>. </p>"
}
},
"image": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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 <code>\n\t\t\t\t <i>repository-url</i>/<i>image</i>:<i>tag</i>\n\t\t\t </code> or <code>\n\t\t\t\t <i>repository-url</i>/<i>image</i>@<i>digest</i>\n\t\t\t </code>. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to <code>Image</code> in the\n\t\t\t<a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the\n\t\t\t\t<code>IMAGE</code> parameter of <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker\n\t\t\t\trun</a>.</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>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.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>Images in Amazon ECR repositories can be specified by either using the full\n\t\t\t\t\t\t<code>registry/repository:tag</code> or\n\t\t\t\t\t\t<code>registry/repository@digest</code>. For example,\n\t\t\t\t\t\t<code>012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest</code>\n\t\t\t\t\tor\n\t\t\t\t\t\t<code>012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE</code>.\n\t\t\t\t</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>Images in official repositories on Docker Hub use a single name (for example,\n\t\t\t\t\t\t<code>ubuntu</code> or <code>mongo</code>).</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>Images in other repositories on Docker Hub are qualified with an organization\n\t\t\t\t\tname (for example, <code>amazon/amazon-ecs-agent</code>).</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>Images in other online repositories are qualified further by a domain name\n\t\t\t\t\t(for example, <code>quay.io/assemblyline/ubuntu</code>).</p>\n\t\t\t </li>\n </ul>"
}
},
"repositoryCredentials": {
"target": "com.amazonaws.ecs#RepositoryCredentials",
"traits": {
"smithy.api#documentation": "<p>The private repository authentication credentials to use.</p>"
}
},
"cpu": {
"target": "com.amazonaws.ecs#Integer",
"traits": {
"smithy.api#documentation": "<p>The number of <code>cpu</code> units reserved for the container. This parameter maps\n\t\t\tto <code>CpuShares</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the\n\t\t\t<a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--cpu-shares</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker run</a>.</p>\n\t\t <p>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 <code>cpu</code> value.</p>\n\t\t <note>\n\t\t\t <p>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 <a href=\"http://aws.amazon.com/ec2/instance-types/\">Amazon EC2 Instances</a> detail page\n\t\t\t\tby 1,024.</p>\n\t\t </note>\n\t\t <p>Linux 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.</p>\n\t\t <p>On 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 <a href=\"https://docs.docker.com/engine/reference/run/#cpu-share-constraint\">CPU share\n\t\t\t\tconstraint</a> 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:</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>\n\t\t\t\t\t <b>Agent versions less than or equal to 1.1.0:</b>\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.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n\t\t\t\t\t <b>Agent versions greater than or equal to 1.2.0:</b>\n\t\t\t\t\tNull, zero, and CPU values of 1 are passed to Docker as 2.</p>\n\t\t\t </li>\n </ul>\n\t\t <p>On 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\t<code>0</code>, which Windows interprets as 1% of one CPU.</p>"
}
},
"memory": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>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\t<code>memory</code> value, if one is specified. This parameter maps to\n\t\t\t\t<code>Memory</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the\n\t\t\t<a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--memory</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker run</a>.</p>\n\t\t <p>If using the Fargate launch type, this parameter is optional.</p>\n\t\t <p>If 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\t<code>memory</code> and <code>memoryReservation</code> value, <code>memory</code>\n\t\t\tmust be greater than <code>memoryReservation</code>. If you specify\n\t\t\t\t<code>memoryReservation</code>, 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 <code>memory</code> is used.</p>\n\t\t <p>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.</p>"
}
},
"memoryReservation": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>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 <code>memory</code> 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 <code>MemoryReservation</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of\n\t\t\tthe <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--memory-reservation</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker run</a>.</p>\n\t\t <p>If a task-level memory value is not specified, you must specify a non-zero integer for\n\t\t\tone or both of <code>memory</code> or <code>memoryReservation</code> in a container\n\t\t\tdefinition. If you specify both, <code>memory</code> must be greater than\n\t\t\t\t<code>memoryReservation</code>. If you specify <code>memoryReservation</code>, 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 <code>memory</code> is\n\t\t\tused.</p>\n\t\t <p>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\t<code>memoryReservation</code> of 128 MiB, and a <code>memory</code> 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.</p>\n\t\t <p>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. </p>"
}
},
"links": {
"target": "com.amazonaws.ecs#StringList",
"traits": {
"smithy.api#documentation": "<p>The <code>links</code> 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 <code>bridge</code>. The <code>name:internalName</code>\n\t\t\tconstruct is analogous to <code>name:alias</code> 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\t<a href=\"https://docs.docker.com/network/links/\">Legacy container links</a>\n\t\t\tin the Docker documentation. This parameter maps to <code>Links</code> in the\n\t\t\t<a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the\n\t\t\t\t<code>--link</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker\n\t\t\trun</a>.</p> \n <note>\n <p>This parameter is not supported for Windows containers.</p>\n </note> \n <important>\n\t\t\t <p>Containers 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.</p>\n\t\t </important>"
}
},
"portMappings": {
"target": "com.amazonaws.ecs#PortMappingList",
"traits": {
"smithy.api#documentation": "<p>The 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.</p>\n\t\t <p>For task definitions that use the <code>awsvpc</code> network mode, you should only\n\t\t\tspecify the <code>containerPort</code>. The <code>hostPort</code> can be left blank or\n\t\t\tit must be the same value as the <code>containerPort</code>.</p>\n\t\t <p>Port mappings on Windows use the <code>NetNAT</code> gateway address rather than\n\t\t\t\t<code>localhost</code>. 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. </p>\n\t\t <p>This parameter maps to <code>PortBindings</code> in the\n\t\t\t<a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the\n\t\t\t\t<code>--publish</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker\n\t\t\t\trun</a>. If the network mode of a task definition is set to <code>none</code>,\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\t<code>host</code>, then host ports must either be undefined or they must match the\n\t\t\tcontainer port in the port mapping.</p>\n\t\t <note>\n\t\t\t <p>After a task reaches the <code>RUNNING</code> status, manual and automatic host\n\t\t\t\tand container port assignments are visible in the <b>Network\n\t\t\t\t\tBindings</b> 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\t<code>networkBindings</code> section <a>DescribeTasks</a>\n\t\t\t\tresponses.</p>\n\t\t </note>"
}
},
"essential": {
"target": "com.amazonaws.ecs#BoxedBoolean",
"traits": {
"smithy.api#documentation": "<p>If the <code>essential</code> parameter of a container is marked as <code>true</code>,\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 <code>essential</code> parameter of a container is marked\n\t\t\tas <code>false</code>, 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.</p>\n\t\t <p>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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html\">Application\n\t\t\t\tArchitecture</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"entryPoint": {
"target": "com.amazonaws.ecs#StringList",
"traits": {
"smithy.api#documentation": "<important>\n\t\t\t <p>Early versions of the Amazon ECS container agent do not properly handle\n\t\t\t\t\t<code>entryPoint</code> parameters. If you have problems using\n\t\t\t\t\t<code>entryPoint</code>, update your container agent or enter your commands and\n\t\t\t\targuments as <code>command</code> array items instead.</p>\n\t\t </important>\n\t\t <p>The entry point that is passed to the container. This parameter maps to\n\t\t\t\t<code>Entrypoint</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the\n\t\t\t<a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--entrypoint</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker run</a>. For more information, see <a href=\"https://docs.docker.com/engine/reference/builder/#entrypoint\">https://docs.docker.com/engine/reference/builder/#entrypoint</a>.</p>"
}
},
"command": {
"target": "com.amazonaws.ecs#StringList",
"traits": {
"smithy.api#documentation": "<p>The command that is passed to the container. This parameter maps to <code>Cmd</code>\n\t\t\tin the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the\n\t\t\t\t<code>COMMAND</code> parameter to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker\n\t\t\t\trun</a>. For more information, see <a href=\"https://docs.docker.com/engine/reference/builder/#cmd\">https://docs.docker.com/engine/reference/builder/#cmd</a>. If there are multiple arguments, each\n\t\t\targument should be a separated string in the array.</p>"
}
},
"environment": {
"target": "com.amazonaws.ecs#EnvironmentVariables",
"traits": {
"smithy.api#documentation": "<p>The environment variables to pass to a container. This parameter maps to\n\t\t\t\t<code>Env</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the\n\t\t\t<a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--env</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker run</a>.</p>\n\t\t <important>\n\t\t\t <p>We do not recommend using plaintext environment variables for sensitive\n\t\t\t\tinformation, such as credential data.</p>\n\t\t </important>"
}
},
"environmentFiles": {
"target": "com.amazonaws.ecs#EnvironmentFiles",
"traits": {
"smithy.api#documentation": "<p>A list of files containing the environment variables to pass to a container. This\n\t\t\tparameter maps to the <code>--env-file</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker run</a>.</p>\n\t\t <p>You can specify up to ten environment files. The file must have a <code>.env</code>\n\t\t\tfile extension. Each line in an environment file should contain an environment variable\n\t\t\tin <code>VARIABLE=VALUE</code> format. Lines beginning with <code>#</code> are treated\n\t\t\tas comments and are ignored. For more information on the environment variable file\n\t\t\tsyntax, see <a href=\"https://docs.docker.com/compose/env-file/\">Declare default\n\t\t\t\tenvironment variables in file</a>.</p>\n\t\t <p>If there are environment variables specified using the <code>environment</code>\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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html\">Specifying Environment\n\t\t\t\tVariables</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"mountPoints": {
"target": "com.amazonaws.ecs#MountPointList",
"traits": {
"smithy.api#documentation": "<p>The mount points for data volumes in your container.</p>\n\t\t <p>This parameter maps to <code>Volumes</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a>\n\t\t\tsection of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--volume</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker run</a>.</p>\n\t\t <p>Windows containers can mount whole directories on the same drive as\n\t\t\t\t<code>$env:ProgramData</code>. Windows containers cannot mount directories on a\n\t\t\tdifferent drive, and mount point cannot be across drives.</p>"
}
},
"volumesFrom": {
"target": "com.amazonaws.ecs#VolumeFromList",
"traits": {
"smithy.api#documentation": "<p>Data volumes to mount from another container. This parameter maps to\n\t\t\t\t<code>VolumesFrom</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the\n\t\t\t<a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--volumes-from</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker run</a>.</p>"
}
},
"linuxParameters": {
"target": "com.amazonaws.ecs#LinuxParameters",
"traits": {
"smithy.api#documentation": "<p>Linux-specific modifications that are applied to the container, such as Linux kernel\n\t\t\tcapabilities. For more information see <a>KernelCapabilities</a>.</p>\n\t\t <note>\n\t\t\t <p>This parameter is not supported for Windows containers.</p>\n\t\t </note>"
}
},
"secrets": {
"target": "com.amazonaws.ecs#SecretList",
"traits": {
"smithy.api#documentation": "<p>The secrets to pass to the container. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html\">Specifying\n\t\t\t\tSensitive Data</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"dependsOn": {
"target": "com.amazonaws.ecs#ContainerDependencies",
"traits": {
"smithy.api#documentation": "<p>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.</p>\n\t\t <p>For 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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html\">Updating the Amazon ECS\n\t\t\t\tContainer Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. 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\t<code>ecs-init</code> package. If your container instances are launched from version\n\t\t\t\t<code>20190301</code> or later, then they contain the required versions of the\n\t\t\tcontainer agent and <code>ecs-init</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html\">Amazon ECS-optimized Linux AMI</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t <p>For tasks using the Fargate launch type, the task or service requires\n\t\t\tplatform version <code>1.3.0</code> or later.</p>"
}
},
"startTimeout": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>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 <code>COMPLETE</code>,\n\t\t\t<code>SUCCESS</code>, or <code>HEALTHY</code> status. If a <code>startTimeout</code>\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 <code>STOPPED</code> state.</p>\n\t\t <note>\n\t\t\t <p>When the <code>ECS_CONTAINER_START_TIMEOUT</code> container agent configuration\n\t\t\t\tvariable is used, it is enforced indendently from this start timeout value.</p>\n\t\t </note>\n\t\t <p>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.</p>\n\t\t <p>For tasks using the EC2 launch type, your container instances require at\n\t\t\tleast version <code>1.26.0</code> 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\t<a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html\">Updating the Amazon ECS\n\t\t\t\tContainer Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. If you are\n\t\t\tusing an Amazon ECS-optimized Linux AMI, your instance needs at least version <code>1.26.0-1</code> of\n\t\t\tthe <code>ecs-init</code> package. If your container instances are launched from version\n\t\t\t\t<code>20190301</code> or later, then they contain the required versions of the\n\t\t\tcontainer agent and <code>ecs-init</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html\">Amazon ECS-optimized Linux AMI</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"stopTimeout": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>Time duration (in seconds) to wait before the container is forcefully killed if it\n\t\t\tdoesn't exit normally on its own.</p>\n\t\t <p>For 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.</p>\n\t\t <p>For tasks using the EC2 launch type, if the <code>stopTimeout</code>\n\t\t\tparameter is not specified, the value set for the Amazon ECS container agent configuration\n\t\t\tvariable <code>ECS_CONTAINER_STOP_TIMEOUT</code> is used by default. If neither the\n\t\t\t\t<code>stopTimeout</code> parameter or the <code>ECS_CONTAINER_STOP_TIMEOUT</code>\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\t<a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html\">Updating the Amazon ECS\n\t\t\t\tContainer Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. 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\t<code>ecs-init</code> package. If your container instances are launched from version\n\t\t\t\t<code>20190301</code> or later, then they contain the required versions of the\n\t\t\tcontainer agent and <code>ecs-init</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html\">Amazon ECS-optimized Linux AMI</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"hostname": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The hostname to use for your container. This parameter maps to <code>Hostname</code>\n\t\t\tin the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the\n\t\t\t\t<code>--hostname</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker\n\t\t\t\trun</a>.</p>\n\t\t <note>\n\t\t\t <p>The <code>hostname</code> parameter is not supported if you are using the\n\t\t\t\t\t<code>awsvpc</code> network mode.</p>\n\t\t </note>"
}
},
"user": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The user to use inside the container. This parameter maps to <code>User</code> in the\n\t\t\t<a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the\n\t\t\t\t<code>--user</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker\n\t\t\trun</a>.</p>\n\t\t <important>\n\t\t\t <p>When running tasks using the <code>host</code> 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.</p>\n\t\t </important>\n\t\t <p>You can specify the <code>user</code> using the following formats. If specifying a UID\n\t\t\tor GID, you must specify it as a positive integer.</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>\n <code>user</code>\n </p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <code>user:group</code>\n </p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <code>uid</code>\n </p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <code>uid:gid</code>\n </p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <code>user:gid</code>\n </p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <code>uid:group</code>\n </p>\n\t\t\t </li>\n </ul> \n <note>\n <p>This parameter is not supported for Windows containers.</p>\n </note>"
}
},
"workingDirectory": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The working directory in which to run commands inside the container. This parameter\n\t\t\tmaps to <code>WorkingDir</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the\n\t\t\t<a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--workdir</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker run</a>.</p>"
}
},
"disableNetworking": {
"target": "com.amazonaws.ecs#BoxedBoolean",
"traits": {
"smithy.api#documentation": "<p>When this parameter is true, networking is disabled within the container. This\n\t\t\tparameter maps to <code>NetworkDisabled</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a>\n\t\t\tsection of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a>.</p> \n <note>\n <p>This parameter is not supported for Windows containers.</p>\n </note>"
}
},
"privileged": {
"target": "com.amazonaws.ecs#BoxedBoolean",
"traits": {
"smithy.api#documentation": "<p>When this parameter is true, the container is given elevated privileges on the host\n\t\t\tcontainer instance (similar to the <code>root</code> user). This parameter maps to\n\t\t\t\t<code>Privileged</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the\n\t\t\t<a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--privileged</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker run</a>.</p> \n <note>\n <p>This parameter is not supported for Windows containers or tasks run on AWS Fargate.</p>\n </note>"
}
},
"readonlyRootFilesystem": {
"target": "com.amazonaws.ecs#BoxedBoolean",
"traits": {
"smithy.api#documentation": "<p>When this parameter is true, the container is given read-only access to its root file\n\t\t\tsystem. This parameter maps to <code>ReadonlyRootfs</code> in the\n\t\t\t<a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the\n\t\t\t\t<code>--read-only</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker\n\t\t\t\trun</a>.</p> \n <note>\n <p>This parameter is not supported for Windows containers.</p>\n </note>"
}
},
"dnsServers": {
"target": "com.amazonaws.ecs#StringList",
"traits": {
"smithy.api#documentation": "<p>A list of DNS servers that are presented to the container. This parameter maps to\n\t\t\t\t<code>Dns</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the\n\t\t\t<a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--dns</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker run</a>.</p> \n <note>\n <p>This parameter is not supported for Windows containers.</p>\n </note>"
}
},
"dnsSearchDomains": {
"target": "com.amazonaws.ecs#StringList",
"traits": {
"smithy.api#documentation": "<p>A list of DNS search domains that are presented to the container. This parameter maps\n\t\t\tto <code>DnsSearch</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the\n\t\t\t<a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--dns-search</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker run</a>.</p> \n <note>\n <p>This parameter is not supported for Windows containers.</p>\n </note>"
}
},
"extraHosts": {
"target": "com.amazonaws.ecs#HostEntryList",
"traits": {
"smithy.api#documentation": "<p>A list of hostnames and IP address mappings to append to the <code>/etc/hosts</code>\n\t\t\tfile on the container. This parameter maps to <code>ExtraHosts</code> in the\n\t\t\t<a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the\n\t\t\t\t<code>--add-host</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker\n\t\t\t\trun</a>.</p>\n\t\t <note>\n\t\t\t <p>This parameter is not supported for Windows containers or tasks that use the\n\t\t\t\t\t<code>awsvpc</code> network mode.</p>\n\t\t </note>"
}
},
"dockerSecurityOptions": {
"target": "com.amazonaws.ecs#StringList",
"traits": {
"smithy.api#documentation": "<p>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.</p>\n\t\t <p>With 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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html\">Using gMSAs for Windows\n\t\t\t\tContainers</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t <p>This parameter maps to <code>SecurityOpt</code> in the\n\t\t\t<a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the\n\t\t\t\t<code>--security-opt</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker\n\t\t\t\trun</a>.</p>\n\t\t <note>\n\t\t\t <p>The Amazon ECS container agent running on a container instance must register with the\n\t\t\t\t\t<code>ECS_SELINUX_CAPABLE=true</code> or <code>ECS_APPARMOR_CAPABLE=true</code>\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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html\">Amazon ECS Container\n\t\t\t\t\tAgent Configuration</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t </note>\n\t\t <p>For more information about valid values, see <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">Docker\n\t\t\t\tRun Security Configuration</a>. </p>\n\t\t <p>Valid values: \"no-new-privileges\" | \"apparmor:PROFILE\" | \"label:value\" |\n\t\t\t\"credentialspec:CredentialSpecFilePath\"</p>"
}
},
"interactive": {
"target": "com.amazonaws.ecs#BoxedBoolean",
"traits": {
"smithy.api#documentation": "<p>When this parameter is <code>true</code>, this allows you to deploy containerized\n\t\t\tapplications that require <code>stdin</code> or a <code>tty</code> to be allocated. This\n\t\t\tparameter maps to <code>OpenStdin</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a>\n\t\t\tsection of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--interactive</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker run</a>.</p>"
}
},
"pseudoTerminal": {
"target": "com.amazonaws.ecs#BoxedBoolean",
"traits": {
"smithy.api#documentation": "<p>When this parameter is <code>true</code>, a TTY is allocated. This parameter maps to\n\t\t\t\t<code>Tty</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the\n\t\t\t<a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--tty</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker run</a>.</p>"
}
},
"dockerLabels": {
"target": "com.amazonaws.ecs#DockerLabelsMap",
"traits": {
"smithy.api#documentation": "<p>A key/value map of labels to add to the container. This parameter maps to\n\t\t\t\t<code>Labels</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the\n\t\t\t<a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--label</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker run</a>. 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: <code>sudo docker version --format '{{.Server.APIVersion}}'</code> \n </p>"
}
},
"ulimits": {
"target": "com.amazonaws.ecs#UlimitList",
"traits": {
"smithy.api#documentation": "<p>A list of <code>ulimits</code> 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 <code>Ulimits</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the\n\t\t\t<a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--ulimit</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker run</a>. Valid naming values are displayed\n\t\t\tin the <a>Ulimit</a> data type.</p>\n\t\t <p>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 <code>nofile</code> resource limit parameter which Fargate\n\t\t\t\t\t\t\toverrides. The <code>nofile</code> 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\t<code>nofile</code> soft limit is <code>1024</code> and hard limit\n\t\t\t\t\t\t\tis <code>4096</code>.</p>\n\t\t <p>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: <code>sudo docker version --format '{{.Server.APIVersion}}'</code>\n </p> \n <note>\n <p>This parameter is not supported for Windows containers.</p>\n </note>"
}
},
"logConfiguration": {
"target": "com.amazonaws.ecs#LogConfiguration",
"traits": {
"smithy.api#documentation": "<p>The log configuration specification for the container.</p>\n\t\t <p>This parameter maps to <code>LogConfig</code> in the\n\t\t\t<a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the\n\t\t\t\t<code>--log-driver</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker\n\t\t\t\trun</a>. 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\t<a href=\"https://docs.docker.com/engine/admin/logging/overview/\">Configure\n\t\t\t\tlogging drivers</a> in the Docker documentation.</p>\n\t\t <note>\n\t\t\t <p>Amazon ECS currently supports a subset of the logging drivers available to the Docker\n\t\t\t\tdaemon (shown in the <a>LogConfiguration</a> data type). Additional log\n\t\t\t\tdrivers may be available in future releases of the Amazon ECS container agent.</p>\n\t\t </note>\n\t\t <p>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: <code>sudo docker version --format '{{.Server.APIVersion}}'</code> \n </p>\n\t\t <note>\n\t\t\t <p>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\t<code>ECS_AVAILABLE_LOGGING_DRIVERS</code> 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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html\">Amazon ECS Container\n\t\t\t\t\tAgent Configuration</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t </note>"
}
},
"healthCheck": {
"target": "com.amazonaws.ecs#HealthCheck",
"traits": {
"smithy.api#documentation": "<p>The container health check command and associated configuration parameters for the\n\t\t\tcontainer. This parameter maps to <code>HealthCheck</code> in the\n\t\t\t<a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the\n\t\t\t\t<code>HEALTHCHECK</code> parameter of <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker\n\t\t\t\trun</a>.</p>"
}
},
"systemControls": {
"target": "com.amazonaws.ecs#SystemControls",
"traits": {
"smithy.api#documentation": "<p>A list of namespaced kernel parameters to set in the container. This parameter maps to\n\t\t\t\t<code>Sysctls</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the\n\t\t\t<a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--sysctl</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker run</a>.</p>\n\t\t <note>\n\t\t\t <p>It is not recommended that you specify network-related <code>systemControls</code>\n\t\t\t\tparameters for multiple containers in a single task that also uses either the\n\t\t\t\t\t<code>awsvpc</code> or <code>host</code> network modes. For tasks that use the\n\t\t\t\t\t<code>awsvpc</code> network mode, the container that is started last determines\n\t\t\t\twhich <code>systemControls</code> parameters take effect. For tasks that use the\n\t\t\t\t\t<code>host</code> network mode, it changes the container instance's namespaced\n\t\t\t\tkernel parameters as well as the containers.</p>\n\t\t </note>"
}
},
"resourceRequirements": {
"target": "com.amazonaws.ecs#ResourceRequirements",
"traits": {
"smithy.api#documentation": "<p>The type and amount of a resource to assign to a container. The only supported\n\t\t\tresource is a GPU.</p>"
}
},
"firelensConfiguration": {
"target": "com.amazonaws.ecs#FirelensConfiguration",
"traits": {
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html\">Custom Log Routing</a>\n\t\t\tin the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Container definitions are used in task definitions to describe the different\n\t\t\tcontainers that are launched as part of a task.</p>"
}
},
"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": "<p>The name of a container.</p>",
"smithy.api#required": {}
}
},
"condition": {
"target": "com.amazonaws.ecs#ContainerCondition",
"traits": {
"smithy.api#documentation": "<p>The dependency condition of the container. The following are the available conditions\n\t\t\tand their behavior:</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>\n <code>START</code> - 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.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <code>COMPLETE</code> - 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.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <code>SUCCESS</code> - This condition is the same as\n\t\t\t\t\t\t<code>COMPLETE</code>, but it also requires that the container exits with a\n\t\t\t\t\t\t<code>zero</code> status. This condition cannot be set on an essential\n\t\t\t\t\tcontainer.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <code>HEALTHY</code> - 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.</p>\n\t\t\t </li>\n </ul>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>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.</p>\n\t\t <p>Your 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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html\">Updating the Amazon ECS\n\t\t\t\tContainer Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. 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\t<code>ecs-init</code> package. If your container instances are launched from version\n\t\t\t\t<code>20190301</code> or later, then they contain the required versions of the\n\t\t\tcontainer agent and <code>ecs-init</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html\">Amazon ECS-optimized Linux AMI</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t <note>\n\t\t\t <p>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.</p>\n\t\t </note>"
}
},
"com.amazonaws.ecs#ContainerInstance": {
"type": "structure",
"members": {
"containerInstanceArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the container instance. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the <code>container-instance</code> namespace, and then the container instance ID. For example, <code>arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID</code>.</p>"
}
},
"ec2InstanceId": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The EC2 instance ID of the container instance.</p>"
}
},
"capacityProviderName": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The capacity provider associated with the container instance.</p>"
}
},
"version": {
"target": "com.amazonaws.ecs#Long",
"traits": {
"smithy.api#documentation": "<p>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\t<code>detail</code> object) to verify that the version in your event stream is\n\t\t\tcurrent.</p>"
}
},
"versionInfo": {
"target": "com.amazonaws.ecs#VersionInfo",
"traits": {
"smithy.api#documentation": "<p>The version information for the Amazon ECS container agent and Docker daemon running on the\n\t\t\tcontainer instance.</p>"
}
},
"remainingResources": {
"target": "com.amazonaws.ecs#Resources",
"traits": {
"smithy.api#documentation": "<p>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 <code>host</code> or\n\t\t\t\t<code>bridge</code> network mode). Any port that is not specified here is available\n\t\t\tfor new tasks.</p>"
}
},
"registeredResources": {
"target": "com.amazonaws.ecs#Resources",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"status": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The status of the container instance. The valid values are <code>REGISTERING</code>,\n\t\t\t\t<code>REGISTRATION_FAILED</code>, <code>ACTIVE</code>, <code>INACTIVE</code>,\n\t\t\t\t<code>DEREGISTERING</code>, or <code>DRAINING</code>.</p>\n\t\t <p>If your account has opted in to the <code>awsvpcTrunking</code> account setting, then\n\t\t\tany newly registered container instance will transition to a <code>REGISTERING</code>\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 <code>REGISTRATION_FAILED</code>\n\t\t\tstatus. You can describe the container instance and see the reason for failure in the\n\t\t\t\t<code>statusReason</code> parameter. Once the container instance is terminated, the\n\t\t\tinstance transitions to a <code>DEREGISTERING</code> status while the trunk elastic\n\t\t\tnetwork interface is deprovisioned. The instance then transitions to an\n\t\t\t\t<code>INACTIVE</code> status.</p>\n\t\t <p>The <code>ACTIVE</code> status indicates that the container instance can accept tasks.\n\t\t\tThe <code>DRAINING</code> 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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-draining.html\">Container Instance Draining</a> in the\n\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"statusReason": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The reason that the container instance reached its current status.</p>"
}
},
"agentConnected": {
"target": "com.amazonaws.ecs#Boolean",
"traits": {
"smithy.api#documentation": "<p>This parameter returns <code>true</code> 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\t<code>false</code>. Only instances connected to an agent can accept placement\n\t\t\trequests.</p>"
}
},
"runningTasksCount": {
"target": "com.amazonaws.ecs#Integer",
"traits": {
"smithy.api#documentation": "<p>The number of tasks on the container instance that are in the <code>RUNNING</code>\n\t\t\tstatus.</p>"
}
},
"pendingTasksCount": {
"target": "com.amazonaws.ecs#Integer",
"traits": {
"smithy.api#documentation": "<p>The number of tasks on the container instance that are in the <code>PENDING</code>\n\t\t\tstatus.</p>"
}
},
"agentUpdateStatus": {
"target": "com.amazonaws.ecs#AgentUpdateStatus",
"traits": {
"smithy.api#documentation": "<p>The status of the most recent agent update. If an update has never been requested,\n\t\t\tthis value is <code>NULL</code>.</p>"
}
},
"attributes": {
"target": "com.amazonaws.ecs#Attributes",
"traits": {
"smithy.api#documentation": "<p>The attributes set for the container instance, either by the Amazon ECS container agent at\n\t\t\tinstance registration or manually with the <a>PutAttributes</a>\n\t\t\toperation.</p>"
}
},
"registeredAt": {
"target": "com.amazonaws.ecs#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The Unix timestamp for when the container instance was registered.</p>"
}
},
"attachments": {
"target": "com.amazonaws.ecs#Attachments",
"traits": {
"smithy.api#documentation": "<p>The resources attached to a container instance, such as elastic network\n\t\t\tinterfaces.</p>"
}
},
"tags": {
"target": "com.amazonaws.ecs#Tags",
"traits": {
"smithy.api#documentation": "<p>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.</p> \n <p>The following basic restrictions apply to tags:</p>\n <ul>\n <li>\n <p>Maximum number of tags per resource - 50</p>\n </li>\n <li>\n <p>For each resource, each tag key must be unique, and each tag key can have only\n one value.</p>\n </li>\n <li>\n <p>Maximum key length - 128 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>Maximum value length - 256 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>If 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: + - = . _ : / @.</p>\n </li>\n <li>\n <p>Tag keys and values are case-sensitive.</p>\n </li>\n <li>\n <p>Do not use <code>aws:</code>, <code>AWS:</code>, 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.</p>\n </li>\n </ul>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An EC2 instance that is running the Amazon ECS agent and has been registered with a\n\t\t\tcluster.</p>"
}
},
"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": "<p>The name of the container that receives the override. This parameter is required if\n\t\t\tany override is specified.</p>"
}
},
"command": {
"target": "com.amazonaws.ecs#StringList",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"environment": {
"target": "com.amazonaws.ecs#EnvironmentVariables",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"environmentFiles": {
"target": "com.amazonaws.ecs#EnvironmentFiles",
"traits": {
"smithy.api#documentation": "<p>A list of files containing the environment variables to pass to a container, instead\n\t\t\tof the value from the container definition.</p>"
}
},
"cpu": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>The number of <code>cpu</code> units reserved for the container, instead of the\n\t\t\tdefault value from the task definition. You must also specify a container name.</p>"
}
},
"memory": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"memoryReservation": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"resourceRequirements": {
"target": "com.amazonaws.ecs#ResourceRequirements",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>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<code>{\"containerOverrides\": [ ] }</code>. If a non-empty container override is\n\t\t\tspecified, the <code>name</code> parameter must be included.</p>"
}
},
"com.amazonaws.ecs#ContainerOverrides": {
"type": "list",
"member": {
"target": "com.amazonaws.ecs#ContainerOverride"
}
},
"com.amazonaws.ecs#ContainerStateChange": {
"type": "structure",
"members": {
"containerName": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The name of the container.</p>"
}
},
"imageDigest": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The container image SHA 256 digest.</p>"
}
},
"runtimeId": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The ID of the Docker container.</p>"
}
},
"exitCode": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>The exit code for the container, if the state change is a result of the container\n\t\t\texiting.</p>"
}
},
"networkBindings": {
"target": "com.amazonaws.ecs#NetworkBindings",
"traits": {
"smithy.api#documentation": "<p>Any network bindings associated with the container.</p>"
}
},
"reason": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The reason for the state change.</p>"
}
},
"status": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The status of the container.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object representing a change in state for a container.</p>"
}
},
"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": "<p>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.</p>\n\t\t <p>Only capacity providers using an Auto Scaling group can be created. Amazon ECS tasks on\n\t\t\tAWS Fargate use the <code>FARGATE</code> and <code>FARGATE_SPOT</code> capacity providers\n\t\t\twhich are already created and available to all accounts in Regions supported by\n\t\t\tAWS Fargate.</p>"
}
},
"com.amazonaws.ecs#CreateCapacityProviderRequest": {
"type": "structure",
"members": {
"name": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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 \"<code>aws</code>\", \"<code>ecs</code>\", or \"<code>fargate</code>\".</p>",
"smithy.api#required": {}
}
},
"autoScalingGroupProvider": {
"target": "com.amazonaws.ecs#AutoScalingGroupProvider",
"traits": {
"smithy.api#documentation": "<p>The details of the Auto Scaling group for the capacity provider.</p>",
"smithy.api#required": {}
}
},
"tags": {
"target": "com.amazonaws.ecs#Tags",
"traits": {
"smithy.api#documentation": "<p>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.</p> \n <p>The following basic restrictions apply to tags:</p>\n <ul>\n <li>\n <p>Maximum number of tags per resource - 50</p>\n </li>\n <li>\n <p>For each resource, each tag key must be unique, and each tag key can have only\n one value.</p>\n </li>\n <li>\n <p>Maximum key length - 128 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>Maximum value length - 256 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>If 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: + - = . _ : / @.</p>\n </li>\n <li>\n <p>Tag keys and values are case-sensitive.</p>\n </li>\n <li>\n <p>Do not use <code>aws:</code>, <code>AWS:</code>, 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.</p>\n </li>\n </ul>"
}
}
}
},
"com.amazonaws.ecs#CreateCapacityProviderResponse": {
"type": "structure",
"members": {
"capacityProvider": {
"target": "com.amazonaws.ecs#CapacityProvider",
"traits": {
"smithy.api#documentation": "<p>The full description of the new capacity provider.</p>"
}
}
}
},
"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": "<p>Creates a new Amazon ECS cluster. By default, your account receives a <code>default</code>\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 <code>CreateCluster</code> action.</p>\n\t\t <note>\n\t\t\t <p>When you call the <a>CreateCluster</a> 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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html\">Using\n\t\t\t\t\tService-Linked Roles for Amazon ECS</a> in the\n\t\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t </note>"
}
},
"com.amazonaws.ecs#CreateClusterRequest": {
"type": "structure",
"members": {
"clusterName": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The name of your cluster. If you do not specify a name for your cluster, you create a\n\t\t\tcluster named <code>default</code>. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. </p>"
}
},
"tags": {
"target": "com.amazonaws.ecs#Tags",
"traits": {
"smithy.api#documentation": "<p>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.</p>\n\t\t <p>The following basic restrictions apply to tags:</p>\n <ul>\n <li>\n <p>Maximum number of tags per resource - 50</p>\n </li>\n <li>\n <p>For each resource, each tag key must be unique, and each tag key can have only\n one value.</p>\n </li>\n <li>\n <p>Maximum key length - 128 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>Maximum value length - 256 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>If 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: + - = . _ : / @.</p>\n </li>\n <li>\n <p>Tag keys and values are case-sensitive.</p>\n </li>\n <li>\n <p>Do not use <code>aws:</code>, <code>AWS:</code>, 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.</p>\n </li>\n </ul>"
}
},
"settings": {
"target": "com.amazonaws.ecs#ClusterSettings",
"traits": {
"smithy.api#documentation": "<p>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\t<code>containerInsights</code> value set with <a>PutAccountSetting</a> or\n\t\t\t\t<a>PutAccountSettingDefault</a>.</p>"
}
},
"configuration": {
"target": "com.amazonaws.ecs#ClusterConfiguration",
"traits": {
"smithy.api#documentation": "<p>The execute command configuration for the cluster.</p>"
}
},
"capacityProviders": {
"target": "com.amazonaws.ecs#StringList",
"traits": {
"smithy.api#documentation": "<p>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 <a>CreateService</a> or <a>RunTask</a>\n\t\t\tactions.</p>\n\t\t <p>If 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 <a>CreateCapacityProvider</a> API operation.</p>\n\t\t <p>To use a AWS Fargate capacity provider, specify either the <code>FARGATE</code> or\n\t\t\t\t<code>FARGATE_SPOT</code> 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.</p>\n\t\t <p>The <a>PutClusterCapacityProviders</a> API operation is used to update the\n\t\t\tlist of available capacity providers for a cluster after the cluster is created.</p>"
}
},
"defaultCapacityProviderStrategy": {
"target": "com.amazonaws.ecs#CapacityProviderStrategy",
"traits": {
"smithy.api#documentation": "<p>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 <a>RunTask</a> or <a>CreateService</a> 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.</p>\n\t\t <p>If a default capacity provider strategy is not defined for a cluster during creation,\n\t\t\tit can be defined later with the <a>PutClusterCapacityProviders</a> API\n\t\t\toperation.</p>"
}
}
}
},
"com.amazonaws.ecs#CreateClusterResponse": {
"type": "structure",
"members": {
"cluster": {
"target": "com.amazonaws.ecs#Cluster",
"traits": {
"smithy.api#documentation": "<p>The full description of your new cluster.</p>"
}
}
}
},
"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": "<p>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 <code>desiredCount</code>, 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.</p>\n\t\t <p>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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html\">Service Load Balancing</a> in the\n\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t <p>Tasks for services that <i>do not</i> use a load balancer are considered\n\t\t\thealthy if they're in the <code>RUNNING</code> state. Tasks for services that\n\t\t\t\t<i>do</i> use a load balancer are considered healthy if they're in the\n\t\t\t\t<code>RUNNING</code> state and the container instance that they're hosted on is\n\t\t\treported as healthy by the load balancer.</p>\n\t\t <p>There are two service scheduler strategies available:</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>\n <code>REPLICA</code> - 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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html\">Service Scheduler Concepts</a> in the\n\t\t\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <code>DAEMON</code> - 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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html\">Service Scheduler Concepts</a> in the\n\t\t\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t\t </li>\n </ul>\n\t\t <p>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 <a>UpdateService</a> operation. The default value for a\n\t\t\treplica service for <code>minimumHealthyPercent</code> is 100%. The default value for a\n\t\t\tdaemon service for <code>minimumHealthyPercent</code> is 0%.</p>\n\t\t <p>If a service is using the <code>ECS</code> 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 <code>RUNNING</code> 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 <code>DRAINING</code> 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
}
},
"com.amazonaws.ecs#CreateServiceRequest": {
"type": "structure",
"members": {
"cluster": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The 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.</p>"
}
},
"serviceName": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>",
"smithy.api#required": {}
}
},
"taskDefinition": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or\n\t\t\tfull ARN of the task definition to run in your service. If a <code>revision</code> is\n\t\t\tnot specified, the latest <code>ACTIVE</code> revision is used.</p>\n\t\t <p>A task definition must be specified if the service is using either the\n\t\t\t\t<code>ECS</code> or <code>CODE_DEPLOY</code> deployment controllers.</p>"
}
},
"loadBalancers": {
"target": "com.amazonaws.ecs#LoadBalancers",
"traits": {
"smithy.api#documentation": "<p>A load balancer object representing the load balancers to use with your service. For\n\t\t\tmore information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html\">Service Load Balancing</a> in the\n\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t <p>If the service is using the rolling update (<code>ECS</code>) 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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html\">Using service-linked roles for Amazon ECS</a> in the\n\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t <p>If the service is using the <code>CODE_DEPLOY</code> 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 <code>targetGroupPair</code>).\n\t\t\tDuring a deployment, AWS CodeDeploy determines which task set in your service has the status\n\t\t\t\t<code>PRIMARY</code> 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.</p>\n\t\t <p>After you create a service using the <code>ECS</code> 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>CODE_DEPLOY</code>\n\t\t\tdeployment controller, these values can be changed when updating the service.</p>\n\t\t <p>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.</p>\n\t\t <p>For 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.</p>\n\t\t <p>Services with tasks that use the <code>awsvpc</code> 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 <code>ip</code> as the target type, not <code>instance</code>, because tasks that\n\t\t\tuse the <code>awsvpc</code> network mode are associated with an elastic network\n\t\t\tinterface, not an Amazon EC2 instance.</p>"
}
},
"serviceRegistries": {
"target": "com.amazonaws.ecs#ServiceRegistries",
"traits": {
"smithy.api#documentation": "<p>The details of the service discovery registry to associate with this service. For more\n\t\t\tinformation, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html\">Service\n\t\t\t\tdiscovery</a>.</p>\n\t\t <note>\n\t\t\t <p>Each service may be associated with one service registry. Multiple service\n\t\t\t\tregistries per service isn't supported.</p>\n\t\t </note>"
}
},
"desiredCount": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>The number of instantiations of the specified task definition to place and keep\n\t\t\trunning on your cluster.</p>\n\t\t <p>This is required if <code>schedulingStrategy</code> is <code>REPLICA</code> or is not\n\t\t\tspecified. If <code>schedulingStrategy</code> is <code>DAEMON</code> then this is not\n\t\t\trequired.</p>"
}
},
"clientToken": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n\t\t\trequest. Up to 32 ASCII characters are allowed.</p>"
}
},
"launchType": {
"target": "com.amazonaws.ecs#LaunchType",
"traits": {
"smithy.api#documentation": "<p>The launch type on which to run your service. The accepted values are\n\t\t\t\t<code>FARGATE</code> and <code>EC2</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html\">Amazon ECS\n\t\t\t\tlaunch types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t <p>When a value of <code>FARGATE</code> 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 <code>FARGATE_SPOT</code> capacity provider.</p>\n\t\t <p>When a value of <code>EC2</code> is specified, your tasks are launched on Amazon EC2\n\t\t\tinstances registered to your cluster.</p>\n\t\t <p>If a <code>launchType</code> is specified, the <code>capacityProviderStrategy</code>\n\t\t\tparameter must be omitted.</p>"
}
},
"capacityProviderStrategy": {
"target": "com.amazonaws.ecs#CapacityProviderStrategy",
"traits": {
"smithy.api#documentation": "<p>The capacity provider strategy to use for the service.</p>\n\t\t <p>If a <code>capacityProviderStrategy</code> is specified, the <code>launchType</code>\n\t\t\tparameter must be omitted. If no <code>capacityProviderStrategy</code> or\n\t\t\t\t<code>launchType</code> is specified, the\n\t\t\t\t<code>defaultCapacityProviderStrategy</code> for the cluster is used.</p>"
}
},
"platformVersion": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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 <code>LATEST</code> platform version is used by default. For more\n\t\t\tinformation, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">AWS Fargate platform\n\t\t\t\tversions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"role": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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 <code>awsvpc</code>\n\t\t\tnetwork mode. If you specify the <code>role</code> parameter, you must also specify a\n\t\t\tload balancer object with the <code>loadBalancers</code> parameter.</p>\n\t\t <important>\n\t\t\t <p>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 <code>awsvpc</code> 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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html\">Using\n\t\t\t\t\tservice-linked roles for Amazon ECS</a> in the\n\t\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t </important>\n\t\t <p>If your specified role has a path other than <code>/</code>, 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 <code>bar</code> has a path of <code>/foo/</code>\n\t\t\tthen you would specify <code>/foo/bar</code> as the role name. For more information, see\n\t\t\t\t<a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names\">Friendly names and paths</a> in the <i>IAM User Guide</i>.</p>"
}
},
"deploymentConfiguration": {
"target": "com.amazonaws.ecs#DeploymentConfiguration",
"traits": {
"smithy.api#documentation": "<p>Optional deployment parameters that control how many tasks run during the deployment\n\t\t\tand the ordering of stopping and starting tasks.</p>"
}
},
"placementConstraints": {
"target": "com.amazonaws.ecs#PlacementConstraints",
"traits": {
"smithy.api#documentation": "<p>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). </p>"
}
},
"placementStrategy": {
"target": "com.amazonaws.ecs#PlacementStrategies",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"networkConfiguration": {
"target": "com.amazonaws.ecs#NetworkConfiguration",
"traits": {
"smithy.api#documentation": "<p>The network configuration for the service. This parameter is required for task\n\t\t\tdefinitions that use the <code>awsvpc</code> 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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html\">Task networking</a>\n\t\t\tin the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"healthCheckGracePeriodSeconds": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>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 <code>0</code> is used.</p>\n\t\t <p>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.</p>"
}
},
"schedulingStrategy": {
"target": "com.amazonaws.ecs#SchedulingStrategy",
"traits": {
"smithy.api#documentation": "<p>The scheduling strategy to use for the service. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html\">Services</a>.</p>\n\t\t <p>There are two service scheduler strategies available:</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>\n <code>REPLICA</code>-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\t<code>CODE_DEPLOY</code> or <code>EXTERNAL</code> deployment controller\n\t\t\t\t\ttypes.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <code>DAEMON</code>-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.</p>\n\t\t\t\t <note>\n\t\t\t\t\t <p>Tasks using the Fargate launch type or the\n\t\t\t\t\t\t\t<code>CODE_DEPLOY</code> or <code>EXTERNAL</code> deployment controller\n\t\t\t\t\t\ttypes don't support the <code>DAEMON</code> scheduling strategy.</p>\n\t\t\t\t </note>\n\t\t\t </li>\n </ul>"
}
},
"deploymentController": {
"target": "com.amazonaws.ecs#DeploymentController",
"traits": {
"smithy.api#documentation": "<p>The deployment controller to use for the service. If no deployment controller is\n\t\t\tspecified, the default value of <code>ECS</code> is used.</p>"
}
},
"tags": {
"target": "com.amazonaws.ecs#Tags",
"traits": {
"smithy.api#documentation": "<p>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.</p> \n <p>The following basic restrictions apply to tags:</p>\n <ul>\n <li>\n <p>Maximum number of tags per resource - 50</p>\n </li>\n <li>\n <p>For each resource, each tag key must be unique, and each tag key can have only\n one value.</p>\n </li>\n <li>\n <p>Maximum key length - 128 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>Maximum value length - 256 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>If 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: + - = . _ : / @.</p>\n </li>\n <li>\n <p>Tag keys and values are case-sensitive.</p>\n </li>\n <li>\n <p>Do not use <code>aws:</code>, <code>AWS:</code>, 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.</p>\n </li>\n </ul>"
}
},
"enableECSManagedTags": {
"target": "com.amazonaws.ecs#Boolean",
"traits": {
"smithy.api#documentation": "<p>Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For\n\t\t\tmore information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html\">Tagging Your Amazon ECS\n\t\t\t\tResources</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"propagateTags": {
"target": "com.amazonaws.ecs#PropagateTags",
"traits": {
"smithy.api#documentation": "<p>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 <a>TagResource</a> API\n\t\t\taction.</p>"
}
},
"enableExecuteCommand": {
"target": "com.amazonaws.ecs#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether or not the execute command functionality is enabled for the service. If\n\t\t\t\t<code>true</code>, this enables execute command functionality on all containers in\n\t\t\tthe service tasks.</p>"
}
}
}
},
"com.amazonaws.ecs#CreateServiceResponse": {
"type": "structure",
"members": {
"service": {
"target": "com.amazonaws.ecs#Service",
"traits": {
"smithy.api#documentation": "<p>The full description of your service following the create call.</p>\n\t\t <p>If a service is using the <code>ECS</code> deployment controller, the\n\t\t\t\t<code>deploymentController</code> and <code>taskSets</code> parameters will not be\n\t\t\treturned.</p>\n\t\t <p>If the service is using the <code>CODE_DEPLOY</code> deployment controller, the\n\t\t\t\t<code>deploymentController</code>, <code>taskSets</code> and\n\t\t\t\t<code>deployments</code> parameters will be returned, however the\n\t\t\t\t<code>deployments</code> parameter will be an empty list.</p>"
}
}
}
},
"com.amazonaws.ecs#CreateTaskSet": {
"type": "operation",
"input": {
"target": "com.amazonaws.ecs#CreateTaskSetRequest"
},
"output": {
"target": "com.amazonaws.ecs#CreateTaskSetResponse"
},
"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#ServiceNotActiveException"
},
{
"target": "com.amazonaws.ecs#ServiceNotFoundException"
},
{
"target": "com.amazonaws.ecs#UnsupportedFeatureException"
}
],
"traits": {
"smithy.api#documentation": "<p>Create a task set in the specified cluster and service. This is used when a service\n\t\t\tuses the <code>EXTERNAL</code> deployment controller type. For more information, see\n\t\t\t\t<a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html\">Amazon ECS Deployment\n\t\t\t\tTypes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"com.amazonaws.ecs#CreateTaskSetRequest": {
"type": "structure",
"members": {
"service": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The short name or full Amazon Resource Name (ARN) of the service to create the task set in.</p>",
"smithy.api#required": {}
}
},
"cluster": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>",
"smithy.api#required": {}
}
},
"externalId": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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 <code>ECS_TASK_SET_EXTERNAL_ID</code> AWS Cloud Map attribute set to the provided\n\t\t\tvalue.</p>"
}
},
"taskDefinition": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The task definition for the tasks in the task set to use.</p>",
"smithy.api#required": {}
}
},
"networkConfiguration": {
"target": "com.amazonaws.ecs#NetworkConfiguration",
"traits": {
"smithy.api#documentation": "<p>An object representing the network configuration for a task set.</p>"
}
},
"loadBalancers": {
"target": "com.amazonaws.ecs#LoadBalancers",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"serviceRegistries": {
"target": "com.amazonaws.ecs#ServiceRegistries",
"traits": {
"smithy.api#documentation": "<p>The details of the service discovery registries to assign to this task set. For more\n\t\t\tinformation, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html\">Service\n\t\t\t\tDiscovery</a>.</p>"
}
},
"launchType": {
"target": "com.amazonaws.ecs#LaunchType",
"traits": {
"smithy.api#documentation": "<p>The launch type that new tasks in the task set will use. For more information, see\n\t\t\t\t<a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html\">Amazon ECS Launch Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t <p>If a <code>launchType</code> is specified, the <code>capacityProviderStrategy</code>\n\t\t\tparameter must be omitted.</p>"
}
},
"capacityProviderStrategy": {
"target": "com.amazonaws.ecs#CapacityProviderStrategy",
"traits": {
"smithy.api#documentation": "<p>The capacity provider strategy to use for the task set.</p>\n\t\t <p>A capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\t<code>base</code> and <code>weight</code> 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\t<a>PutClusterCapacityProviders</a> API is used to associate a capacity\n\t\t\tprovider with a cluster. Only capacity providers with an <code>ACTIVE</code> or\n\t\t\t\t<code>UPDATING</code> status can be used.</p>\n\t\t <p>If a <code>capacityProviderStrategy</code> is specified, the <code>launchType</code>\n\t\t\tparameter must be omitted. If no <code>capacityProviderStrategy</code> or\n\t\t\t\t<code>launchType</code> is specified, the\n\t\t\t\t<code>defaultCapacityProviderStrategy</code> for the cluster is used.</p>\n\t\t <p>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 <a>CreateCapacityProvider</a> API operation.</p>\n\t\t <p>To use a AWS Fargate capacity provider, specify either the <code>FARGATE</code> or\n\t\t\t\t<code>FARGATE_SPOT</code> 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.</p>\n\t\t <p>The <a>PutClusterCapacityProviders</a> API operation is used to update the\n\t\t\tlist of available capacity providers for a cluster after the cluster is created.</p>"
}
},
"platformVersion": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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 <code>LATEST</code> platform version is used by default.</p>"
}
},
"scale": {
"target": "com.amazonaws.ecs#Scale",
"traits": {
"smithy.api#documentation": "<p>A floating-point percentage of the desired number of tasks to place and keep running\n\t\t\tin the task set.</p>"
}
},
"clientToken": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n\t\t\trequest. Up to 32 ASCII characters are allowed.</p>"
}
},
"tags": {
"target": "com.amazonaws.ecs#Tags",
"traits": {
"smithy.api#documentation": "<p>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.</p> \n <p>The following basic restrictions apply to tags:</p>\n <ul>\n <li>\n <p>Maximum number of tags per resource - 50</p>\n </li>\n <li>\n <p>For each resource, each tag key must be unique, and each tag key can have only\n one value.</p>\n </li>\n <li>\n <p>Maximum key length - 128 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>Maximum value length - 256 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>If 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: + - = . _ : / @.</p>\n </li>\n <li>\n <p>Tag keys and values are case-sensitive.</p>\n </li>\n <li>\n <p>Do not use <code>aws:</code>, <code>AWS:</code>, 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.</p>\n </li>\n </ul>"
}
}
}
},
"com.amazonaws.ecs#CreateTaskSetResponse": {
"type": "structure",
"members": {
"taskSet": {
"target": "com.amazonaws.ecs#TaskSet",
"traits": {
"smithy.api#documentation": "<p>Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an\n\t\t\t\t<code>EXTERNAL</code> 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.</p>"
}
}
}
},
"com.amazonaws.ecs#DeleteAccountSetting": {
"type": "operation",
"input": {
"target": "com.amazonaws.ecs#DeleteAccountSettingRequest"
},
"output": {
"target": "com.amazonaws.ecs#DeleteAccountSettingResponse"
},
"errors": [
{
"target": "com.amazonaws.ecs#ClientException"
},
{
"target": "com.amazonaws.ecs#InvalidParameterException"
},
{
"target": "com.amazonaws.ecs#ServerException"
}
],
"traits": {
"smithy.api#documentation": "<p>Disables an account setting for a specified IAM user, IAM role, or the root user for\n\t\t\tan account.</p>"
}
},
"com.amazonaws.ecs#DeleteAccountSettingRequest": {
"type": "structure",
"members": {
"name": {
"target": "com.amazonaws.ecs#SettingName",
"traits": {
"smithy.api#documentation": "<p>The resource name for which to disable the account setting. If\n\t\t\t\t<code>serviceLongArnFormat</code> is specified, the ARN for your Amazon ECS services is\n\t\t\taffected. If <code>taskLongArnFormat</code> is specified, the ARN and resource ID for\n\t\t\tyour Amazon ECS tasks is affected. If <code>containerInstanceLongArnFormat</code> is\n\t\t\tspecified, the ARN and resource ID for your Amazon ECS container instances is affected. If\n\t\t\t\t<code>awsvpcTrunking</code> is specified, the ENI limit for your Amazon ECS container\n\t\t\tinstances is affected.</p>",
"smithy.api#required": {}
}
},
"principalArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
}
}
},
"com.amazonaws.ecs#DeleteAccountSettingResponse": {
"type": "structure",
"members": {
"setting": {
"target": "com.amazonaws.ecs#Setting",
"traits": {
"smithy.api#documentation": "<p>The account setting for the specified principal ARN.</p>"
}
}
}
},
"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": "<p>Deletes one or more custom attributes from an Amazon ECS resource.</p>"
}
},
"com.amazonaws.ecs#DeleteAttributesRequest": {
"type": "structure",
"members": {
"cluster": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"attributes": {
"target": "com.amazonaws.ecs#Attributes",
"traits": {
"smithy.api#documentation": "<p>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.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.ecs#DeleteAttributesResponse": {
"type": "structure",
"members": {
"attributes": {
"target": "com.amazonaws.ecs#Attributes",
"traits": {
"smithy.api#documentation": "<p>A list of attribute objects that were successfully deleted from your resource.</p>"
}
}
}
},
"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": "<p>Deletes the specified capacity provider.</p>\n\t\t <note>\n\t\t\t <p>The <code>FARGATE</code> and <code>FARGATE_SPOT</code> 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 <a>PutClusterCapacityProviders</a> API or by deleting the\n\t\t\t\tcluster.</p>\n\t\t </note>\n\t\t <p>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 <a>UpdateService</a>\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 <code>forceNewDeployment</code> 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 <a>PutClusterCapacityProviders</a> or delete the cluster.</p>"
}
},
"com.amazonaws.ecs#DeleteCapacityProviderRequest": {
"type": "structure",
"members": {
"capacityProvider": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The short name or full Amazon Resource Name (ARN) of the capacity provider to delete.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.ecs#DeleteCapacityProviderResponse": {
"type": "structure",
"members": {
"capacityProvider": {
"target": "com.amazonaws.ecs#CapacityProvider",
"traits": {
"smithy.api#documentation": "<p>The details of the capacity provider.</p>"
}
}
}
},
"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": "<p>Deletes the specified cluster. The cluster will transition to the\n\t\t\t\t<code>INACTIVE</code> state. Clusters with an <code>INACTIVE</code> 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 <code>INACTIVE</code>\n\t\t\tclusters persisting.</p>\n\t\t <p>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 <a>ListContainerInstances</a> and deregister them with <a>DeregisterContainerInstance</a>.</p>"
}
},
"com.amazonaws.ecs#DeleteClusterRequest": {
"type": "structure",
"members": {
"cluster": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The short name or full Amazon Resource Name (ARN) of the cluster to delete.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.ecs#DeleteClusterResponse": {
"type": "structure",
"members": {
"cluster": {
"target": "com.amazonaws.ecs#Cluster",
"traits": {
"smithy.api#documentation": "<p>The full description of the deleted cluster.</p>"
}
}
}
},
"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": "<p>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 <a>UpdateService</a>.</p>\n\t\t <note>\n\t\t\t <p>When you delete a service, if there are still running tasks that require cleanup,\n\t\t\t\tthe service status moves from <code>ACTIVE</code> to <code>DRAINING</code>, and the\n\t\t\t\tservice is no longer visible in the console or in the <a>ListServices</a>\n\t\t\t\tAPI operation. After all tasks have transitioned to either <code>STOPPING</code> or\n\t\t\t\t\t<code>STOPPED</code> status, the service status moves from <code>DRAINING</code>\n\t\t\t\tto <code>INACTIVE</code>. Services in the <code>DRAINING</code> or\n\t\t\t\t\t<code>INACTIVE</code> status can still be viewed with the <a>DescribeServices</a> API operation. However, in the future,\n\t\t\t\t\t<code>INACTIVE</code> services may be cleaned up and purged from Amazon ECS record\n\t\t\t\tkeeping, and <a>DescribeServices</a> calls on those services return a\n\t\t\t\t\t<code>ServiceNotFoundException</code> error.</p>\n\t\t </note>\n\t\t <important>\n\t\t\t <p>If you attempt to create a new service with the same name as an existing service\n\t\t\t\tin either <code>ACTIVE</code> or <code>DRAINING</code> status, you receive an\n\t\t\t\terror.</p>\n\t\t </important>"
}
},
"com.amazonaws.ecs#DeleteServiceRequest": {
"type": "structure",
"members": {
"cluster": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"service": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The name of the service to delete.</p>",
"smithy.api#required": {}
}
},
"force": {
"target": "com.amazonaws.ecs#BoxedBoolean",
"traits": {
"smithy.api#documentation": "<p>If <code>true</code>, 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\t<code>REPLICA</code> scheduling strategy.</p>"
}
}
}
},
"com.amazonaws.ecs#DeleteServiceResponse": {
"type": "structure",
"members": {
"service": {
"target": "com.amazonaws.ecs#Service",
"traits": {
"smithy.api#documentation": "<p>The full description of the deleted service.</p>"
}
}
}
},
"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": "<p>Deletes a specified task set within a service. This is used when a service uses the\n\t\t\t\t<code>EXTERNAL</code> deployment controller type. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html\">Amazon ECS Deployment Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"com.amazonaws.ecs#DeleteTaskSetRequest": {
"type": "structure",
"members": {
"cluster": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>",
"smithy.api#required": {}
}
},
"service": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The short name or full Amazon Resource Name (ARN) of the service that hosts the task set to\n\t\t\tdelete.</p>",
"smithy.api#required": {}
}
},
"taskSet": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The task set ID or full Amazon Resource Name (ARN) of the task set to delete.</p>",
"smithy.api#required": {}
}
},
"force": {
"target": "com.amazonaws.ecs#BoxedBoolean",
"traits": {
"smithy.api#documentation": "<p>If <code>true</code>, this allows you to delete a task set even if it hasn't been\n\t\t\tscaled down to zero.</p>"
}
}
}
},
"com.amazonaws.ecs#DeleteTaskSetResponse": {
"type": "structure",
"members": {
"taskSet": {
"target": "com.amazonaws.ecs#TaskSet",
"traits": {
"smithy.api#documentation": "<p>Details about the task set.</p>"
}
}
}
},
"com.amazonaws.ecs#Deployment": {
"type": "structure",
"members": {
"id": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The ID of the deployment.</p>"
}
},
"status": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The status of the deployment. The following describes each state:</p>\n\t\t <dl>\n <dt>PRIMARY</dt>\n <dd>\n\t\t\t\t\t <p>The most recent deployment of a service.</p>\n\t\t\t\t </dd>\n <dt>ACTIVE</dt>\n <dd>\n\t\t\t\t\t <p>A service deployment that still has running tasks, but are in the process\n\t\t\t\t\t\tof being replaced with a new <code>PRIMARY</code> deployment.</p>\n\t\t\t\t </dd>\n <dt>INACTIVE</dt>\n <dd>\n\t\t\t\t\t <p>A deployment that has been completely replaced.</p>\n\t\t\t\t </dd>\n </dl>"
}
},
"taskDefinition": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The most recent task definition that was specified for the tasks in the service to\n\t\t\tuse.</p>"
}
},
"desiredCount": {
"target": "com.amazonaws.ecs#Integer",
"traits": {
"smithy.api#documentation": "<p>The most recent desired count of tasks that was specified for the service to deploy or\n\t\t\tmaintain.</p>"
}
},
"pendingCount": {
"target": "com.amazonaws.ecs#Integer",
"traits": {
"smithy.api#documentation": "<p>The number of tasks in the deployment that are in the <code>PENDING</code>\n\t\t\tstatus.</p>"
}
},
"runningCount": {
"target": "com.amazonaws.ecs#Integer",
"traits": {
"smithy.api#documentation": "<p>The number of tasks in the deployment that are in the <code>RUNNING</code>\n\t\t\tstatus.</p>"
}
},
"failedTasks": {
"target": "com.amazonaws.ecs#Integer",
"traits": {
"smithy.api#documentation": "<p>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\t<code>RUNNING</code> state, or if it fails any of its defined health checks and is\n\t\t\tstopped.</p>\n\t\t <note>\n\t\t\t <p>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.</p>\n\t\t </note>"
}
},
"createdAt": {
"target": "com.amazonaws.ecs#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The Unix timestamp for when the service deployment was created.</p>"
}
},
"updatedAt": {
"target": "com.amazonaws.ecs#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The Unix timestamp for when the service deployment was last updated.</p>"
}
},
"capacityProviderStrategy": {
"target": "com.amazonaws.ecs#CapacityProviderStrategy",
"traits": {
"smithy.api#documentation": "<p>The capacity provider strategy that the deployment is using.</p>"
}
},
"launchType": {
"target": "com.amazonaws.ecs#LaunchType",
"traits": {
"smithy.api#documentation": "<p>The launch type the tasks in the service are using. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html\">Amazon ECS\n\t\t\t\tLaunch Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"platformVersion": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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 <code>LATEST</code> platform version is used by default. For more\n\t\t\tinformation, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">AWS Fargate Platform\n\t\t\t\tVersions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"networkConfiguration": {
"target": "com.amazonaws.ecs#NetworkConfiguration",
"traits": {
"smithy.api#documentation": "<p>The VPC subnet and security group configuration for tasks that receive their own\n elastic network interface by using the <code>awsvpc</code> networking mode.</p>"
}
},
"rolloutState": {
"target": "com.amazonaws.ecs#DeploymentRolloutState",
"traits": {
"smithy.api#documentation": "<note>\n\t\t\t <p>The <code>rolloutState</code> of a service is only returned for services that use\n\t\t\t\tthe rolling update (<code>ECS</code>) deployment type that are not behind a\n\t\t\t\tClassic Load Balancer.</p>\n\t\t </note>\n\t\t <p>The rollout state of the deployment. When a service deployment is started, it begins\n\t\t\tin an <code>IN_PROGRESS</code> state. When the service reaches a steady state, the\n\t\t\tdeployment will transition to a <code>COMPLETED</code> 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\t<code>FAILED</code> state. A deployment in <code>FAILED</code> state will launch no\n\t\t\tnew tasks. For more information, see <a>DeploymentCircuitBreaker</a>.</p>"
}
},
"rolloutStateReason": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>A description of the rollout state of a deployment.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The details of an Amazon ECS service deployment. This is used only when a service uses the\n\t\t\t\t<code>ECS</code> deployment controller type.</p>"
}
},
"com.amazonaws.ecs#DeploymentCircuitBreaker": {
"type": "structure",
"members": {
"enable": {
"target": "com.amazonaws.ecs#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether to enable the deployment circuit breaker logic for the service.</p>",
"smithy.api#required": {}
}
},
"rollback": {
"target": "com.amazonaws.ecs#Boolean",
"traits": {
"smithy.api#documentation": "<p>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.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<note>\n\t\t\t <p>The deployment circuit breaker can only be used for services using the rolling\n\t\t\t\tupdate (<code>ECS</code>) deployment type that are not behind a Classic Load Balancer.</p>\n\t\t </note>\n\t\t <p>The <b>deployment circuit breaker</b> 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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html\">Rolling\n\t\t\t\tupdate</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"com.amazonaws.ecs#DeploymentConfiguration": {
"type": "structure",
"members": {
"deploymentCircuitBreaker": {
"target": "com.amazonaws.ecs#DeploymentCircuitBreaker",
"traits": {
"smithy.api#documentation": "<note>\n\t\t\t <p>The deployment circuit breaker can only be used for services using the rolling\n\t\t\t\tupdate (<code>ECS</code>) deployment type.</p>\n\t\t </note>\n\t\t <p>The <b>deployment circuit breaker</b> 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.</p>"
}
},
"maximumPercent": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>If a service is using the rolling update (<code>ECS</code>) deployment type, the\n\t\t\t\t<b>maximum percent</b> parameter represents an upper limit\n\t\t\ton the number of tasks in a service that are allowed in the <code>RUNNING</code> or\n\t\t\t\t<code>PENDING</code> 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 <code>DRAINING</code> 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%.</p>\n\t\t <p>If a service is using the blue/green (<code>CODE_DEPLOY</code>) or\n\t\t\t\t<code>EXTERNAL</code> deployment types and tasks that use the EC2\n\t\t\tlaunch type, the <b>maximum percent</b> 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 <code>RUNNING</code> state while the container instances are\n\t\t\tin the <code>DRAINING</code> 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.</p>"
}
},
"minimumHealthyPercent": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>If a service is using the rolling update (<code>ECS</code>) deployment type, the\n\t\t\t\t<b>minimum healthy percent</b> represents a lower limit on\n\t\t\tthe number of tasks in a service that must remain in the <code>RUNNING</code> 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 <code>DRAINING</code>\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 <i>do not</i> use a load balancer\n\t\t\tare considered healthy if they are in the <code>RUNNING</code> state; tasks for services\n\t\t\tthat <i>do</i> use a load balancer are considered healthy if they are in\n\t\t\tthe <code>RUNNING</code> state and they are reported as healthy by the load balancer.\n\t\t\tThe default value for minimum healthy percent is 100%.</p>\n\t\t <p>If a service is using the blue/green (<code>CODE_DEPLOY</code>) or\n\t\t\t\t<code>EXTERNAL</code> deployment types and tasks that use the EC2\n\t\t\tlaunch type, the <b>minimum healthy percent</b> 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 <code>RUNNING</code> state while the container instances\n\t\t\tare in the <code>DRAINING</code> 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.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Optional deployment parameters that control how many tasks run during a deployment and\n\t\t\tthe ordering of stopping and starting tasks.</p>"
}
},
"com.amazonaws.ecs#DeploymentController": {
"type": "structure",
"members": {
"type": {
"target": "com.amazonaws.ecs#DeploymentControllerType",
"traits": {
"smithy.api#documentation": "<p>The deployment controller type to use.</p>\n\t\t <p>There are three deployment controller types available:</p>\n\t\t <dl>\n <dt>ECS</dt>\n <dd>\n\t\t\t\t\t <p>The rolling update (<code>ECS</code>) 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 <a>DeploymentConfiguration</a>.</p>\n\t\t\t\t </dd>\n <dt>CODE_DEPLOY</dt>\n <dd>\n\t\t\t\t\t <p>The blue/green (<code>CODE_DEPLOY</code>) 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.</p>\n\t\t\t\t </dd>\n <dt>EXTERNAL</dt>\n <dd>\n\t\t\t\t\t <p>The external (<code>EXTERNAL</code>) 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.</p>\n\t\t\t\t </dd>\n </dl>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The deployment controller to use for the service. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html\">Amazon ECS Deployment Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"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": "<p>Deregisters an Amazon ECS container instance from the specified cluster. This instance is\n\t\t\tno longer available to run tasks.</p>\n\t\t <p>If 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.</p>\n\t\t <p>Deregistering 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.</p>\n\t\t <note>\n\t\t\t <p>If 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).</p>\n\t\t </note>"
}
},
"com.amazonaws.ecs#DeregisterContainerInstanceRequest": {
"type": "structure",
"members": {
"cluster": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The 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.</p>"
}
},
"containerInstance": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The container instance ID or full ARN of the container instance to deregister.\n\t\t\tThe ARN contains the <code>arn:aws:ecs</code> namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the <code>container-instance</code> namespace, and then the container instance ID. For example, <code>arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID</code>.</p>",
"smithy.api#required": {}
}
},
"force": {
"target": "com.amazonaws.ecs#BoxedBoolean",
"traits": {
"smithy.api#documentation": "<p>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 <code>force</code> 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. </p>\n\t\t <p>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.</p>"
}
}
}
},
"com.amazonaws.ecs#DeregisterContainerInstanceResponse": {
"type": "structure",
"members": {
"containerInstance": {
"target": "com.amazonaws.ecs#ContainerInstance",
"traits": {
"smithy.api#documentation": "<p>The container instance that was deregistered.</p>"
}
}
}
},
"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": "<p>Deregisters the specified task definition by family and revision. Upon deregistration,\n\t\t\tthe task definition is marked as <code>INACTIVE</code>. Existing tasks and services that\n\t\t\treference an <code>INACTIVE</code> task definition continue to run without disruption.\n\t\t\tExisting services that reference an <code>INACTIVE</code> task definition can still\n\t\t\tscale up or down by modifying the service's desired count.</p>\n\t\t <p>You cannot use an <code>INACTIVE</code> 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\t<code>INACTIVE</code> 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.</p>\n\t\t <note>\n\t\t\t <p>At this time, <code>INACTIVE</code> 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 <code>INACTIVE</code> task definitions persisting beyond the\n\t\t\t\tlifecycle of any associated tasks and services.</p>\n\t\t </note>"
}
},
"com.amazonaws.ecs#DeregisterTaskDefinitionRequest": {
"type": "structure",
"members": {
"taskDefinition": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or\n\t\t\tfull Amazon Resource Name (ARN) of the task definition to deregister. You must specify a\n\t\t\t\t<code>revision</code>.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.ecs#DeregisterTaskDefinitionResponse": {
"type": "structure",
"members": {
"taskDefinition": {
"target": "com.amazonaws.ecs#TaskDefinition",
"traits": {
"smithy.api#documentation": "<p>The full description of the deregistered task.</p>"
}
}
}
},
"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": "<p>Describes one or more of your capacity providers.</p>"
}
},
"com.amazonaws.ecs#DescribeCapacityProvidersRequest": {
"type": "structure",
"members": {
"capacityProviders": {
"target": "com.amazonaws.ecs#StringList",
"traits": {
"smithy.api#documentation": "<p>The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to\n\t\t\t\t<code>100</code> capacity providers can be described in an action.</p>"
}
},
"include": {
"target": "com.amazonaws.ecs#CapacityProviderFieldList",
"traits": {
"smithy.api#documentation": "<p>Specifies whether or not you want to see the resource tags for the capacity provider.\n\t\t\tIf <code>TAGS</code> is specified, the tags are included in the response. If this field\n\t\t\tis omitted, tags are not included in the response.</p>"
}
},
"maxResults": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>The maximum number of account setting results returned by\n\t\t\t\t<code>DescribeCapacityProviders</code> in paginated output. When this parameter is\n\t\t\tused, <code>DescribeCapacityProviders</code> only returns <code>maxResults</code>\n\t\t\tresults in a single page along with a <code>nextToken</code> response element. The\n\t\t\tremaining results of the initial request can be seen by sending another\n\t\t\t\t<code>DescribeCapacityProviders</code> request with the returned\n\t\t\t\t<code>nextToken</code> value. This value can be between\n\t\t\t1 and 10. If this\n\t\t\tparameter is not used, then <code>DescribeCapacityProviders</code> returns up to\n\t\t\t10 results and a <code>nextToken</code> value\n\t\t\tif applicable.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The <code>nextToken</code> value returned from a previous paginated\n\t\t\t\t<code>DescribeCapacityProviders</code> request where <code>maxResults</code> 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 <code>nextToken</code> value.</p>\n\t\t <note>\n <p>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.</p>\n </note>"
}
}
}
},
"com.amazonaws.ecs#DescribeCapacityProvidersResponse": {
"type": "structure",
"members": {
"capacityProviders": {
"target": "com.amazonaws.ecs#CapacityProviders",
"traits": {
"smithy.api#documentation": "<p>The list of capacity providers.</p>"
}
},
"failures": {
"target": "com.amazonaws.ecs#Failures",
"traits": {
"smithy.api#documentation": "<p>Any failures associated with the call.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The <code>nextToken</code> value to include in a future\n\t\t\t\t<code>DescribeCapacityProviders</code> request. When the results of a\n\t\t\t\t<code>DescribeCapacityProviders</code> request exceed <code>maxResults</code>, this\n\t\t\tvalue can be used to retrieve the next page of results. This value is <code>null</code>\n\t\t\twhen there are no more results to return.</p>"
}
}
}
},
"com.amazonaws.ecs#DescribeClusters": {
"type": "operation",
"input": {
"target": "com.amazonaws.ecs#DescribeClustersRequest"
},
"output": {
"target": "com.amazonaws.ecs#DescribeClustersResponse"
},
"errors": [
{
"target": "com.amazonaws.ecs#ClientException"
},
{
"target": "com.amazonaws.ecs#InvalidParameterException"
},
{
"target": "com.amazonaws.ecs#ServerException"
}
],
"traits": {
"smithy.api#documentation": "<p>Describes one or more of your clusters.</p>"
}
},
"com.amazonaws.ecs#DescribeClustersRequest": {
"type": "structure",
"members": {
"clusters": {
"target": "com.amazonaws.ecs#StringList",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"include": {
"target": "com.amazonaws.ecs#ClusterFieldList",
"traits": {
"smithy.api#documentation": "<p>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.</p>\n\t\t <p>If <code>ATTACHMENTS</code> is specified, the attachments for the container instances\n\t\t\tor tasks within the cluster are included.</p>\n\t\t <p>If <code>SETTINGS</code> is specified, the settings for the cluster are\n\t\t\tincluded.</p>\n\t\t <p>If <code>STATISTICS</code> is specified, the following additional information,\n\t\t\tseparated by launch type, is included:</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>runningEC2TasksCount</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>runningFargateTasksCount</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>pendingEC2TasksCount</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>pendingFargateTasksCount</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>activeEC2ServiceCount</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>activeFargateServiceCount</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>drainingEC2ServiceCount</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>drainingFargateServiceCount</p>\n\t\t\t </li>\n </ul>\n\t\t <p>If <code>TAGS</code> is specified, the metadata tags associated with the cluster are\n\t\t\tincluded.</p>"
}
}
}
},
"com.amazonaws.ecs#DescribeClustersResponse": {
"type": "structure",
"members": {
"clusters": {
"target": "com.amazonaws.ecs#Clusters",
"traits": {
"smithy.api#documentation": "<p>The list of clusters.</p>"
}
},
"failures": {
"target": "com.amazonaws.ecs#Failures",
"traits": {
"smithy.api#documentation": "<p>Any failures associated with the call.</p>"
}
}
}
},
"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": "<p>Describes Amazon Elastic Container Service container instances. Returns metadata about registered and\n\t\t\tremaining resources on each container instance requested.</p>"
}
},
"com.amazonaws.ecs#DescribeContainerInstancesRequest": {
"type": "structure",
"members": {
"cluster": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"containerInstances": {
"target": "com.amazonaws.ecs#StringList",
"traits": {
"smithy.api#documentation": "<p>A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.</p>",
"smithy.api#required": {}
}
},
"include": {
"target": "com.amazonaws.ecs#ContainerInstanceFieldList",
"traits": {
"smithy.api#documentation": "<p>Specifies whether you want to see the resource tags for the container instance. If\n\t\t\t\t<code>TAGS</code> is specified, the tags are included in the response. If this field\n\t\t\tis omitted, tags are not included in the response.</p>"
}
}
}
},
"com.amazonaws.ecs#DescribeContainerInstancesResponse": {
"type": "structure",
"members": {
"containerInstances": {
"target": "com.amazonaws.ecs#ContainerInstances",
"traits": {
"smithy.api#documentation": "<p>The list of container instances.</p>"
}
},
"failures": {
"target": "com.amazonaws.ecs#Failures",
"traits": {
"smithy.api#documentation": "<p>Any failures associated with the call.</p>"
}
}
}
},
"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": "<p>Describes the specified services running in your cluster.</p>",
"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": "<p>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.</p>"
}
},
"services": {
"target": "com.amazonaws.ecs#StringList",
"traits": {
"smithy.api#documentation": "<p>A list of services to describe. You may specify up to 10 services to describe in a\n\t\t\tsingle operation.</p>",
"smithy.api#required": {}
}
},
"include": {
"target": "com.amazonaws.ecs#ServiceFieldList",
"traits": {
"smithy.api#documentation": "<p>Specifies whether you want to see the resource tags for the service. If\n\t\t\t\t<code>TAGS</code> is specified, the tags are included in the response. If this field\n\t\t\tis omitted, tags are not included in the response.</p>"
}
}
}
},
"com.amazonaws.ecs#DescribeServicesResponse": {
"type": "structure",
"members": {
"services": {
"target": "com.amazonaws.ecs#Services",
"traits": {
"smithy.api#documentation": "<p>The list of services described.</p>"
}
},
"failures": {
"target": "com.amazonaws.ecs#Failures",
"traits": {
"smithy.api#documentation": "<p>Any failures associated with the call.</p>"
}
}
}
},
"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": "<p>Describes a task definition. You can specify a <code>family</code> and\n\t\t\t\t<code>revision</code> to find information about a specific task definition, or you\n\t\t\tcan simply specify the family to find the latest <code>ACTIVE</code> revision in that\n\t\t\tfamily.</p>\n\t\t <note>\n\t\t\t <p>You can only describe <code>INACTIVE</code> task definitions while an active task\n\t\t\t\tor service references them.</p>\n\t\t </note>"
}
},
"com.amazonaws.ecs#DescribeTaskDefinitionRequest": {
"type": "structure",
"members": {
"taskDefinition": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The <code>family</code> for the latest <code>ACTIVE</code> revision,\n\t\t\t\t<code>family</code> and <code>revision</code> (<code>family:revision</code>) 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.</p>",
"smithy.api#required": {}
}
},
"include": {
"target": "com.amazonaws.ecs#TaskDefinitionFieldList",
"traits": {
"smithy.api#documentation": "<p>Specifies whether to see the resource tags for the task definition. If\n\t\t\t\t<code>TAGS</code> is specified, the tags are included in the response. If this field\n\t\t\tis omitted, tags are not included in the response.</p>"
}
}
}
},
"com.amazonaws.ecs#DescribeTaskDefinitionResponse": {
"type": "structure",
"members": {
"taskDefinition": {
"target": "com.amazonaws.ecs#TaskDefinition",
"traits": {
"smithy.api#documentation": "<p>The full task definition description.</p>"
}
},
"tags": {
"target": "com.amazonaws.ecs#Tags",
"traits": {
"smithy.api#documentation": "<p>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.</p> \n <p>The following basic restrictions apply to tags:</p>\n <ul>\n <li>\n <p>Maximum number of tags per resource - 50</p>\n </li>\n <li>\n <p>For each resource, each tag key must be unique, and each tag key can have only\n one value.</p>\n </li>\n <li>\n <p>Maximum key length - 128 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>Maximum value length - 256 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>If 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: + - = . _ : / @.</p>\n </li>\n <li>\n <p>Tag keys and values are case-sensitive.</p>\n </li>\n <li>\n <p>Do not use <code>aws:</code>, <code>AWS:</code>, 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.</p>\n </li>\n </ul>"
}
}
}
},
"com.amazonaws.ecs#DescribeTaskSets": {
"type": "operation",
"input": {
"target": "com.amazonaws.ecs#DescribeTaskSetsRequest"
},
"output": {
"target": "com.amazonaws.ecs#DescribeTaskSetsResponse"
},
"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#UnsupportedFeatureException"
}
],
"traits": {
"smithy.api#documentation": "<p>Describes the task sets in the specified cluster and service. This is used when a\n\t\t\tservice uses the <code>EXTERNAL</code> deployment controller type. For more information,\n\t\t\tsee <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html\">Amazon ECS Deployment\n\t\t\t\tTypes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"com.amazonaws.ecs#DescribeTaskSetsRequest": {
"type": "structure",
"members": {
"cluster": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>",
"smithy.api#required": {}
}
},
"service": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The short name or full Amazon Resource Name (ARN) of the service that the task sets exist in.</p>",
"smithy.api#required": {}
}
},
"taskSets": {
"target": "com.amazonaws.ecs#StringList",
"traits": {
"smithy.api#documentation": "<p>The ID or full Amazon Resource Name (ARN) of task sets to\n\t\t\tdescribe.</p>"
}
},
"include": {
"target": "com.amazonaws.ecs#TaskSetFieldList",
"traits": {
"smithy.api#documentation": "<p>Specifies whether to see the resource tags for the task set. If <code>TAGS</code> 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.</p>"
}
}
}
},
"com.amazonaws.ecs#DescribeTaskSetsResponse": {
"type": "structure",
"members": {
"taskSets": {
"target": "com.amazonaws.ecs#TaskSets",
"traits": {
"smithy.api#documentation": "<p>The list of task sets described.</p>"
}
},
"failures": {
"target": "com.amazonaws.ecs#Failures",
"traits": {
"smithy.api#documentation": "<p>Any failures associated with the call.</p>"
}
}
}
},
"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": "<p>Describes a specified task or tasks.</p>",
"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": "<p>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.</p>"
}
},
"tasks": {
"target": "com.amazonaws.ecs#StringList",
"traits": {
"smithy.api#documentation": "<p>A list of up to 100 task IDs or full ARN entries.</p>",
"smithy.api#required": {}
}
},
"include": {
"target": "com.amazonaws.ecs#TaskFieldList",
"traits": {
"smithy.api#documentation": "<p>Specifies whether you want to see the resource tags for the task. If <code>TAGS</code>\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.</p>"
}
}
}
},
"com.amazonaws.ecs#DescribeTasksResponse": {
"type": "structure",
"members": {
"tasks": {
"target": "com.amazonaws.ecs#Tasks",
"traits": {
"smithy.api#documentation": "<p>The list of tasks.</p>"
}
},
"failures": {
"target": "com.amazonaws.ecs#Failures",
"traits": {
"smithy.api#documentation": "<p>Any failures associated with the call.</p>"
}
}
}
},
"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": "<p>The path for the device on the host container instance.</p>",
"smithy.api#required": {}
}
},
"containerPath": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The path inside the container at which to expose the host device.</p>"
}
},
"permissions": {
"target": "com.amazonaws.ecs#DeviceCgroupPermissions",
"traits": {
"smithy.api#documentation": "<p>The explicit permissions to provide to the container for the device. By default, the\n\t\t\tcontainer has permissions for <code>read</code>, <code>write</code>, and\n\t\t\t\t<code>mknod</code> for the device.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object representing a container instance host device.</p>"
}
},
"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": "<note>\n <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p>\n </note> \n <p>Returns an endpoint for\n\t\t\tthe Amazon ECS agent to poll for updates.</p>"
}
},
"com.amazonaws.ecs#DiscoverPollEndpointRequest": {
"type": "structure",
"members": {
"containerInstance": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The container instance ID or full ARN of the container instance.\n\t\t\tThe ARN contains the <code>arn:aws:ecs</code> namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the <code>container-instance</code> namespace, and then the container instance ID. For example, <code>arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID</code>.</p>"
}
},
"cluster": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The short name or full Amazon Resource Name (ARN) of the cluster to which the container instance\n\t\t\tbelongs.</p>"
}
}
}
},
"com.amazonaws.ecs#DiscoverPollEndpointResponse": {
"type": "structure",
"members": {
"endpoint": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The endpoint for the Amazon ECS agent to poll.</p>"
}
},
"telemetryEndpoint": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The telemetry endpoint for the Amazon ECS agent.</p>"
}
}
}
},
"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": "<p>The scope for the Docker volume that determines its lifecycle. Docker volumes that are\n\t\t\tscoped to a <code>task</code> are automatically provisioned when the task starts and\n\t\t\tdestroyed when the task stops. Docker volumes that are scoped as <code>shared</code>\n\t\t\tpersist after the task stops.</p>"
}
},
"autoprovision": {
"target": "com.amazonaws.ecs#BoxedBoolean",
"traits": {
"smithy.api#documentation": "<p>If this value is <code>true</code>, the Docker volume is created if it does not\n\t\t\talready exist.</p>\n\t\t <note>\n\t\t\t <p>This field is only used if the <code>scope</code> is <code>shared</code>.</p>\n\t\t </note>"
}
},
"driver": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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 <code>docker plugin ls</code> 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 <a href=\"https://docs.docker.com/engine/extend/plugin_api/#plugin-discovery\">Docker\n\t\t\t\tplugin discovery</a>. This parameter maps to <code>Driver</code> in the\n\t\t\t<a href=\"https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate\">Create a volume</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the\n\t\t\t\t<code>xxdriver</code> option to <a href=\"https://docs.docker.com/engine/reference/commandline/volume_create/\">docker\n\t\t\t\tvolume create</a>.</p>"
}
},
"driverOpts": {
"target": "com.amazonaws.ecs#StringMap",
"traits": {
"smithy.api#documentation": "<p>A map of Docker driver-specific options passed through. This parameter maps to\n\t\t\t\t<code>DriverOpts</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate\">Create a volume</a> section of the\n\t\t\t<a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>xxopt</code> option to <a href=\"https://docs.docker.com/engine/reference/commandline/volume_create/\">docker\n\t\t\t\tvolume create</a>.</p>"
}
},
"labels": {
"target": "com.amazonaws.ecs#StringMap",
"traits": {
"smithy.api#documentation": "<p>Custom metadata to add to your Docker volume. This parameter maps to\n\t\t\t\t<code>Labels</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate\">Create a volume</a> section of the\n\t\t\t<a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>xxlabel</code> option to <a href=\"https://docs.docker.com/engine/reference/commandline/volume_create/\">docker\n\t\t\t\tvolume create</a>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>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 <code>local</code> driver. To use bind mounts, specify a\n\t\t\t\t<code>host</code> instead.</p>"
}
},
"com.amazonaws.ecs#Double": {
"type": "double"
},
"com.amazonaws.ecs#EFSAuthorizationConfig": {
"type": "structure",
"members": {
"accessPointId": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The Amazon EFS access point ID to use. If an access point is specified, the root directory\n\t\t\tvalue specified in the <code>EFSVolumeConfiguration</code> must either be omitted or set\n\t\t\tto <code>/</code> 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\t<code>EFSVolumeConfiguration</code>. For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html\">Working with Amazon\n\t\t\t\tEFS Access Points</a> in the <i>Amazon Elastic File System User Guide</i>.</p>"
}
},
"iam": {
"target": "com.amazonaws.ecs#EFSAuthorizationConfigIAM",
"traits": {
"smithy.api#documentation": "<p>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\t<code>EFSVolumeConfiguration</code>. If this parameter is omitted, the default value\n\t\t\tof <code>DISABLED</code> is used. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints\">Using\n\t\t\t\tAmazon EFS Access Points</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The authorization configuration details for the Amazon EFS file system.</p>"
}
},
"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": "<p>The Amazon EFS file system ID to use.</p>",
"smithy.api#required": {}
}
},
"rootDirectory": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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 <code>/</code> will have the same effect as omitting this parameter.</p>\n\t\t <important>\n\t\t\t <p>If an EFS access point is specified in the <code>authorizationConfig</code>, the\n\t\t\t\troot directory parameter must either be omitted or set to <code>/</code> which will\n\t\t\t\tenforce the path set on the EFS access point.</p>\n\t\t </important>"
}
},
"transitEncryption": {
"target": "com.amazonaws.ecs#EFSTransitEncryption",
"traits": {
"smithy.api#documentation": "<p>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 <code>DISABLED</code> is used.\n\t\t\tFor more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html\">Encrypting Data in Transit</a> in\n\t\t\tthe <i>Amazon Elastic File System User Guide</i>.</p>"
}
},
"transitEncryptionPort": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html\">EFS Mount\n\t\t\t\tHelper</a> in the <i>Amazon Elastic File System User Guide</i>.</p>"
}
},
"authorizationConfig": {
"target": "com.amazonaws.ecs#EFSAuthorizationConfig",
"traits": {
"smithy.api#documentation": "<p>The authorization configuration details for the Amazon EFS file system.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html\">Amazon EFS Volumes</a> in the\n\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"com.amazonaws.ecs#EnvironmentFile": {
"type": "structure",
"members": {
"value": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment\n\t\t\tvariable file.</p>",
"smithy.api#required": {}
}
},
"type": {
"target": "com.amazonaws.ecs#EnvironmentFileType",
"traits": {
"smithy.api#documentation": "<p>The file type to use. The only supported value is <code>s3</code>.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>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 <code>.env</code> file\n\t\t\textension. Each line in an environment file should contain an environment variable in\n\t\t\t\t<code>VARIABLE=VALUE</code> format. Lines beginning with <code>#</code> are treated\n\t\t\tas comments and are ignored. For more information on the environment variable file\n\t\t\tsyntax, see <a href=\"https://docs.docker.com/compose/env-file/\">Declare default\n\t\t\t\tenvironment variables in file</a>.</p>\n\t\t <p>If there are environment variables specified using the <code>environment</code>\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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html\">Specifying environment\n\t\t\t\tvariables</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t <p>This field is only valid for containers in Fargate tasks that use\n\t\t\tplatform version <code>1.4.0</code> or later.</p>"
}
},
"com.amazonaws.ecs#EnvironmentFileType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "s3",
"name": "S3"
}
]
}
},
"com.amazonaws.ecs#EnvironmentFiles": {
"type": "list",
"member": {
"target": "com.amazonaws.ecs#EnvironmentFile"
}
},
"com.amazonaws.ecs#EnvironmentVariables": {
"type": "list",
"member": {
"target": "com.amazonaws.ecs#KeyValuePair"
}
},
"com.amazonaws.ecs#EphemeralStorage": {
"type": "structure",
"members": {
"sizeInGiB": {
"target": "com.amazonaws.ecs#Integer",
"traits": {
"smithy.api#documentation": "<p>The total amount, in GiB, of ephemeral storage to set for the task. The minimum\n\t\t\tsupported value is <code>21</code> GiB and the maximum supported value is\n\t\t\t\t<code>200</code> GiB.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html\">Fargate task\n\t\t\t\tstorage</a> in the <i>Amazon ECS User Guide for AWS Fargate</i>.</p>\n\t\t <note>\n\t\t\t <p>This parameter is only supported for tasks hosted on AWS Fargate using platform\n\t\t\t\tversion <code>1.4.0</code> or later.</p>\n\t\t </note>"
}
},
"com.amazonaws.ecs#ExecuteCommand": {
"type": "operation",
"input": {
"target": "com.amazonaws.ecs#ExecuteCommandRequest"
},
"output": {
"target": "com.amazonaws.ecs#ExecuteCommandResponse"
},
"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#TargetNotConnectedException"
}
],
"traits": {
"smithy.api#documentation": "<p>Runs a command remotely on a container within a task.</p>"
}
},
"com.amazonaws.ecs#ExecuteCommandConfiguration": {
"type": "structure",
"members": {
"kmsKeyId": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>Specify an AWS Key Management Service key ID to encrypt the data between the local\n\t\t\tclient and the container.</p>"
}
},
"logging": {
"target": "com.amazonaws.ecs#ExecuteCommandLogging",
"traits": {
"smithy.api#documentation": "<p>The log setting to use for redirecting logs for your execute command results. The\n\t\t\tfollowing log settings are available.</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>\n <code>NONE</code>: The execute command session is not logged.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <code>DEFAULT</code>: The <code>awslogs</code> 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 <code>awslogs</code> log driver is configured in the task\n\t\t\t\t\tdefinition, the output won't be logged.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <code>OVERRIDE</code>: Specify the logging details as a part of\n\t\t\t\t\t\t<code>logConfiguration</code>. If the <code>OVERRIDE</code> logging option\n\t\t\t\t\tis specified, the <code>logConfiguration</code> is required.</p>\n\t\t\t </li>\n </ul>"
}
},
"logConfiguration": {
"target": "com.amazonaws.ecs#ExecuteCommandLogConfiguration",
"traits": {
"smithy.api#documentation": "<p>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 <code>logging=OVERRIDE</code> is\n\t\t\tspecified, a <code>logConfiguration</code> must be provided.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The details of the execute command configuration.</p>"
}
},
"com.amazonaws.ecs#ExecuteCommandLogConfiguration": {
"type": "structure",
"members": {
"cloudWatchLogGroupName": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The name of the CloudWatch log group to send logs to.</p>\n\t\t <note>\n\t\t\t <p>The CloudWatch log group must already be created.</p>\n\t\t </note>"
}
},
"cloudWatchEncryptionEnabled": {
"target": "com.amazonaws.ecs#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether or not to enable encryption on the CloudWatch logs. If not specified,\n\t\t\tencryption will be disabled.</p>"
}
},
"s3BucketName": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The name of the S3 bucket to send logs to.</p>\n\t\t <note>\n\t\t\t <p>The S3 bucket must already be created.</p>\n\t\t </note>"
}
},
"s3EncryptionEnabled": {
"target": "com.amazonaws.ecs#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether or not to enable encryption on the CloudWatch logs. If not specified,\n\t\t\tencryption will be disabled.</p>"
}
},
"s3KeyPrefix": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>An optional folder in the S3 bucket to place logs in.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"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": "<p>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.</p>"
}
},
"container": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"command": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The command to run on the container.</p>",
"smithy.api#required": {}
}
},
"interactive": {
"target": "com.amazonaws.ecs#Boolean",
"traits": {
"smithy.api#documentation": "<p>Use this flag to run your command in interactive mode.</p>",
"smithy.api#required": {}
}
},
"task": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) or ID of the task the container is part of.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.ecs#ExecuteCommandResponse": {
"type": "structure",
"members": {
"clusterArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the cluster.</p>"
}
},
"containerArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the container.</p>"
}
},
"containerName": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The name of the container.</p>"
}
},
"interactive": {
"target": "com.amazonaws.ecs#Boolean",
"traits": {
"smithy.api#documentation": "<p>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 <code>true</code> for this\n\t\t\tvalue.</p>"
}
},
"session": {
"target": "com.amazonaws.ecs#Session",
"traits": {
"smithy.api#documentation": "<p>The details of the SSM session that was created for this instance of\n\t\t\texecute-command.</p>"
}
},
"taskArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the task.</p>"
}
}
}
},
"com.amazonaws.ecs#FSxWindowsFileServerAuthorizationConfig": {
"type": "structure",
"members": {
"credentialsParameter": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>",
"smithy.api#required": {}
}
},
"domain": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>A fully qualified domain name hosted by an <a href=\"https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_microsoft_ad.html\">AWS Directory Service</a> Managed Microsoft AD (Active Directory) or self-hosted AD on\n\t\t\tAmazon EC2.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The authorization configuration details for Amazon FSx for Windows File Server file system. See <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_FSxWindowsFileServerVolumeConfiguration.html\">FSxWindowsFileServerVolumeConfiguration</a> in the <i>Amazon Elastic\n\t\t\t\tContainer Service API Reference</i>.</p>\n\t\t <p>For more information and the input format, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html\">Amazon FSx for Windows File Server Volumes</a>\n\t\t\tin the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"com.amazonaws.ecs#FSxWindowsFileServerVolumeConfiguration": {
"type": "structure",
"members": {
"fileSystemId": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The Amazon FSx for Windows File Server file system ID to use.</p>",
"smithy.api#required": {}
}
},
"rootDirectory": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The directory within the Amazon FSx for Windows File Server file system to mount as the root directory\n\t\t\tinside the host.</p>",
"smithy.api#required": {}
}
},
"authorizationConfig": {
"target": "com.amazonaws.ecs#FSxWindowsFileServerAuthorizationConfig",
"traits": {
"smithy.api#documentation": "<p>The authorization configuration details for the Amazon FSx for Windows File Server file system.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>This parameter is specified when you are using <a href=\"https://docs.aws.amazon.com/fsx/latest/WindowsGuide/what-is.html\">Amazon FSx for Windows File Server</a> file system for task\n\t\t\tstorage.</p>\n\t\t <p>For more information and the input format, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html\">Amazon FSx for Windows File Server Volumes</a>\n\t\t\tin the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"com.amazonaws.ecs#Failure": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the failed resource.</p>"
}
},
"reason": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The reason for the failure.</p>"
}
},
"detail": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The details of the failure.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A failed resource. For a list of common causes, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html\">API failure\n\t\t\t\treasons</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"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": "<p>The log router to use. The valid values are <code>fluentd</code> or\n\t\t\t\t<code>fluentbit</code>.</p>",
"smithy.api#required": {}
}
},
"options": {
"target": "com.amazonaws.ecs#FirelensConfigurationOptionsMap",
"traits": {
"smithy.api#documentation": "<p>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<code>\"options\":{\"enable-ecs-log-metadata\":\"true|false\",\"config-file-type:\"s3|file\",\"config-file-value\":\"arn:aws:s3:::mybucket/fluent.conf|filepath\"}</code>.\n\t\t\tFor more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html#firelens-taskdef\">Creating\n\t\t\t\ta Task Definition that Uses a FireLens Configuration</a> in the\n\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t <note>\n\t\t\t <p>Tasks hosted on AWS Fargate only support the <code>file</code> configuration file\n\t\t\t\ttype.</p>\n\t\t </note>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html\">Custom Log Routing</a>\n\t\t\tin the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"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": "<p>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 <code>CMD</code> to execute the command\n\t\t\targuments directly, or <code>CMD-SHELL</code> to run the command with the container's\n\t\t\tdefault shell. For example:</p>\n\t\t <p>\n\t\t\t <code>[ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]</code>\n\t\t </p>\n\t\t <p>An exit code of 0 indicates success, and non-zero exit code indicates failure. For\n\t\t\tmore information, see <code>HealthCheck</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a>\n\t\t\tsection of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a>.</p>",
"smithy.api#required": {}
}
},
"interval": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"timeout": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"retries": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"startPeriod": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>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 <code>startPeriod</code> is disabled by default.</p>\n\t\t <note>\n\t\t\t <p>If a health check succeeds within the <code>startPeriod</code>, 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.</p>\n\t\t </note>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>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).</p>\n\t\t <p>You 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.</p>\n\t\t <p>The following describes the possible <code>healthStatus</code> values for a\n\t\t\tcontainer:</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>\n <code>HEALTHY</code>-The container health check has passed\n\t\t\t\t\tsuccessfully.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <code>UNHEALTHY</code>-The container health check has failed.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <code>UNKNOWN</code>-The container health check is being evaluated or\n\t\t\t\t\tthere is no container health check defined.</p>\n\t\t\t </li>\n </ul>\n\t\t <p>The following describes the possible <code>healthStatus</code> 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.</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>\n <code>HEALTHY</code>-All essential containers within the task have\n\t\t\t\t\tpassed their health checks.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <code>UNHEALTHY</code>-One or more essential containers have failed\n\t\t\t\t\ttheir health check.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <code>UNKNOWN</code>-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.</p>\n\t\t\t </li>\n </ul>\n\t\t <p>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.</p>\n\t\t <p>The following are notes about container health check support:</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>Container health checks require version 1.17.0 or greater of the Amazon ECS\n\t\t\t\t\tcontainer agent. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html\">Updating the\n\t\t\t\t\t\tAmazon ECS Container Agent</a>.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>Container 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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">AWS Fargate\n\t\t\t\t\t\tPlatform Versions</a>.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>Container 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.</p>\n\t\t\t </li>\n </ul>"
}
},
"com.amazonaws.ecs#HealthStatus": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "HEALTHY",
"name": "HEALTHY"
},
{
"value": "UNHEALTHY",
"name": "UNHEALTHY"
},
{
"value": "UNKNOWN",
"name": "UNKNOWN"
}
]
}
},
"com.amazonaws.ecs#HostEntry": {
"type": "structure",
"members": {
"hostname": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The hostname to use in the <code>/etc/hosts</code> entry.</p>",
"smithy.api#required": {}
}
},
"ipAddress": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The IP address to use in the <code>/etc/hosts</code> entry.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Hostnames and IP address entries that are added to the <code>/etc/hosts</code> file of\n\t\t\ta container via the <code>extraHosts</code> parameter of its <a>ContainerDefinition</a>. </p>"
}
},
"com.amazonaws.ecs#HostEntryList": {
"type": "list",
"member": {
"target": "com.amazonaws.ecs#HostEntry"
}
},
"com.amazonaws.ecs#HostVolumeProperties": {
"type": "structure",
"members": {
"sourcePath": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>When the <code>host</code> parameter is used, specify a <code>sourcePath</code> 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\t<code>host</code> parameter contains a <code>sourcePath</code> 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 <code>sourcePath</code> 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.</p>\n\t\t <p>If you are using the Fargate launch type, the <code>sourcePath</code>\n\t\t\tparameter is not supported.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Details on a container instance bind mount host volume.</p>"
}
},
"com.amazonaws.ecs#InferenceAccelerator": {
"type": "structure",
"members": {
"deviceName": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The Elastic Inference accelerator device name. The <code>deviceName</code> must also\n\t\t\tbe referenced in a container definition as a <a>ResourceRequirement</a>.</p>",
"smithy.api#required": {}
}
},
"deviceType": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The Elastic Inference accelerator type to use.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Details on a Elastic Inference accelerator. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-eia.html\">Working with\n\t\t\t\tAmazon Elastic Inference on Amazon ECS</a> in the\n\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"com.amazonaws.ecs#InferenceAcceleratorOverride": {
"type": "structure",
"members": {
"deviceName": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The Elastic Inference accelerator device name to override for the task. This parameter\n\t\t\tmust match a <code>deviceName</code> specified in the task definition.</p>"
}
},
"deviceType": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The Elastic Inference accelerator type to use.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-eia.html\">Working with Amazon Elastic Inference on Amazon ECS</a> in the\n\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"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": "<p>The specified parameter is invalid. Review the available parameters for the API\n\t\t\trequest.</p>",
"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": "<p>The Linux capabilities for the container that have been added to the default\n\t\t\tconfiguration provided by Docker. This parameter maps to <code>CapAdd</code> in the\n\t\t\t<a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the\n\t\t\t\t<code>--cap-add</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker\n\t\t\t\trun</a>.</p>\n\t\t <note>\n\t\t\t <p>Tasks launched on AWS Fargate only support adding the <code>SYS_PTRACE</code> kernel\n\t\t\t\tcapability.</p>\n\t\t </note>\n\t\t <p>Valid values: <code>\"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\"</code>\n </p>"
}
},
"drop": {
"target": "com.amazonaws.ecs#StringList",
"traits": {
"smithy.api#documentation": "<p>The Linux capabilities for the container that have been removed from the default\n\t\t\tconfiguration provided by Docker. This parameter maps to <code>CapDrop</code> in the\n\t\t\t<a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the\n\t\t\t\t<code>--cap-drop</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker\n\t\t\t\trun</a>.</p>\n\t\t <p>Valid values: <code>\"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\"</code>\n </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>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 <a href=\"https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities\">Runtime privilege and Linux capabilities</a> in the <i>Docker run\n\t\t\t\treference</i>. For more detailed information on these Linux capabilities, see\n\t\t\tthe <a href=\"http://man7.org/linux/man-pages/man7/capabilities.7.html\">capabilities(7)</a> Linux manual page.</p>"
}
},
"com.amazonaws.ecs#KeyValuePair": {
"type": "structure",
"members": {
"name": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The name of the key-value pair. For environment variables, this is the name of the\n\t\t\tenvironment variable.</p>"
}
},
"value": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The value of the key-value pair. For environment variables, this is the value of the\n\t\t\tenvironment variable.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A key-value pair object.</p>"
}
},
"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": "<p>The limit for the resource has been exceeded.</p>",
"smithy.api#error": "client"
}
},
"com.amazonaws.ecs#LinuxParameters": {
"type": "structure",
"members": {
"capabilities": {
"target": "com.amazonaws.ecs#KernelCapabilities",
"traits": {
"smithy.api#documentation": "<p>The Linux capabilities for the container that are added to or dropped from the default\n\t\t\tconfiguration provided by Docker.</p>\n\t\t <note>\n\t\t\t <p>For tasks that use the Fargate launch type,\n\t\t\t\t\t<code>capabilities</code> is supported for all platform versions but the\n\t\t\t\t\t<code>add</code> parameter is only supported if using platform version 1.4.0 or\n\t\t\t\tlater.</p>\n\t\t </note>"
}
},
"devices": {
"target": "com.amazonaws.ecs#DevicesList",
"traits": {
"smithy.api#documentation": "<p>Any host devices to expose to the container. This parameter maps to\n\t\t\t\t<code>Devices</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the\n\t\t\t<a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--device</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker run</a>.</p>\n\t\t <note>\n\t\t\t <p>If you are using tasks that use the Fargate launch type, the\n\t\t\t\t\t<code>devices</code> parameter is not supported.</p>\n\t\t </note>"
}
},
"initProcessEnabled": {
"target": "com.amazonaws.ecs#BoxedBoolean",
"traits": {
"smithy.api#documentation": "<p>Run an <code>init</code> process inside the container that forwards signals and reaps\n\t\t\tprocesses. This parameter maps to the <code>--init</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker run</a>. 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: <code>sudo docker version --format '{{.Server.APIVersion}}'</code>\n </p>"
}
},
"sharedMemorySize": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>The value for the size (in MiB) of the <code>/dev/shm</code> volume. This parameter\n\t\t\tmaps to the <code>--shm-size</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker\n\t\t\t\trun</a>.</p>\n\t\t <note>\n\t\t\t <p>If you are using tasks that use the Fargate launch type, the\n\t\t\t\t\t<code>sharedMemorySize</code> parameter is not supported.</p>\n\t\t </note>"
}
},
"tmpfs": {
"target": "com.amazonaws.ecs#TmpfsList",
"traits": {
"smithy.api#documentation": "<p>The container path, mount options, and size (in MiB) of the tmpfs mount. This\n\t\t\tparameter maps to the <code>--tmpfs</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker run</a>.</p>\n\t\t <note>\n\t\t\t <p>If you are using tasks that use the Fargate launch type, the\n\t\t\t\t\t<code>tmpfs</code> parameter is not supported.</p>\n\t\t </note>"
}
},
"maxSwap": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>The total amount of swap memory (in MiB) a container can use. This parameter will be\n\t\t\ttranslated to the <code>--memory-swap</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker run</a> where the value would be the sum of\n\t\t\tthe container memory plus the <code>maxSwap</code> value.</p>\n\t\t <p>If a <code>maxSwap</code> value of <code>0</code> is specified, the container will not\n\t\t\tuse swap. Accepted values are <code>0</code> or any positive integer. If the\n\t\t\t\t<code>maxSwap</code> parameter is omitted, the container will use the swap\n\t\t\tconfiguration for the container instance it is running on. A <code>maxSwap</code> value\n\t\t\tmust be set for the <code>swappiness</code> parameter to be used.</p>\n\t\t <note>\n\t\t\t <p>If you are using tasks that use the Fargate launch type, the\n\t\t\t\t\t<code>maxSwap</code> parameter is not supported.</p>\n\t\t </note>"
}
},
"swappiness": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>This allows you to tune a container's memory swappiness behavior. A\n\t\t\t\t<code>swappiness</code> value of <code>0</code> will cause swapping to not happen\n\t\t\tunless absolutely necessary. A <code>swappiness</code> value of <code>100</code> will\n\t\t\tcause pages to be swapped very aggressively. Accepted values are whole numbers between\n\t\t\t\t<code>0</code> and <code>100</code>. If the <code>swappiness</code> parameter is not\n\t\t\tspecified, a default value of <code>60</code> is used. If a value is not specified for\n\t\t\t\t<code>maxSwap</code> then this parameter is ignored. This parameter maps to the\n\t\t\t\t<code>--memory-swappiness</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker run</a>.</p>\n\t\t <note>\n\t\t\t <p>If you are using tasks that use the Fargate launch type, the\n\t\t\t\t\t<code>swappiness</code> parameter is not supported.</p>\n\t\t </note>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Linux-specific options that are applied to the container, such as Linux <a>KernelCapabilities</a>.</p>"
}
},
"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": "<p>Lists the account settings for a specified principal.</p>",
"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": "<p>The name of the account setting you want to list the settings for.</p>"
}
},
"value": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"principalArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>\n\t\t <note>\n\t\t\t <p>Federated users assume the account setting of the root user and can't have\n\t\t\t\texplicit account settings set for them.</p>\n\t\t </note>"
}
},
"effectiveSettings": {
"target": "com.amazonaws.ecs#Boolean",
"traits": {
"smithy.api#documentation": "<p>Specifies whether to return the effective settings. If <code>true</code>, the account\n\t\t\tsettings for the root user or the default setting for the <code>principalArn</code> are\n\t\t\treturned. If <code>false</code>, the account settings for the <code>principalArn</code>\n\t\t\tare returned if they are set. Otherwise, no account settings are returned.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The <code>nextToken</code> value returned from a <code>ListAccountSettings</code>\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls will be needed. If <code>maxResults</code> was provided, it is possible the number\n\t\t\tof results to be fewer than <code>maxResults</code>.</p> \n <note>\n <p>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.</p>\n </note>"
}
},
"maxResults": {
"target": "com.amazonaws.ecs#Integer",
"traits": {
"smithy.api#documentation": "<p>The maximum number of account setting results returned by\n\t\t\t\t<code>ListAccountSettings</code> in paginated output. When this parameter is used,\n\t\t\t\t<code>ListAccountSettings</code> only returns <code>maxResults</code> results in a\n\t\t\tsingle page along with a <code>nextToken</code> response element. The remaining results\n\t\t\tof the initial request can be seen by sending another <code>ListAccountSettings</code>\n\t\t\trequest with the returned <code>nextToken</code> value. This value can be between\n\t\t\t1 and 10. If this\n\t\t\tparameter is not used, then <code>ListAccountSettings</code> returns up to\n\t\t\t10 results and a <code>nextToken</code> value\n\t\t\tif applicable.</p>"
}
}
}
},
"com.amazonaws.ecs#ListAccountSettingsResponse": {
"type": "structure",
"members": {
"settings": {
"target": "com.amazonaws.ecs#Settings",
"traits": {
"smithy.api#documentation": "<p>The account settings for the resource.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The <code>nextToken</code> value to include in a future\n\t\t\t\t<code>ListAccountSettings</code> request. When the results of a\n\t\t\t\t<code>ListAccountSettings</code> request exceed <code>maxResults</code>, this value\n\t\t\tcan be used to retrieve the next page of results. This value is <code>null</code> when\n\t\t\tthere are no more results to return.</p>"
}
}
}
},
"com.amazonaws.ecs#ListAttributes": {
"type": "operation",
"input": {
"target": "com.amazonaws.ecs#ListAttributesRequest"
},
"output": {
"target": "com.amazonaws.ecs#ListAttributesResponse"
},
"errors": [
{
"target": "com.amazonaws.ecs#ClusterNotFoundException"
},
{
"target": "com.amazonaws.ecs#InvalidParameterException"
}
],
"traits": {
"smithy.api#documentation": "<p>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, <code>ListAttributes</code> 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(<code>ecs.os-type=linux</code>). </p>",
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"items": "attributes",
"pageSize": "maxResults"
}
}
},
"com.amazonaws.ecs#ListAttributesRequest": {
"type": "structure",
"members": {
"cluster": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"targetType": {
"target": "com.amazonaws.ecs#TargetType",
"traits": {
"smithy.api#documentation": "<p>The type of the target with which to list attributes.</p>",
"smithy.api#required": {}
}
},
"attributeName": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The name of the attribute with which to filter the results. </p>"
}
},
"attributeValue": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The value of the attribute with which to filter results. You must also specify an\n\t\t\tattribute name to use this parameter.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The <code>nextToken</code> value returned from a <code>ListAttributes</code> request\n\t\t\tindicating that more results are available to fulfill the request and further calls will\n\t\t\tbe needed. If <code>maxResults</code> was provided, it is possible the number of results\n\t\t\tto be fewer than <code>maxResults</code>.</p> \n <note>\n <p>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.</p>\n </note>"
}
},
"maxResults": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>The maximum number of cluster results returned by <code>ListAttributes</code> in\n\t\t\tpaginated output. When this parameter is used, <code>ListAttributes</code> only returns\n\t\t\t\t<code>maxResults</code> results in a single page along with a <code>nextToken</code>\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother <code>ListAttributes</code> request with the returned <code>nextToken</code>\n\t\t\tvalue. This value can be between 1 and 100. If this\n\t\t\tparameter is not used, then <code>ListAttributes</code> returns up to\n\t\t\t100 results and a <code>nextToken</code> value if applicable.</p>"
}
}
}
},
"com.amazonaws.ecs#ListAttributesResponse": {
"type": "structure",
"members": {
"attributes": {
"target": "com.amazonaws.ecs#Attributes",
"traits": {
"smithy.api#documentation": "<p>A list of attribute objects that meet the criteria of the request.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The <code>nextToken</code> value to include in a future <code>ListAttributes</code>\n\t\t\trequest. When the results of a <code>ListAttributes</code> request exceed\n\t\t\t\t<code>maxResults</code>, this value can be used to retrieve the next page of\n\t\t\tresults. This value is <code>null</code> when there are no more results to\n\t\t\treturn.</p>"
}
}
}
},
"com.amazonaws.ecs#ListClusters": {
"type": "operation",
"input": {
"target": "com.amazonaws.ecs#ListClustersRequest"
},
"output": {
"target": "com.amazonaws.ecs#ListClustersResponse"
},
"errors": [
{
"target": "com.amazonaws.ecs#ClientException"
},
{
"target": "com.amazonaws.ecs#InvalidParameterException"
},
{
"target": "com.amazonaws.ecs#ServerException"
}
],
"traits": {
"smithy.api#documentation": "<p>Returns a list of existing clusters.</p>",
"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": "<p>The <code>nextToken</code> value returned from a <code>ListClusters</code> request\n\t\t\tindicating that more results are available to fulfill the request and further calls will\n\t\t\tbe needed. If <code>maxResults</code> was provided, it is possible the number of results\n\t\t\tto be fewer than <code>maxResults</code>.</p> \n <note>\n <p>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.</p>\n </note>"
}
},
"maxResults": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>The maximum number of cluster results returned by <code>ListClusters</code> in\n\t\t\tpaginated output. When this parameter is used, <code>ListClusters</code> only returns\n\t\t\t\t<code>maxResults</code> results in a single page along with a <code>nextToken</code>\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother <code>ListClusters</code> request with the returned <code>nextToken</code>\n\t\t\tvalue. This value can be between 1 and 100. If this\n\t\t\tparameter is not used, then <code>ListClusters</code> returns up to\n\t\t\t100 results and a <code>nextToken</code> value if applicable.</p>"
}
}
}
},
"com.amazonaws.ecs#ListClustersResponse": {
"type": "structure",
"members": {
"clusterArns": {
"target": "com.amazonaws.ecs#StringList",
"traits": {
"smithy.api#documentation": "<p>The list of full Amazon Resource Name (ARN) entries for each cluster associated with your\n\t\t\taccount.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The <code>nextToken</code> value to include in a future <code>ListClusters</code>\n\t\t\trequest. When the results of a <code>ListClusters</code> request exceed\n\t\t\t\t<code>maxResults</code>, this value can be used to retrieve the next page of\n\t\t\tresults. This value is <code>null</code> when there are no more results to\n\t\t\treturn.</p>"
}
}
}
},
"com.amazonaws.ecs#ListContainerInstances": {
"type": "operation",
"input": {
"target": "com.amazonaws.ecs#ListContainerInstancesRequest"
},
"output": {
"target": "com.amazonaws.ecs#ListContainerInstancesResponse"
},
"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": "<p>Returns a list of container instances in a specified cluster. You can filter the\n\t\t\tresults of a <code>ListContainerInstances</code> operation with cluster query language\n\t\t\tstatements inside the <code>filter</code> parameter. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html\">Cluster Query Language</a> in the\n\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>",
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"items": "containerInstanceArns",
"pageSize": "maxResults"
}
}
},
"com.amazonaws.ecs#ListContainerInstancesRequest": {
"type": "structure",
"members": {
"cluster": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"filter": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>You can filter the results of a <code>ListContainerInstances</code> operation with\n\t\t\tcluster query language statements. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html\">Cluster Query Language</a> in the\n\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The <code>nextToken</code> value returned from a <code>ListContainerInstances</code>\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls will be needed. If <code>maxResults</code> was provided, it is possible the number\n\t\t\tof results to be fewer than <code>maxResults</code>.</p> \n <note>\n <p>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.</p>\n </note>"
}
},
"maxResults": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>The maximum number of container instance results returned by\n\t\t\t\t<code>ListContainerInstances</code> in paginated output. When this parameter is\n\t\t\tused, <code>ListContainerInstances</code> only returns <code>maxResults</code> results\n\t\t\tin a single page along with a <code>nextToken</code> response element. The remaining\n\t\t\tresults of the initial request can be seen by sending another\n\t\t\t\t<code>ListContainerInstances</code> request with the returned <code>nextToken</code>\n\t\t\tvalue. This value can be between 1 and 100. If this\n\t\t\tparameter is not used, then <code>ListContainerInstances</code> returns up to\n\t\t\t100 results and a <code>nextToken</code> value if applicable.</p>"
}
},
"status": {
"target": "com.amazonaws.ecs#ContainerInstanceStatus",
"traits": {
"smithy.api#documentation": "<p>Filters the container instances by status. For example, if you specify the\n\t\t\t\t<code>DRAINING</code> status, the results include only container instances that have\n\t\t\tbeen set to <code>DRAINING</code> using <a>UpdateContainerInstancesState</a>.\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 <code>INACTIVE</code>.</p>"
}
}
}
},
"com.amazonaws.ecs#ListContainerInstancesResponse": {
"type": "structure",
"members": {
"containerInstanceArns": {
"target": "com.amazonaws.ecs#StringList",
"traits": {
"smithy.api#documentation": "<p>The list of container instances with full ARN entries for each container instance\n\t\t\tassociated with the specified cluster.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The <code>nextToken</code> value to include in a future\n\t\t\t\t<code>ListContainerInstances</code> request. When the results of a\n\t\t\t\t<code>ListContainerInstances</code> request exceed <code>maxResults</code>, this\n\t\t\tvalue can be used to retrieve the next page of results. This value is <code>null</code>\n\t\t\twhen there are no more results to return.</p>"
}
}
}
},
"com.amazonaws.ecs#ListServices": {
"type": "operation",
"input": {
"target": "com.amazonaws.ecs#ListServicesRequest"
},
"output": {
"target": "com.amazonaws.ecs#ListServicesResponse"
},
"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": "<p>Lists the services that are running in a specified cluster.</p>",
"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": "<p>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.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The <code>nextToken</code> value returned from a <code>ListServices</code> request\n\t\t\tindicating that more results are available to fulfill the request and further calls will\n\t\t\tbe needed. If <code>maxResults</code> was provided, it is possible the number of results\n\t\t\tto be fewer than <code>maxResults</code>.</p> \n <note>\n <p>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.</p>\n </note>"
}
},
"maxResults": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>The maximum number of service results returned by <code>ListServices</code> in\n\t\t\tpaginated output. When this parameter is used, <code>ListServices</code> only returns\n\t\t\t\t<code>maxResults</code> results in a single page along with a <code>nextToken</code>\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother <code>ListServices</code> request with the returned <code>nextToken</code>\n\t\t\tvalue. This value can be between 1 and 100. If\n\t\t\tthis parameter is not used, then <code>ListServices</code> returns up to\n\t\t\t10 results and a <code>nextToken</code> value if\n\t\t\tapplicable.</p>"
}
},
"launchType": {
"target": "com.amazonaws.ecs#LaunchType",
"traits": {
"smithy.api#documentation": "<p>The launch type for the services to list.</p>"
}
},
"schedulingStrategy": {
"target": "com.amazonaws.ecs#SchedulingStrategy",
"traits": {
"smithy.api#documentation": "<p>The scheduling strategy for services to list.</p>"
}
}
}
},
"com.amazonaws.ecs#ListServicesResponse": {
"type": "structure",
"members": {
"serviceArns": {
"target": "com.amazonaws.ecs#StringList",
"traits": {
"smithy.api#documentation": "<p>The list of full ARN entries for each service associated with the specified\n\t\t\tcluster.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The <code>nextToken</code> value to include in a future <code>ListServices</code>\n\t\t\trequest. When the results of a <code>ListServices</code> request exceed\n\t\t\t\t<code>maxResults</code>, this value can be used to retrieve the next page of\n\t\t\tresults. This value is <code>null</code> when there are no more results to\n\t\t\treturn.</p>"
}
}
}
},
"com.amazonaws.ecs#ListTagsForResource": {
"type": "operation",
"input": {
"target": "com.amazonaws.ecs#ListTagsForResourceRequest"
},
"output": {
"target": "com.amazonaws.ecs#ListTagsForResourceResponse"
},
"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": "<p>List the tags for an Amazon ECS resource.</p>"
}
},
"com.amazonaws.ecs#ListTagsForResourceRequest": {
"type": "structure",
"members": {
"resourceArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.ecs#ListTagsForResourceResponse": {
"type": "structure",
"members": {
"tags": {
"target": "com.amazonaws.ecs#Tags",
"traits": {
"smithy.api#documentation": "<p>The tags for the resource.</p>"
}
}
}
},
"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": "<p>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 <code>ACTIVE</code> task\n\t\t\tdefinition revisions).</p>\n\t\t <p>You can filter out task definition families that do not contain any\n\t\t\t\t<code>ACTIVE</code> task definition revisions by setting the <code>status</code>\n\t\t\tparameter to <code>ACTIVE</code>. You can also filter the results with the\n\t\t\t\t<code>familyPrefix</code> parameter.</p>",
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"items": "families",
"pageSize": "maxResults"
}
}
},
"com.amazonaws.ecs#ListTaskDefinitionFamiliesRequest": {
"type": "structure",
"members": {
"familyPrefix": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The <code>familyPrefix</code> is a string that is used to filter the results of\n\t\t\t\t<code>ListTaskDefinitionFamilies</code>. If you specify a <code>familyPrefix</code>,\n\t\t\tonly task definition family names that begin with the <code>familyPrefix</code> string\n\t\t\tare returned.</p>"
}
},
"status": {
"target": "com.amazonaws.ecs#TaskDefinitionFamilyStatus",
"traits": {
"smithy.api#documentation": "<p>The task definition family status with which to filter the\n\t\t\t\t<code>ListTaskDefinitionFamilies</code> results. By default, both\n\t\t\t\t<code>ACTIVE</code> and <code>INACTIVE</code> task definition families are listed.\n\t\t\tIf this parameter is set to <code>ACTIVE</code>, only task definition families that have\n\t\t\tan <code>ACTIVE</code> task definition revision are returned. If this parameter is set\n\t\t\tto <code>INACTIVE</code>, only task definition families that do not have any\n\t\t\t\t<code>ACTIVE</code> task definition revisions are returned. If you paginate the\n\t\t\tresulting output, be sure to keep the <code>status</code> value constant in each\n\t\t\tsubsequent request.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The <code>nextToken</code> value returned from a\n\t\t\t\t<code>ListTaskDefinitionFamilies</code> 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\t<code>maxResults</code> was provided, it is possible the number of results to be\n\t\t\tfewer than <code>maxResults</code>.</p> \n <note>\n <p>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.</p>\n </note>"
}
},
"maxResults": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>The maximum number of task definition family results returned by\n\t\t\t\t<code>ListTaskDefinitionFamilies</code> in paginated output. When this parameter is\n\t\t\tused, <code>ListTaskDefinitions</code> only returns <code>maxResults</code> results in a\n\t\t\tsingle page along with a <code>nextToken</code> response element. The remaining results\n\t\t\tof the initial request can be seen by sending another\n\t\t\t\t<code>ListTaskDefinitionFamilies</code> request with the returned\n\t\t\t\t<code>nextToken</code> value. This value can be between 1 and\n\t\t\t100. If this parameter is not used, then\n\t\t\t\t<code>ListTaskDefinitionFamilies</code> returns up to 100 results\n\t\t\tand a <code>nextToken</code> value if applicable.</p>"
}
}
}
},
"com.amazonaws.ecs#ListTaskDefinitionFamiliesResponse": {
"type": "structure",
"members": {
"families": {
"target": "com.amazonaws.ecs#StringList",
"traits": {
"smithy.api#documentation": "<p>The list of task definition family names that match the\n\t\t\t\t<code>ListTaskDefinitionFamilies</code> request.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The <code>nextToken</code> value to include in a future\n\t\t\t\t<code>ListTaskDefinitionFamilies</code> request. When the results of a\n\t\t\t\t<code>ListTaskDefinitionFamilies</code> request exceed <code>maxResults</code>, this\n\t\t\tvalue can be used to retrieve the next page of results. This value is <code>null</code>\n\t\t\twhen there are no more results to return.</p>"
}
}
}
},
"com.amazonaws.ecs#ListTaskDefinitions": {
"type": "operation",
"input": {
"target": "com.amazonaws.ecs#ListTaskDefinitionsRequest"
},
"output": {
"target": "com.amazonaws.ecs#ListTaskDefinitionsResponse"
},
"errors": [
{
"target": "com.amazonaws.ecs#ClientException"
},
{
"target": "com.amazonaws.ecs#InvalidParameterException"
},
{
"target": "com.amazonaws.ecs#ServerException"
}
],
"traits": {
"smithy.api#documentation": "<p>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 <code>familyPrefix</code> parameter or by status\n\t\t\twith the <code>status</code> parameter.</p>",
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"items": "taskDefinitionArns",
"pageSize": "maxResults"
}
}
},
"com.amazonaws.ecs#ListTaskDefinitionsRequest": {
"type": "structure",
"members": {
"familyPrefix": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The full family name with which to filter the <code>ListTaskDefinitions</code>\n\t\t\tresults. Specifying a <code>familyPrefix</code> limits the listed task definitions to\n\t\t\ttask definition revisions that belong to that family.</p>"
}
},
"status": {
"target": "com.amazonaws.ecs#TaskDefinitionStatus",
"traits": {
"smithy.api#documentation": "<p>The task definition status with which to filter the <code>ListTaskDefinitions</code>\n\t\t\tresults. By default, only <code>ACTIVE</code> task definitions are listed. By setting\n\t\t\tthis parameter to <code>INACTIVE</code>, you can view task definitions that are\n\t\t\t\t<code>INACTIVE</code> 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 <code>status</code> value\n\t\t\tconstant in each subsequent request.</p>"
}
},
"sort": {
"target": "com.amazonaws.ecs#SortOrder",
"traits": {
"smithy.api#documentation": "<p>The order in which to sort the results. Valid values are <code>ASC</code> and\n\t\t\t\t<code>DESC</code>. By default (<code>ASC</code>), 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\t<code>DESC</code> reverses the sort order on family name and revision so that the\n\t\t\tnewest task definitions in a family are listed first.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The <code>nextToken</code> value returned from a <code>ListTaskDefinitions</code>\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls will be needed. If <code>maxResults</code> was provided, it is possible the number\n\t\t\tof results to be fewer than <code>maxResults</code>.</p> \n <note>\n <p>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.</p>\n </note>"
}
},
"maxResults": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>The maximum number of task definition results returned by\n\t\t\t\t<code>ListTaskDefinitions</code> in paginated output. When this parameter is used,\n\t\t\t\t<code>ListTaskDefinitions</code> only returns <code>maxResults</code> results in a\n\t\t\tsingle page along with a <code>nextToken</code> response element. The remaining results\n\t\t\tof the initial request can be seen by sending another <code>ListTaskDefinitions</code>\n\t\t\trequest with the returned <code>nextToken</code> value. This value can be between\n\t\t\t1 and 100. If this parameter is not used, then\n\t\t\t\t<code>ListTaskDefinitions</code> returns up to 100 results and a\n\t\t\t\t<code>nextToken</code> value if applicable.</p>"
}
}
}
},
"com.amazonaws.ecs#ListTaskDefinitionsResponse": {
"type": "structure",
"members": {
"taskDefinitionArns": {
"target": "com.amazonaws.ecs#StringList",
"traits": {
"smithy.api#documentation": "<p>The list of task definition Amazon Resource Name (ARN) entries for the <code>ListTaskDefinitions</code>\n\t\t\trequest.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The <code>nextToken</code> value to include in a future\n\t\t\t\t<code>ListTaskDefinitions</code> request. When the results of a\n\t\t\t\t<code>ListTaskDefinitions</code> request exceed <code>maxResults</code>, this value\n\t\t\tcan be used to retrieve the next page of results. This value is <code>null</code> when\n\t\t\tthere are no more results to return.</p>"
}
}
}
},
"com.amazonaws.ecs#ListTasks": {
"type": "operation",
"input": {
"target": "com.amazonaws.ecs#ListTasksRequest"
},
"output": {
"target": "com.amazonaws.ecs#ListTasksResponse"
},
"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": "<p>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\t<code>family</code>, <code>containerInstance</code>, and <code>desiredStatus</code>\n\t\t\tparameters.</p>\n\t\t <p>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. </p>",
"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": "<p>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.</p>"
}
},
"containerInstance": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The container instance ID or full ARN of the container instance with which to filter\n\t\t\tthe <code>ListTasks</code> results. Specifying a <code>containerInstance</code> limits\n\t\t\tthe results to tasks that belong to that container instance.</p>"
}
},
"family": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The name of the family with which to filter the <code>ListTasks</code> results.\n\t\t\tSpecifying a <code>family</code> limits the results to tasks that belong to that\n\t\t\tfamily.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The <code>nextToken</code> value returned from a <code>ListTasks</code> request\n\t\t\tindicating that more results are available to fulfill the request and further calls will\n\t\t\tbe needed. If <code>maxResults</code> was provided, it is possible the number of results\n\t\t\tto be fewer than <code>maxResults</code>.</p> \n <note>\n <p>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.</p>\n </note>"
}
},
"maxResults": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>The maximum number of task results returned by <code>ListTasks</code> in paginated\n\t\t\toutput. When this parameter is used, <code>ListTasks</code> only returns\n\t\t\t\t<code>maxResults</code> results in a single page along with a <code>nextToken</code>\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother <code>ListTasks</code> request with the returned <code>nextToken</code> value.\n\t\t\tThis value can be between 1 and 100. If this parameter is\n\t\t\tnot used, then <code>ListTasks</code> returns up to 100 results and a\n\t\t\t\t<code>nextToken</code> value if applicable.</p>"
}
},
"startedBy": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The <code>startedBy</code> value with which to filter the task results. Specifying a\n\t\t\t\t<code>startedBy</code> value limits the results to tasks that were started with that\n\t\t\tvalue.</p>"
}
},
"serviceName": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The name of the service with which to filter the <code>ListTasks</code> results.\n\t\t\tSpecifying a <code>serviceName</code> limits the results to tasks that belong to that\n\t\t\tservice.</p>"
}
},
"desiredStatus": {
"target": "com.amazonaws.ecs#DesiredStatus",
"traits": {
"smithy.api#documentation": "<p>The task desired status with which to filter the <code>ListTasks</code> results.\n\t\t\tSpecifying a <code>desiredStatus</code> of <code>STOPPED</code> limits the results to\n\t\t\ttasks that Amazon ECS has set the desired status to <code>STOPPED</code>. 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 <code>RUNNING</code>, which shows tasks that Amazon ECS has set the desired\n\t\t\tstatus to <code>RUNNING</code>.</p>\n\t\t <note>\n\t\t\t <p>Although you can filter results based on a desired status of <code>PENDING</code>,\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 <code>lastStatus</code> may have a value of\n\t\t\t\t\t<code>PENDING</code>).</p>\n\t\t </note>"
}
},
"launchType": {
"target": "com.amazonaws.ecs#LaunchType",
"traits": {
"smithy.api#documentation": "<p>The launch type for services to list.</p>"
}
}
}
},
"com.amazonaws.ecs#ListTasksResponse": {
"type": "structure",
"members": {
"taskArns": {
"target": "com.amazonaws.ecs#StringList",
"traits": {
"smithy.api#documentation": "<p>The list of task ARN entries for the <code>ListTasks</code> request.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The <code>nextToken</code> value to include in a future <code>ListTasks</code>\n\t\t\trequest. When the results of a <code>ListTasks</code> request exceed\n\t\t\t\t<code>maxResults</code>, this value can be used to retrieve the next page of\n\t\t\tresults. This value is <code>null</code> when there are no more results to\n\t\t\treturn.</p>"
}
}
}
},
"com.amazonaws.ecs#LoadBalancer": {
"type": "structure",
"members": {
"targetGroupArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>\n\t\t <p>A 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.</p>\n\t\t <p>For services using the <code>ECS</code> deployment controller, you can specify one or\n\t\t\tmultiple target groups. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html\">Registering Multiple Target Groups with a Service</a> in\n\t\t\tthe <i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t <p>For services using the <code>CODE_DEPLOY</code> 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\t<a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html\">Blue/Green Deployment with CodeDeploy</a> in the\n\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t <important>\n\t\t\t <p>If your service's task definition uses the <code>awsvpc</code> network mode (which\n\t\t\t\tis required for the Fargate launch type), you must choose\n\t\t\t\t\t<code>ip</code> as the target type, not <code>instance</code>, when creating\n\t\t\t\tyour target groups because tasks that use the <code>awsvpc</code> network mode are\n\t\t\t\tassociated with an elastic network interface, not an Amazon EC2 instance.</p>\n\t\t </important>"
}
},
"loadBalancerName": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The name of the load balancer to associate with the Amazon ECS service or task set.</p>\n\t\t <p>A 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.</p>"
}
},
"containerName": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The name of the container (as it appears in a container definition) to associate with\n\t\t\tthe load balancer.</p>"
}
},
"containerPort": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>The port on the container to associate with the load balancer. This port must\n\t\t\tcorrespond to a <code>containerPort</code> 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 <code>hostPort</code> of\n\t\t\tthe port mapping.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The load balancer configuration to use with a service or task set.</p>\n\t\t <p>For specific notes and restrictions regarding the use of load balancers with services\n\t\t\tand task sets, see the CreateService and CreateTaskSet actions.</p>"
}
},
"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": "<p>The log driver to use for the container.</p>\n\t\t <p>For tasks on AWS Fargate, the supported log drivers are <code>awslogs</code>,\n\t\t\t\t<code>splunk</code>, and <code>awsfirelens</code>.</p>\n\t\t <p>For tasks hosted on Amazon EC2 instances, the supported log drivers are\n\t\t\t\t<code>awslogs</code>, <code>fluentd</code>, <code>gelf</code>,\n\t\t\t\t<code>json-file</code>, <code>journald</code>,\n\t\t\t\t<code>logentries</code>,<code>syslog</code>, <code>splunk</code>, and\n\t\t\t\t<code>awsfirelens</code>.</p>\n\t\t <p>For more information about using the <code>awslogs</code> log driver, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html\">Using\n\t\t\t\tthe awslogs log driver</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t <p>For more information about using the <code>awsfirelens</code> log driver, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html\">Custom log routing</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t <note>\n\t\t\t <p>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 <a href=\"https://github.com/aws/amazon-ecs-agent\">available\n\t\t\t\t\ton GitHub</a> 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.</p>\n\t\t </note>",
"smithy.api#required": {}
}
},
"options": {
"target": "com.amazonaws.ecs#LogConfigurationOptionsMap",
"traits": {
"smithy.api#documentation": "<p>The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: <code>sudo docker version --format '{{.Server.APIVersion}}'</code> \n </p>"
}
},
"secretOptions": {
"target": "com.amazonaws.ecs#SecretList",
"traits": {
"smithy.api#documentation": "<p>The secrets to pass to the log configuration. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html\">Specifying\n\t\t\t\tSensitive Data</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The log configuration for the container. This parameter maps to <code>LogConfig</code>\n\t\t\tin the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the\n\t\t\t\t<code>--log-driver</code> option to <a href=\"https://docs.docker.com/engine/reference/commandline/run/\">\n <code>docker\n\t\t\t\t\trun</code>\n </a>.</p>\n\t\t <p>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 <a href=\"https://docs.docker.com/engine/admin/logging/overview/\">Configure logging\n\t\t\t\tdrivers</a> in the Docker documentation.</p>\n\t\t <p>The following should be noted when specifying a log configuration for your\n\t\t\tcontainers:</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>Amazon 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.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>This parameter requires version 1.18 of the Docker Remote API or greater on\n\t\t\t\t\tyour container instance.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>For 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\t<code>ECS_AVAILABLE_LOGGING_DRIVERS</code> 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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html\">Amazon ECS container agent configuration</a> in the\n\t\t\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>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.</p>\n\t\t\t </li>\n </ul>"
}
},
"com.amazonaws.ecs#LogConfigurationOptionsMap": {
"type": "map",
"key": {
"target": "com.amazonaws.ecs#String"
},
"value": {
"target": "com.amazonaws.ecs#String"
}
},
"com.amazonaws.ecs#LogDriver": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "json-file",
"name": "JSON_FILE"
},
{
"value": "syslog",
"name": "SYSLOG"
},
{
"value": "journald",
"name": "JOURNALD"
},
{
"value": "gelf",
"name": "GELF"
},
{
"value": "fluentd",
"name": "FLUENTD"
},
{
"value": "awslogs",
"name": "AWSLOGS"
},
{
"value": "splunk",
"name": "SPLUNK"
},
{
"value": "awsfirelens",
"name": "AWSFIRELENS"
}
]
}
},
"com.amazonaws.ecs#Long": {
"type": "long"
},
"com.amazonaws.ecs#ManagedAgent": {
"type": "structure",
"members": {
"lastStartedAt": {
"target": "com.amazonaws.ecs#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The Unix timestamp for when the managed agent was last started.</p>"
}
},
"name": {
"target": "com.amazonaws.ecs#ManagedAgentName",
"traits": {
"smithy.api#documentation": "<p>The name of the managed agent. When the execute command feature is enabled, the\n\t\t\tmanaged agent name is <code>ExecuteCommandAgent</code>.</p>"
}
},
"reason": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The reason for why the managed agent is in the state it is in.</p>"
}
},
"lastStatus": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The last known status of the managed agent.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Details about the managed agent status for the container.</p>"
}
},
"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": "<p>The name of the container associated with the managed agent.</p>",
"smithy.api#required": {}
}
},
"managedAgentName": {
"target": "com.amazonaws.ecs#ManagedAgentName",
"traits": {
"smithy.api#documentation": "<p>The name of the managed agent.</p>",
"smithy.api#required": {}
}
},
"status": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The status of the managed agent.</p>",
"smithy.api#required": {}
}
},
"reason": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The reason for the status of the managed agent.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object representing a change in state for a managed agent.</p>"
}
},
"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": "<p>Whether or not to enable managed scaling for the capacity provider.</p>"
}
},
"targetCapacity": {
"target": "com.amazonaws.ecs#ManagedScalingTargetCapacity",
"traits": {
"smithy.api#documentation": "<p>The target capacity value for the capacity provider. The specified value must be\n\t\t\tgreater than <code>0</code> and less than or equal to <code>100</code>. A value of\n\t\t\t\t<code>100</code> will result in the Amazon EC2 instances in your Auto Scaling group being\n\t\t\tcompletely utilized.</p>"
}
},
"minimumScalingStepSize": {
"target": "com.amazonaws.ecs#ManagedScalingStepSize",
"traits": {
"smithy.api#documentation": "<p>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 <code>1</code> is used.</p>"
}
},
"maximumScalingStepSize": {
"target": "com.amazonaws.ecs#ManagedScalingStepSize",
"traits": {
"smithy.api#documentation": "<p>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 <code>10000</code> is\n\t\t\tused.</p>"
}
},
"instanceWarmupPeriod": {
"target": "com.amazonaws.ecs#ManagedScalingInstanceWarmupPeriod",
"traits": {
"smithy.api#documentation": "<p>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 <code>300</code> seconds is used.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The managed scaling settings for the Auto Scaling group capacity provider.</p>\n\t\t <p>When 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 <code>targetCapacity</code> value as the\n\t\t\ttarget value for the metric. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/asg-capacity-providers.html#asg-capacity-providers-managed-scaling\">Using Managed Scaling</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t <p>If managed scaling is disabled, the user must manage the scaling of the Auto Scaling\n\t\t\tgroup.</p>"
}
},
"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": "<p>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.</p>",
"smithy.api#error": "client"
}
},
"com.amazonaws.ecs#MountPoint": {
"type": "structure",
"members": {
"sourceVolume": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The name of the volume to mount. Must be a volume name referenced in the\n\t\t\t\t<code>name</code> parameter of task definition <code>volume</code>.</p>"
}
},
"containerPath": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The path on the container to mount the host volume at.</p>"
}
},
"readOnly": {
"target": "com.amazonaws.ecs#BoxedBoolean",
"traits": {
"smithy.api#documentation": "<p>If this value is <code>true</code>, the container has read-only access to the volume.\n\t\t\tIf this value is <code>false</code>, then the container can write to the volume. The\n\t\t\tdefault value is <code>false</code>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Details on a volume mount point that is used in a container definition.</p>"
}
},
"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": "<p>The IP address that the container is bound to on the container instance.</p>"
}
},
"containerPort": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>The port number on the container that is used with the network binding.</p>"
}
},
"hostPort": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>The port number on the host that is used with the network binding.</p>"
}
},
"protocol": {
"target": "com.amazonaws.ecs#TransportProtocol",
"traits": {
"smithy.api#documentation": "<p>The protocol used for the network binding.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Details on the network bindings between a container and its host container instance.\n\t\t\tAfter a task reaches the <code>RUNNING</code> status, manual and automatic host and\n\t\t\tcontainer port assignments are visible in the <code>networkBindings</code> section of\n\t\t\t\t<a>DescribeTasks</a> API responses.</p>"
}
},
"com.amazonaws.ecs#NetworkBindings": {
"type": "list",
"member": {
"target": "com.amazonaws.ecs#NetworkBinding"
}
},
"com.amazonaws.ecs#NetworkConfiguration": {
"type": "structure",
"members": {
"awsvpcConfiguration": {
"target": "com.amazonaws.ecs#AwsVpcConfiguration",
"traits": {
"smithy.api#documentation": "<p>The VPC subnets and security groups associated with a task.</p>\n\t\t <note>\n\t\t\t <p>All specified subnets and security groups must be from the same VPC.</p>\n\t\t </note>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object representing the network configuration for a task or service.</p>"
}
},
"com.amazonaws.ecs#NetworkInterface": {
"type": "structure",
"members": {
"attachmentId": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The attachment ID for the network interface.</p>"
}
},
"privateIpv4Address": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The private IPv4 address for the network interface.</p>"
}
},
"ipv6Address": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The private IPv6 address for the network interface.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object representing the elastic network interface for tasks that use the\n\t\t\t\t<code>awsvpc</code> network mode.</p>"
}
},
"com.amazonaws.ecs#NetworkInterfaces": {
"type": "list",
"member": {
"target": "com.amazonaws.ecs#NetworkInterface"
}
},
"com.amazonaws.ecs#NetworkMode": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "bridge",
"name": "BRIDGE"
},
{
"value": "host",
"name": "HOST"
},
{
"value": "awsvpc",
"name": "AWSVPC"
},
{
"value": "none",
"name": "NONE"
}
]
}
},
"com.amazonaws.ecs#NoUpdateAvailableException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.ecs#String"
}
},
"traits": {
"smithy.api#documentation": "<p>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.</p>",
"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": "<p>The type of constraint. Use <code>distinctInstance</code> to ensure that each task in\n\t\t\ta particular group is running on a different container instance. Use\n\t\t\t\t<code>memberOf</code> to restrict the selection to a group of valid\n\t\t\tcandidates.</p>"
}
},
"expression": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>A cluster query language expression to apply to the constraint. You cannot specify an\n\t\t\texpression if the constraint type is <code>distinctInstance</code>. For more\n\t\t\tinformation, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html\">Cluster Query Language</a> in the\n\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object representing a constraint on task placement. For more information, see\n\t\t\t\t<a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html\">Task Placement Constraints</a> in the\n\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t <note>\n\t\t\t <p>If you are using the Fargate launch type, task placement constraints\n\t\t\t\tare not supported.</p>\n\t\t </note>"
}
},
"com.amazonaws.ecs#PlacementConstraintType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "distinctInstance",
"name": "DISTINCT_INSTANCE"
},
{
"value": "memberOf",
"name": "MEMBER_OF"
}
]
}
},
"com.amazonaws.ecs#PlacementConstraints": {
"type": "list",
"member": {
"target": "com.amazonaws.ecs#PlacementConstraint"
}
},
"com.amazonaws.ecs#PlacementStrategies": {
"type": "list",
"member": {
"target": "com.amazonaws.ecs#PlacementStrategy"
}
},
"com.amazonaws.ecs#PlacementStrategy": {
"type": "structure",
"members": {
"type": {
"target": "com.amazonaws.ecs#PlacementStrategyType",
"traits": {
"smithy.api#documentation": "<p>The type of placement strategy. The <code>random</code> placement strategy randomly\n\t\t\tplaces tasks on available candidates. The <code>spread</code> placement strategy spreads\n\t\t\tplacement across available candidates evenly based on the <code>field</code> parameter.\n\t\t\tThe <code>binpack</code> strategy places tasks on available candidates that have the\n\t\t\tleast available amount of the resource that is specified with the <code>field</code>\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).</p>"
}
},
"field": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The field to apply the placement strategy against. For the <code>spread</code>\n\t\t\tplacement strategy, valid values are <code>instanceId</code> (or <code>host</code>,\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 <code>attribute:ecs.availability-zone</code>. For the\n\t\t\t\t<code>binpack</code> placement strategy, valid values are <code>cpu</code> and\n\t\t\t\t<code>memory</code>. For the <code>random</code> placement strategy, this field is\n\t\t\tnot used.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The task placement strategy for a task or service. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html\">Task Placement Strategies</a> in the\n\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"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": "<p>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<code>/var/lib/ecs/gpu/nvidia_gpu_info.json</code> file.</p>",
"smithy.api#required": {}
}
},
"type": {
"target": "com.amazonaws.ecs#PlatformDeviceType",
"traits": {
"smithy.api#documentation": "<p>The type of device that is available on the container instance. The only supported\n\t\t\tvalue is <code>GPU</code>.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The devices that are available on the container instance. The only supported device\n\t\t\ttype is a GPU.</p>"
}
},
"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": "<p>The specified platform version does not satisfy the task definition's required\n\t\t\tcapabilities.</p>",
"smithy.api#error": "client"
}
},
"com.amazonaws.ecs#PlatformUnknownException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.ecs#String"
}
},
"traits": {
"smithy.api#documentation": "<p>The specified platform version does not exist.</p>",
"smithy.api#error": "client"
}
},
"com.amazonaws.ecs#PortMapping": {
"type": "structure",
"members": {
"containerPort": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>The port number on the container that is bound to the user-specified or automatically\n\t\t\tassigned host port.</p>\n\t\t <p>If you are using containers in a task with the <code>awsvpc</code> or\n\t\t\t\t<code>host</code> network mode, exposed ports should be specified using\n\t\t\t\t<code>containerPort</code>.</p>\n\t\t <p>If you are using containers in a task with the <code>bridge</code> 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\t<code>hostPort</code>. 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.</p>"
}
},
"hostPort": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>The port number on the container instance to reserve for your container.</p>\n\t\t <p>If you are using containers in a task with the <code>awsvpc</code> or\n\t\t\t\t<code>host</code> network mode, the <code>hostPort</code> can either be left blank\n\t\t\tor set to the same value as the <code>containerPort</code>.</p>\n\t\t <p>If you are using containers in a task with the <code>bridge</code> 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 <code>hostPort</code> (or set it to <code>0</code>) while specifying a\n\t\t\t\t<code>containerPort</code> 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.</p>\n\t\t <p>The default ephemeral port range for Docker version 1.6.0 and later is listed on the\n\t\t\tinstance under <code>/proc/sys/net/ipv4/ip_local_port_range</code>. 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.</p>\n\t\t <note>\n\t\t\t <p>The default ephemeral port range from 49153 through 65535 is always used for\n\t\t\t\tDocker versions before 1.6.0.</p>\n\t\t </note>\n\t\t <p>The 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\t<code>remainingResources</code> of <a>DescribeContainerInstances</a>\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.</p>"
}
},
"protocol": {
"target": "com.amazonaws.ecs#TransportProtocol",
"traits": {
"smithy.api#documentation": "<p>The protocol used for the port mapping. Valid values are <code>tcp</code> and\n\t\t\t\t<code>udp</code>. The default is <code>tcp</code>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>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.</p>\n\t\t <p>If you are using containers in a task with the <code>awsvpc</code> or\n\t\t\t\t<code>host</code> network mode, exposed ports should be specified using\n\t\t\t\t<code>containerPort</code>. The <code>hostPort</code> can be left blank or it must\n\t\t\tbe the same value as the <code>containerPort</code>.</p>\n\t\t <note>\n\t\t\t <p>You cannot expose the same container port for multiple protocols. An error will be\n\t\t\t\treturned if this is attempted</p>\n\t\t </note>\n\t\t <p>After a task reaches the <code>RUNNING</code> status, manual and automatic host and\n\t\t\tcontainer port assignments are visible in the <code>networkBindings</code> section of\n\t\t\t\t<a>DescribeTasks</a> API responses.</p>"
}
},
"com.amazonaws.ecs#PortMappingList": {
"type": "list",
"member": {
"target": "com.amazonaws.ecs#PortMapping"
}
},
"com.amazonaws.ecs#PropagateTags": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "TASK_DEFINITION",
"name": "TASK_DEFINITION"
},
{
"value": "SERVICE",
"name": "SERVICE"
}
]
}
},
"com.amazonaws.ecs#ProxyConfiguration": {
"type": "structure",
"members": {
"type": {
"target": "com.amazonaws.ecs#ProxyConfigurationType",
"traits": {
"smithy.api#documentation": "<p>The proxy type. The only supported value is <code>APPMESH</code>.</p>"
}
},
"containerName": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The name of the container that will serve as the App Mesh proxy.</p>",
"smithy.api#required": {}
}
},
"properties": {
"target": "com.amazonaws.ecs#ProxyConfigurationProperties",
"traits": {
"smithy.api#documentation": "<p>The set of network configuration parameters to provide the Container Network Interface\n\t\t\t(CNI) plugin, specified as key-value pairs.</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>\n <code>IgnoredUID</code> - (Required) The user ID (UID) of the proxy\n\t\t\t\t\tcontainer as defined by the <code>user</code> 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\t<code>IgnoredGID</code> is specified, this field can be empty.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <code>IgnoredGID</code> - (Required) The group ID (GID) of the proxy\n\t\t\t\t\tcontainer as defined by the <code>user</code> 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\t<code>IgnoredUID</code> is specified, this field can be empty.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <code>AppPorts</code> - (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\t<code>ProxyIngressPort</code> and <code>ProxyEgressPort</code>.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <code>ProxyIngressPort</code> - (Required) Specifies the port that\n\t\t\t\t\tincoming traffic to the <code>AppPorts</code> is directed to.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <code>ProxyEgressPort</code> - (Required) Specifies the port that\n\t\t\t\t\toutgoing traffic from the <code>AppPorts</code> is directed to.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <code>EgressIgnoredPorts</code> - (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\t<code>ProxyEgressPort</code>. It can be an empty list.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <code>EgressIgnoredIPs</code> - (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\t<code>ProxyEgressPort</code>. It can be an empty list.</p>\n\t\t\t </li>\n </ul>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The configuration details for the App Mesh proxy.</p>\n\t\t <p>For 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\t<code>ecs-init</code> package to enable a proxy configuration. If your container\n\t\t\tinstances are launched from the Amazon ECS-optimized AMI version <code>20190301</code> or\n\t\t\tlater, then they contain the required versions of the container agent and\n\t\t\t\t<code>ecs-init</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html\">Amazon ECS-optimized Linux AMI</a>\n\t\t </p>"
}
},
"com.amazonaws.ecs#ProxyConfigurationProperties": {
"type": "list",
"member": {
"target": "com.amazonaws.ecs#KeyValuePair"
}
},
"com.amazonaws.ecs#ProxyConfigurationType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "APPMESH",
"name": "APPMESH"
}
]
}
},
"com.amazonaws.ecs#PutAccountSetting": {
"type": "operation",
"input": {
"target": "com.amazonaws.ecs#PutAccountSettingRequest"
},
"output": {
"target": "com.amazonaws.ecs#PutAccountSettingResponse"
},
"errors": [
{
"target": "com.amazonaws.ecs#ClientException"
},
{
"target": "com.amazonaws.ecs#InvalidParameterException"
},
{
"target": "com.amazonaws.ecs#ServerException"
}
],
"traits": {
"smithy.api#documentation": "<p>Modifies an account setting. Account settings are set on a per-Region basis.</p>\n\t\t <p>If 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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html\">Account\n\t\t\t\tSettings</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t <p>When <code>serviceLongArnFormat</code>, <code>taskLongArnFormat</code>, or\n\t\t\t\t<code>containerInstanceLongArnFormat</code> 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.</p>\n\t\t <p>When <code>awsvpcTrunking</code> 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\t<code>awsvpcTrunking</code> 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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-eni.html\">Elastic Network\n\t\t\t\tInterface Trunking</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t <p>When <code>containerInsights</code> 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\t<code>containerInsights</code> 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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html\">CloudWatch\n\t\t\t\tContainer Insights</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"com.amazonaws.ecs#PutAccountSettingDefault": {
"type": "operation",
"input": {
"target": "com.amazonaws.ecs#PutAccountSettingDefaultRequest"
},
"output": {
"target": "com.amazonaws.ecs#PutAccountSettingDefaultResponse"
},
"errors": [
{
"target": "com.amazonaws.ecs#ClientException"
},
{
"target": "com.amazonaws.ecs#InvalidParameterException"
},
{
"target": "com.amazonaws.ecs#ServerException"
}
],
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"com.amazonaws.ecs#PutAccountSettingDefaultRequest": {
"type": "structure",
"members": {
"name": {
"target": "com.amazonaws.ecs#SettingName",
"traits": {
"smithy.api#documentation": "<p>The resource name for which to modify the account setting. If\n\t\t\t\t<code>serviceLongArnFormat</code> is specified, the ARN for your Amazon ECS services is\n\t\t\taffected. If <code>taskLongArnFormat</code> is specified, the ARN and resource ID for\n\t\t\tyour Amazon ECS tasks is affected. If <code>containerInstanceLongArnFormat</code> is\n\t\t\tspecified, the ARN and resource ID for your Amazon ECS container instances is affected. If\n\t\t\t\t<code>awsvpcTrunking</code> is specified, the ENI limit for your Amazon ECS container\n\t\t\tinstances is affected. If <code>containerInsights</code> is specified, the default\n\t\t\tsetting for CloudWatch Container Insights for your clusters is affected.</p>",
"smithy.api#required": {}
}
},
"value": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The account setting value for the specified principal ARN. Accepted values are\n\t\t\t\t<code>enabled</code> and <code>disabled</code>.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.ecs#PutAccountSettingDefaultResponse": {
"type": "structure",
"members": {
"setting": {
"target": "com.amazonaws.ecs#Setting",
"traits": {
"smithy.api#documentation": "<p>The current setting for a resource.</p>"
}
}
}
},
"com.amazonaws.ecs#PutAccountSettingRequest": {
"type": "structure",
"members": {
"name": {
"target": "com.amazonaws.ecs#SettingName",
"traits": {
"smithy.api#documentation": "<p>The Amazon ECS resource name for which to modify the account setting. If\n\t\t\t\t<code>serviceLongArnFormat</code> is specified, the ARN for your Amazon ECS services is\n\t\t\taffected. If <code>taskLongArnFormat</code> is specified, the ARN and resource ID for\n\t\t\tyour Amazon ECS tasks is affected. If <code>containerInstanceLongArnFormat</code> is\n\t\t\tspecified, the ARN and resource ID for your Amazon ECS container instances is affected. If\n\t\t\t\t<code>awsvpcTrunking</code> is specified, the elastic network interface (ENI) limit\n\t\t\tfor your Amazon ECS container instances is affected. If <code>containerInsights</code> is\n\t\t\tspecified, the default setting for CloudWatch Container Insights for your clusters is\n\t\t\taffected.</p>",
"smithy.api#required": {}
}
},
"value": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The account setting value for the specified principal ARN. Accepted values are\n\t\t\t\t<code>enabled</code> and <code>disabled</code>.</p>",
"smithy.api#required": {}
}
},
"principalArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>\n\t\t <note>\n\t\t\t <p>Federated users assume the account setting of the root user and can't have\n\t\t\t\texplicit account settings set for them.</p>\n\t\t </note>"
}
}
}
},
"com.amazonaws.ecs#PutAccountSettingResponse": {
"type": "structure",
"members": {
"setting": {
"target": "com.amazonaws.ecs#Setting",
"traits": {
"smithy.api#documentation": "<p>The current account setting for a resource.</p>"
}
}
}
},
"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": "<p>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 <a>DeleteAttributes</a>. For more information,\n\t\t\tsee <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes\">Attributes</a> in the\n\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"com.amazonaws.ecs#PutAttributesRequest": {
"type": "structure",
"members": {
"cluster": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"attributes": {
"target": "com.amazonaws.ecs#Attributes",
"traits": {
"smithy.api#documentation": "<p>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.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.ecs#PutAttributesResponse": {
"type": "structure",
"members": {
"attributes": {
"target": "com.amazonaws.ecs#Attributes",
"traits": {
"smithy.api#documentation": "<p>The attributes applied to your resource.</p>"
}
}
}
},
"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": "<p>Modifies the available capacity providers and the default capacity provider strategy\n\t\t\tfor a cluster.</p>\n\t\t <p>You 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 <a>PutClusterCapacityProviders</a> 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.</p>\n\t\t <p>When 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 (<code>[]</code>) to bypass defining a default\n\t\t\tstrategy.</p>"
}
},
"com.amazonaws.ecs#PutClusterCapacityProvidersRequest": {
"type": "structure",
"members": {
"cluster": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>",
"smithy.api#required": {}
}
},
"capacityProviders": {
"target": "com.amazonaws.ecs#StringList",
"traits": {
"smithy.api#documentation": "<p>The name of one or more capacity providers to associate with the cluster.</p>\n\t\t <p>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 <a>CreateCapacityProvider</a> API operation.</p>\n\t\t <p>To use a AWS Fargate capacity provider, specify either the <code>FARGATE</code> or\n\t\t\t\t<code>FARGATE_SPOT</code> 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.</p>",
"smithy.api#required": {}
}
},
"defaultCapacityProviderStrategy": {
"target": "com.amazonaws.ecs#CapacityProviderStrategy",
"traits": {
"smithy.api#documentation": "<p>The capacity provider strategy to use by default for the cluster.</p>\n\t\t <p>When 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.</p>\n\t\t <p>A capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\t<code>base</code> and <code>weight</code> 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\t<a>PutClusterCapacityProviders</a> API is used to associate a capacity\n\t\t\tprovider with a cluster. Only capacity providers with an <code>ACTIVE</code> or\n\t\t\t\t<code>UPDATING</code> status can be used.</p>\n\t\t <p>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 <a>CreateCapacityProvider</a> API operation.</p>\n\t\t <p>To use a AWS Fargate capacity provider, specify either the <code>FARGATE</code> or\n\t\t\t\t<code>FARGATE_SPOT</code> 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.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.ecs#PutClusterCapacityProvidersResponse": {
"type": "structure",
"members": {
"cluster": {
"target": "com.amazonaws.ecs#Cluster",
"traits": {
"smithy.api#documentation": "<p>Details about the cluster.</p>"
}
}
}
},
"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": "<note>\n <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p>\n </note> \n <p>Registers an EC2\n\t\t\tinstance into the specified cluster. This instance becomes available to place containers\n\t\t\ton.</p>"
}
},
"com.amazonaws.ecs#RegisterContainerInstanceRequest": {
"type": "structure",
"members": {
"cluster": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"instanceIdentityDocument": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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: <code>curl\n\t\t\t\thttp://169.254.169.254/latest/dynamic/instance-identity/document/</code>\n\t\t </p>"
}
},
"instanceIdentityDocumentSignature": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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: <code>curl\n\t\t\t\thttp://169.254.169.254/latest/dynamic/instance-identity/signature/</code>\n\t\t </p>"
}
},
"totalResources": {
"target": "com.amazonaws.ecs#Resources",
"traits": {
"smithy.api#documentation": "<p>The resources available on the instance.</p>"
}
},
"versionInfo": {
"target": "com.amazonaws.ecs#VersionInfo",
"traits": {
"smithy.api#documentation": "<p>The version information for the Amazon ECS container agent and Docker daemon running on the\n\t\t\tcontainer instance.</p>"
}
},
"containerInstanceArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The ARN of the container instance (if it was previously registered).</p>"
}
},
"attributes": {
"target": "com.amazonaws.ecs#Attributes",
"traits": {
"smithy.api#documentation": "<p>The container instance attributes that this container instance supports.</p>"
}
},
"platformDevices": {
"target": "com.amazonaws.ecs#PlatformDevices",
"traits": {
"smithy.api#documentation": "<p>The devices that are available on the container instance. The only supported device\n\t\t\ttype is a GPU.</p>"
}
},
"tags": {
"target": "com.amazonaws.ecs#Tags",
"traits": {
"smithy.api#documentation": "<p>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.</p> \n <p>The following basic restrictions apply to tags:</p>\n <ul>\n <li>\n <p>Maximum number of tags per resource - 50</p>\n </li>\n <li>\n <p>For each resource, each tag key must be unique, and each tag key can have only\n one value.</p>\n </li>\n <li>\n <p>Maximum key length - 128 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>Maximum value length - 256 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>If 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: + - = . _ : / @.</p>\n </li>\n <li>\n <p>Tag keys and values are case-sensitive.</p>\n </li>\n <li>\n <p>Do not use <code>aws:</code>, <code>AWS:</code>, 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.</p>\n </li>\n </ul>"
}
}
}
},
"com.amazonaws.ecs#RegisterContainerInstanceResponse": {
"type": "structure",
"members": {
"containerInstance": {
"target": "com.amazonaws.ecs#ContainerInstance",
"traits": {
"smithy.api#documentation": "<p>The container instance that was registered.</p>"
}
}
}
},
"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": "<p>Registers a new task definition from the supplied <code>family</code> and\n\t\t\t\t<code>containerDefinitions</code>. Optionally, you can add data volumes to your\n\t\t\tcontainers with the <code>volumes</code> parameter. For more information about task\n\t\t\tdefinition parameters and defaults, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html\">Amazon ECS Task\n\t\t\t\tDefinitions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t <p>You can specify an IAM role for your task with the <code>taskRoleArn</code> 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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html\">IAM\n\t\t\t\tRoles for Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t <p>You can specify a Docker networking mode for the containers in your task definition\n\t\t\twith the <code>networkMode</code> parameter. The available network modes correspond to\n\t\t\tthose described in <a href=\"https://docs.docker.com/engine/reference/run/#/network-settings\">Network\n\t\t\t\tsettings</a> in the Docker run reference. If you specify the <code>awsvpc</code>\n\t\t\tnetwork mode, the task is allocated an elastic network interface, and you must specify a\n\t\t\t\t<a>NetworkConfiguration</a> when you create a service or run a task with\n\t\t\tthe task definition. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html\">Task Networking</a>\n\t\t\tin the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"com.amazonaws.ecs#RegisterTaskDefinitionRequest": {
"type": "structure",
"members": {
"family": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>You must specify a <code>family</code> for a task definition, which allows you to\n\t\t\ttrack multiple versions of the same task definition. The <code>family</code> 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.</p>",
"smithy.api#required": {}
}
},
"taskRoleArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html\">IAM Roles for\n\t\t\t\tTasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"executionRoleArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html\">Amazon ECS task\n execution IAM role</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"networkMode": {
"target": "com.amazonaws.ecs#NetworkMode",
"traits": {
"smithy.api#documentation": "<p>The Docker networking mode to use for the containers in the task. The valid values are\n <code>none</code>, <code>bridge</code>, <code>awsvpc</code>, and <code>host</code>.\n If no network mode is specified, the default is <code>bridge</code>.</p>\n <p>For Amazon ECS tasks on Fargate, the <code>awsvpc</code> 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 <code>none</code>, you cannot specify port mappings in your container\n definitions, and the tasks containers do not have external connectivity. The\n <code>host</code> and <code>awsvpc</code> 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 <code>bridge</code> mode.</p>\n <p>With the <code>host</code> and <code>awsvpc</code> network modes, exposed container\n ports are mapped directly to the corresponding host port (for the <code>host</code>\n network mode) or the attached elastic network interface port (for the\n <code>awsvpc</code> network mode), so you cannot take advantage of dynamic host port\n mappings. </p>\n <important>\n <p>When using the <code>host</code> 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.</p>\n </important>\n <p>If the network mode is <code>awsvpc</code>, the task is allocated an elastic network\n interface, and you must specify a <a>NetworkConfiguration</a> value when you create\n a service or run a task with the task definition. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html\">Task Networking</a> in the\n <i>Amazon Elastic Container Service Developer Guide</i>.</p>\n <note>\n <p>Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the\n <code>ecs-init</code> package, or AWS Fargate infrastructure support the\n <code>awsvpc</code> network mode. </p>\n </note>\n <p>If the network mode is <code>host</code>, you cannot run multiple instantiations of the\n same task on a single container instance when port mappings are used.</p>\n <p>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 <code><default></code> network mode object. </p>\n <p>For more information, see <a href=\"https://docs.docker.com/engine/reference/run/#network-settings\">Network\n settings</a> in the <i>Docker run reference</i>.</p>"
}
},
"containerDefinitions": {
"target": "com.amazonaws.ecs#ContainerDefinitions",
"traits": {
"smithy.api#documentation": "<p>A list of container definitions in JSON format that describe the different containers\n\t\t\tthat make up your task.</p>",
"smithy.api#required": {}
}
},
"volumes": {
"target": "com.amazonaws.ecs#VolumeList",
"traits": {
"smithy.api#documentation": "<p>A list of volume definitions in JSON format that containers in your task may\n\t\t\tuse.</p>"
}
},
"placementConstraints": {
"target": "com.amazonaws.ecs#TaskDefinitionPlacementConstraints",
"traits": {
"smithy.api#documentation": "<p>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).</p>"
}
},
"requiresCompatibilities": {
"target": "com.amazonaws.ecs#CompatibilityList",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"cpu": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The number of CPU units used by the task. It can be expressed as an integer using CPU\n\t\t\tunits, for example <code>1024</code>, or as a string using vCPUs, for example <code>1\n\t\t\t\tvCPU</code> or <code>1 vcpu</code>, 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.</p>\n\t\t <note>\n\t\t\t <p>Task-level CPU and memory parameters are ignored for Windows containers. We\n\t\t\t\trecommend specifying container-level resources for Windows containers.</p>\n\t\t </note>\n\t\t <p>If you are using the EC2 launch type, this field is optional. Supported\n\t\t\tvalues are between <code>128</code> CPU units (<code>0.125</code> vCPUs) and\n\t\t\t\t<code>10240</code> CPU units (<code>10</code> vCPUs).</p>\n\t\t <p>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 <code>memory</code> parameter:</p> \n <ul>\n <li>\n <p>256 (.25 vCPU) - Available <code>memory</code> values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)</p>\n </li>\n <li>\n <p>512 (.5 vCPU) - Available <code>memory</code> values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)</p>\n </li>\n <li>\n <p>1024 (1 vCPU) - Available <code>memory</code> values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)</p>\n </li>\n <li>\n <p>2048 (2 vCPU) - Available <code>memory</code> values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)</p>\n </li>\n <li>\n <p>4096 (4 vCPU) - Available <code>memory</code> values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)</p>\n </li>\n </ul>"
}
},
"memory": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The amount of memory (in MiB) used by the task. It can be expressed as an integer\n\t\t\tusing MiB, for example <code>1024</code>, or as a string using GB, for example\n\t\t\t\t<code>1GB</code> or <code>1 GB</code>, 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.</p>\n\t\t <note>\n\t\t\t <p>Task-level CPU and memory parameters are ignored for Windows containers. We\n\t\t\t\trecommend specifying container-level resources for Windows containers.</p>\n\t\t </note>\n\t\t <p>If using the EC2 launch type, this field is optional.</p>\n\t\t <p>If 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\t<code>cpu</code> parameter:</p> \n <ul>\n <li>\n <p>512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available <code>cpu</code> values: 256 (.25 vCPU)</p>\n </li>\n <li>\n <p>1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available <code>cpu</code> values: 512 (.5 vCPU)</p>\n </li>\n <li>\n <p>2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available <code>cpu</code> values: 1024 (1 vCPU)</p>\n </li>\n <li>\n <p>Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available <code>cpu</code> values: 2048 (2 vCPU)</p>\n </li>\n <li>\n <p>Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available <code>cpu</code> values: 4096 (4 vCPU)</p>\n </li>\n </ul>"
}
},
"tags": {
"target": "com.amazonaws.ecs#Tags",
"traits": {
"smithy.api#documentation": "<p>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.</p>\n\t\t <p>The following basic restrictions apply to tags:</p>\n <ul>\n <li>\n <p>Maximum number of tags per resource - 50</p>\n </li>\n <li>\n <p>For each resource, each tag key must be unique, and each tag key can have only\n one value.</p>\n </li>\n <li>\n <p>Maximum key length - 128 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>Maximum value length - 256 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>If 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: + - = . _ : / @.</p>\n </li>\n <li>\n <p>Tag keys and values are case-sensitive.</p>\n </li>\n <li>\n <p>Do not use <code>aws:</code>, <code>AWS:</code>, 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.</p>\n </li>\n </ul>"
}
},
"pidMode": {
"target": "com.amazonaws.ecs#PidMode",
"traits": {
"smithy.api#documentation": "<p>The process namespace to use for the containers in the task. The valid\n values are <code>host</code> or <code>task</code>. If <code>host</code>\n is specified, then all containers within the tasks that specified the\n <code>host</code> PID mode on the same container instance share the\n same process namespace with the host Amazon EC2 instance. If <code>task</code> 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 <a href=\"https://docs.docker.com/engine/reference/run/#pid-settings---pid\">PID settings</a> in the <i>Docker run\n reference</i>.</p>\n <p>If the <code>host</code> PID mode is used, be aware that there is a\n heightened risk of undesired process namespace expose. For more\n information, see <a href=\"https://docs.docker.com/engine/security/security/\">Docker\n security</a>.</p> \n <note>\n <p>This parameter is not supported for Windows containers or tasks run on AWS Fargate.</p>\n </note>"
}
},
"ipcMode": {
"target": "com.amazonaws.ecs#IpcMode",
"traits": {
"smithy.api#documentation": "<p>The IPC resource namespace to use for the containers in the task. The valid values are\n <code>host</code>, <code>task</code>, or <code>none</code>. If <code>host</code> is\n specified, then all containers within the tasks that specified the <code>host</code> IPC\n mode on the same container instance share the same IPC resources with the host Amazon EC2\n instance. If <code>task</code> is specified, all containers within the specified task\n share the same IPC resources. If <code>none</code> 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 <a href=\"https://docs.docker.com/engine/reference/run/#ipc-settings---ipc\">IPC\n settings</a> in the <i>Docker run reference</i>.</p>\n <p>If the <code>host</code> IPC mode is used, be aware that there is a heightened risk of\n undesired IPC namespace expose. For more information, see <a href=\"https://docs.docker.com/engine/security/security/\">Docker\n security</a>.</p>\n <p>If you are setting namespaced kernel parameters using <code>systemControls</code> for\n the containers in the task, the following will apply to your IPC resource namespace. For\n more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html\">System\n Controls</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>\n <ul>\n <li>\n <p>For tasks that use the <code>host</code> IPC mode, IPC namespace related\n <code>systemControls</code> are not supported.</p>\n </li>\n <li>\n <p>For tasks that use the <code>task</code> IPC mode, IPC namespace related\n <code>systemControls</code> will apply to all containers within a\n task.</p>\n </li>\n </ul> \n <note>\n <p>This parameter is not supported for Windows containers or tasks run on AWS Fargate.</p>\n </note>"
}
},
"proxyConfiguration": {
"target": "com.amazonaws.ecs#ProxyConfiguration",
"traits": {
"smithy.api#documentation": "<p>The configuration details for the App Mesh proxy.</p>\n\t\t <p>For tasks hosted on Amazon EC2 instances, the container instances require at least version\n\t\t\t\t<code>1.26.0</code> of the container agent and at least version\n\t\t\t\t<code>1.26.0-1</code> of the <code>ecs-init</code> 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 <code>20190301</code> or later, then they contain the required versions of\n\t\t\tthe container agent and <code>ecs-init</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-ami-versions.html\">Amazon ECS-optimized AMI versions</a> in the\n\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"inferenceAccelerators": {
"target": "com.amazonaws.ecs#InferenceAccelerators",
"traits": {
"smithy.api#documentation": "<p>The Elastic Inference accelerators to use for the containers in the task.</p>"
}
},
"ephemeralStorage": {
"target": "com.amazonaws.ecs#EphemeralStorage",
"traits": {
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html\">Fargate task\n\t\t\t\tstorage</a> in the <i>Amazon ECS User Guide for AWS Fargate</i>.</p>\n\t\t <note>\n\t\t\t <p>This parameter is only supported for tasks hosted on AWS Fargate using platform\n\t\t\t\tversion <code>1.4.0</code> or later.</p>\n\t\t </note>"
}
}
}
},
"com.amazonaws.ecs#RegisterTaskDefinitionResponse": {
"type": "structure",
"members": {
"taskDefinition": {
"target": "com.amazonaws.ecs#TaskDefinition",
"traits": {
"smithy.api#documentation": "<p>The full description of the registered task definition.</p>"
}
},
"tags": {
"target": "com.amazonaws.ecs#Tags",
"traits": {
"smithy.api#documentation": "<p>The list of tags associated with the task definition.</p>"
}
}
}
},
"com.amazonaws.ecs#RepositoryCredentials": {
"type": "structure",
"members": {
"credentialsParameter": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the secret containing the private repository\n\t\t\tcredentials.</p>\n\t\t <note>\n\t\t\t <p>When 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.</p>\n\t\t </note>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The repository credentials for private registry authentication.</p>"
}
},
"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": "<p>The name of the resource, such as <code>CPU</code>, <code>MEMORY</code>,\n\t\t\t\t<code>PORTS</code>, <code>PORTS_UDP</code>, or a user-defined resource.</p>"
}
},
"type": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The type of the resource, such as <code>INTEGER</code>, <code>DOUBLE</code>,\n\t\t\t\t<code>LONG</code>, or <code>STRINGSET</code>.</p>"
}
},
"doubleValue": {
"target": "com.amazonaws.ecs#Double",
"traits": {
"smithy.api#documentation": "<p>When the <code>doubleValue</code> type is set, the value of the resource must be a\n\t\t\tdouble precision floating-point type.</p>"
}
},
"longValue": {
"target": "com.amazonaws.ecs#Long",
"traits": {
"smithy.api#documentation": "<p>When the <code>longValue</code> type is set, the value of the resource must be an\n\t\t\textended precision floating-point type.</p>"
}
},
"integerValue": {
"target": "com.amazonaws.ecs#Integer",
"traits": {
"smithy.api#documentation": "<p>When the <code>integerValue</code> type is set, the value of the resource must be an\n\t\t\tinteger.</p>"
}
},
"stringSetValue": {
"target": "com.amazonaws.ecs#StringList",
"traits": {
"smithy.api#documentation": "<p>When the <code>stringSetValue</code> type is set, the value of the resource must be a\n\t\t\tstring type.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Describes the resources available for a container instance.</p>"
}
},
"com.amazonaws.ecs#ResourceInUseException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.ecs#String"
}
},
"traits": {
"smithy.api#documentation": "<p>The specified resource is in-use and cannot be removed.</p>",
"smithy.api#error": "client"
}
},
"com.amazonaws.ecs#ResourceNotFoundException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.ecs#String"
}
},
"traits": {
"smithy.api#documentation": "<p>The specified resource could not be found.</p>",
"smithy.api#error": "client"
}
},
"com.amazonaws.ecs#ResourceRequirement": {
"type": "structure",
"members": {
"value": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The value for the specified resource type.</p>\n\t\t <p>If the <code>GPU</code> type is used, the value is the number of physical\n\t\t\t\t<code>GPUs</code> 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.</p>\n\t\t <p>If the <code>InferenceAccelerator</code> type is used, the <code>value</code> should\n\t\t\tmatch the <code>deviceName</code> for an <a>InferenceAccelerator</a>\n\t\t\tspecified in a task definition.</p>",
"smithy.api#required": {}
}
},
"type": {
"target": "com.amazonaws.ecs#ResourceType",
"traits": {
"smithy.api#documentation": "<p>The type of resource to assign to a container. The supported values are\n\t\t\t\t<code>GPU</code> or <code>InferenceAccelerator</code>.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html\">Working with\n\t\t\t\tGPUs on Amazon ECS</a> or <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-eia.html\">Working with Amazon Elastic Inference on Amazon ECS</a> in the\n\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>\n </p>"
}
},
"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": "<p>Starts a new task using the specified task definition.</p>\n\t\t <p>You 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\t<a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html\">Scheduling Tasks</a> in the\n\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t <p>Alternatively, you can use <a>StartTask</a> to use your own scheduler or\n\t\t\tplace tasks manually on specific container instances.</p>\n\t\t <p>The 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.</p>\n\t\t <p>To manage eventual consistency, you can do the following:</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>Confirm 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.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>Add 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.</p>\n\t\t\t </li>\n </ul>"
}
},
"com.amazonaws.ecs#RunTaskRequest": {
"type": "structure",
"members": {
"capacityProviderStrategy": {
"target": "com.amazonaws.ecs#CapacityProviderStrategy",
"traits": {
"smithy.api#documentation": "<p>The capacity provider strategy to use for the task.</p>\n\t\t <p>If a <code>capacityProviderStrategy</code> is specified, the <code>launchType</code>\n\t\t\tparameter must be omitted. If no <code>capacityProviderStrategy</code> or\n\t\t\t\t<code>launchType</code> is specified, the\n\t\t\t\t<code>defaultCapacityProviderStrategy</code> for the cluster is used.</p>"
}
},
"cluster": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"count": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"enableECSManagedTags": {
"target": "com.amazonaws.ecs#Boolean",
"traits": {
"smithy.api#documentation": "<p>Specifies whether to enable Amazon ECS managed tags for the task. For more information, see\n\t\t\t\t<a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html\">Tagging Your Amazon ECS\n\t\t\t\tResources</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"enableExecuteCommand": {
"target": "com.amazonaws.ecs#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether or not to enable the execute command functionality for the containers in this\n\t\t\ttask. If <code>true</code>, this enables execute command functionality on all containers\n\t\t\tin the task.</p>"
}
},
"group": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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).</p>"
}
},
"launchType": {
"target": "com.amazonaws.ecs#LaunchType",
"traits": {
"smithy.api#documentation": "<p>The launch type on which to run your task. The accepted values are\n\t\t\t\t<code>FARGATE</code> and <code>EC2</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html\">Amazon ECS\n\t\t\t\tLaunch Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t <p>When a value of <code>FARGATE</code> 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 <code>FARGATE_SPOT</code> capacity provider.</p>\n\t\t <p>When a value of <code>EC2</code> is specified, your tasks are launched on Amazon EC2\n\t\t\tinstances registered to your cluster.</p>\n\t\t <p>If a <code>launchType</code> is specified, the <code>capacityProviderStrategy</code>\n\t\t\tparameter must be omitted.</p>"
}
},
"networkConfiguration": {
"target": "com.amazonaws.ecs#NetworkConfiguration",
"traits": {
"smithy.api#documentation": "<p>The network configuration for the task. This parameter is required for task\n\t\t\tdefinitions that use the <code>awsvpc</code> 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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html\">Task Networking</a>\n\t\t\tin the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"overrides": {
"target": "com.amazonaws.ecs#TaskOverride",
"traits": {
"smithy.api#documentation": "<p>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 <code>command</code> 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 <code>environment</code> override.</p>\n\t\t <note>\n\t\t\t <p>A total of 8192 characters are allowed for overrides. This limit includes the JSON\n\t\t\t\tformatting characters of the override structure.</p>\n\t\t </note>"
}
},
"placementConstraints": {
"target": "com.amazonaws.ecs#PlacementConstraints",
"traits": {
"smithy.api#documentation": "<p>An 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).</p>"
}
},
"placementStrategy": {
"target": "com.amazonaws.ecs#PlacementStrategies",
"traits": {
"smithy.api#documentation": "<p>The placement strategy objects to use for the task. You can specify a maximum of five\n\t\t\tstrategy rules per task.</p>"
}
},
"platformVersion": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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\t<code>LATEST</code> platform version is used by default. For more information, see\n\t\t\t\t<a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">AWS Fargate Platform\n\t\t\t\tVersions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"propagateTags": {
"target": "com.amazonaws.ecs#PropagateTags",
"traits": {
"smithy.api#documentation": "<p>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 <a>TagResource</a> API action.</p>\n\t\t <note>\n\t\t\t <p>An error will be received if you specify the <code>SERVICE</code> option when\n\t\t\t\trunning a task.</p>\n\t\t </note>"
}
},
"referenceId": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The reference ID to use for the task.</p>"
}
},
"startedBy": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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 <code>startedBy</code> parameter. You can then identify which\n\t\t\ttasks belong to that job by filtering the results of a <a>ListTasks</a> call\n\t\t\twith the <code>startedBy</code> value. Up to 36 letters (uppercase and lowercase),\n\t\t\tnumbers, hyphens, and underscores are allowed.</p>\n\t\t <p>If a task is started by an Amazon ECS service, then the <code>startedBy</code> parameter\n\t\t\tcontains the deployment ID of the service that starts it.</p>"
}
},
"tags": {
"target": "com.amazonaws.ecs#Tags",
"traits": {
"smithy.api#documentation": "<p>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.</p>\n\t\t <p>The following basic restrictions apply to tags:</p>\n <ul>\n <li>\n <p>Maximum number of tags per resource - 50</p>\n </li>\n <li>\n <p>For each resource, each tag key must be unique, and each tag key can have only\n one value.</p>\n </li>\n <li>\n <p>Maximum key length - 128 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>Maximum value length - 256 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>If 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: + - = . _ : / @.</p>\n </li>\n <li>\n <p>Tag keys and values are case-sensitive.</p>\n </li>\n <li>\n <p>Do not use <code>aws:</code>, <code>AWS:</code>, 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.</p>\n </li>\n </ul>"
}
},
"taskDefinition": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or\n\t\t\tfull ARN of the task definition to run. If a <code>revision</code> is not specified,\n\t\t\tthe latest <code>ACTIVE</code> revision is used.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.ecs#RunTaskResponse": {
"type": "structure",
"members": {
"tasks": {
"target": "com.amazonaws.ecs#Tasks",
"traits": {
"smithy.api#documentation": "<p>A full description of the tasks that were run. The tasks that were successfully placed\n\t\t\ton your cluster are described here.</p>"
}
},
"failures": {
"target": "com.amazonaws.ecs#Failures",
"traits": {
"smithy.api#documentation": "<p>Any failures associated with the call.</p>"
}
}
}
},
"com.amazonaws.ecs#Scale": {
"type": "structure",
"members": {
"value": {
"target": "com.amazonaws.ecs#Double",
"traits": {
"smithy.api#documentation": "<p>The value, specified as a percent total of a service's <code>desiredCount</code>, to\n\t\t\tscale the task set. Accepted values are numbers between 0 and 100.</p>"
}
},
"unit": {
"target": "com.amazonaws.ecs#ScaleUnit",
"traits": {
"smithy.api#documentation": "<p>The unit of measure for the scale value.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A floating-point percentage of the desired number of tasks to place and keep running\n\t\t\tin the task set.</p>"
}
},
"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": "<p>The name of the secret.</p>",
"smithy.api#required": {}
}
},
"valueFrom": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>\n\t\t <note>\n\t\t\t <p>If 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.</p>\n\t\t </note>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object representing the secret to expose to your container. Secrets can be exposed\n\t\t\tto a container in the following ways:</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>To inject sensitive data into your containers as environment variables, use\n\t\t\t\t\tthe <code>secrets</code> container definition parameter.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>To reference sensitive information in the log configuration of a container,\n\t\t\t\t\tuse the <code>secretOptions</code> container definition parameter.</p>\n\t\t\t </li>\n </ul>\n\t\t <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html\">Specifying\n\t\t\t\tSensitive Data</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"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": "<p>These errors are usually caused by a server issue.</p>",
"smithy.api#error": "server"
}
},
"com.amazonaws.ecs#Service": {
"type": "structure",
"members": {
"serviceArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The ARN that identifies the service. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the Region of the service, the AWS account ID of the service owner, the <code>service</code> namespace, and then the service name. For example, <code>arn:aws:ecs:region:012345678910:service/my-service</code>.</p>"
}
},
"serviceName": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"clusterArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the cluster that hosts the service.</p>"
}
},
"loadBalancers": {
"target": "com.amazonaws.ecs#LoadBalancers",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"serviceRegistries": {
"target": "com.amazonaws.ecs#ServiceRegistries",
"traits": {
"smithy.api#documentation": "<p>The details of the service discovery registries to assign to this service. For more\n\t\t\tinformation, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html\">Service\n\t\t\t\tDiscovery</a>.</p>"
}
},
"status": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The status of the service. The valid values are <code>ACTIVE</code>,\n\t\t\t\t<code>DRAINING</code>, or <code>INACTIVE</code>.</p>"
}
},
"desiredCount": {
"target": "com.amazonaws.ecs#Integer",
"traits": {
"smithy.api#documentation": "<p>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 <a>CreateService</a>, and it can be modified with <a>UpdateService</a>.</p>"
}
},
"runningCount": {
"target": "com.amazonaws.ecs#Integer",
"traits": {
"smithy.api#documentation": "<p>The number of tasks in the cluster that are in the <code>RUNNING</code> state.</p>"
}
},
"pendingCount": {
"target": "com.amazonaws.ecs#Integer",
"traits": {
"smithy.api#documentation": "<p>The number of tasks in the cluster that are in the <code>PENDING</code> state.</p>"
}
},
"launchType": {
"target": "com.amazonaws.ecs#LaunchType",
"traits": {
"smithy.api#documentation": "<p>The launch type on which your service is running. If no value is specified, it will\n\t\t\tdefault to <code>EC2</code>. Valid values include <code>EC2</code> and\n\t\t\t\t<code>FARGATE</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html\">Amazon ECS\n\t\t\t\tLaunch Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"capacityProviderStrategy": {
"target": "com.amazonaws.ecs#CapacityProviderStrategy",
"traits": {
"smithy.api#documentation": "<p>The capacity provider strategy associated with the service.</p>"
}
},
"platformVersion": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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 <code>LATEST</code> platform version is used by default. For more\n\t\t\tinformation, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">AWS Fargate Platform\n\t\t\t\tVersions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"taskDefinition": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The task definition to use for tasks in the service. This value is specified when the\n\t\t\tservice is created with <a>CreateService</a>, and it can be modified with\n\t\t\t\t<a>UpdateService</a>.</p>"
}
},
"deploymentConfiguration": {
"target": "com.amazonaws.ecs#DeploymentConfiguration",
"traits": {
"smithy.api#documentation": "<p>Optional deployment parameters that control how many tasks run during the deployment\n\t\t\tand the ordering of stopping and starting tasks.</p>"
}
},
"taskSets": {
"target": "com.amazonaws.ecs#TaskSets",
"traits": {
"smithy.api#documentation": "<p>Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an <code>EXTERNAL</code>\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.</p>"
}
},
"deployments": {
"target": "com.amazonaws.ecs#Deployments",
"traits": {
"smithy.api#documentation": "<p>The current state of deployments for the service.</p>"
}
},
"roleArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"events": {
"target": "com.amazonaws.ecs#ServiceEvents",
"traits": {
"smithy.api#documentation": "<p>The event stream for your service. A maximum of 100 of the latest events are\n\t\t\tdisplayed.</p>"
}
},
"createdAt": {
"target": "com.amazonaws.ecs#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The Unix timestamp for when the service was created.</p>"
}
},
"placementConstraints": {
"target": "com.amazonaws.ecs#PlacementConstraints",
"traits": {
"smithy.api#documentation": "<p>The placement constraints for the tasks in the service.</p>"
}
},
"placementStrategy": {
"target": "com.amazonaws.ecs#PlacementStrategies",
"traits": {
"smithy.api#documentation": "<p>The placement strategy that determines how tasks for the service are placed.</p>"
}
},
"networkConfiguration": {
"target": "com.amazonaws.ecs#NetworkConfiguration",
"traits": {
"smithy.api#documentation": "<p>The VPC subnet and security group configuration for tasks that receive their own\n elastic network interface by using the <code>awsvpc</code> networking mode.</p>"
}
},
"healthCheckGracePeriodSeconds": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"schedulingStrategy": {
"target": "com.amazonaws.ecs#SchedulingStrategy",
"traits": {
"smithy.api#documentation": "<p>The scheduling strategy to use for the service. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html\">Services</a>.</p>\n\t\t <p>There are two service scheduler strategies available:</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>\n <code>REPLICA</code>-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.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <code>DAEMON</code>-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.</p>\n\t\t\t\t <note>\n\t\t\t\t\t <p>Fargate tasks do not support the <code>DAEMON</code>\n\t\t\t\t\t\tscheduling strategy.</p>\n\t\t\t\t </note>\n\t\t\t </li>\n </ul>"
}
},
"deploymentController": {
"target": "com.amazonaws.ecs#DeploymentController",
"traits": {
"smithy.api#documentation": "<p>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 <code>ECS</code> deployment\n\t\t\tcontroller type.</p>"
}
},
"tags": {
"target": "com.amazonaws.ecs#Tags",
"traits": {
"smithy.api#documentation": "<p>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.</p>\n\t\t <p>The following basic restrictions apply to tags:</p>\n <ul>\n <li>\n <p>Maximum number of tags per resource - 50</p>\n </li>\n <li>\n <p>For each resource, each tag key must be unique, and each tag key can have only\n one value.</p>\n </li>\n <li>\n <p>Maximum key length - 128 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>Maximum value length - 256 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>If 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: + - = . _ : / @.</p>\n </li>\n <li>\n <p>Tag keys and values are case-sensitive.</p>\n </li>\n <li>\n <p>Do not use <code>aws:</code>, <code>AWS:</code>, 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.</p>\n </li>\n </ul>"
}
},
"createdBy": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The principal that created the service.</p>"
}
},
"enableECSManagedTags": {
"target": "com.amazonaws.ecs#Boolean",
"traits": {
"smithy.api#documentation": "<p>Specifies whether to enable Amazon ECS managed tags for the tasks in the service. For more\n\t\t\tinformation, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html\">Tagging Your Amazon ECS\n\t\t\t\tResources</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"propagateTags": {
"target": "com.amazonaws.ecs#PropagateTags",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"enableExecuteCommand": {
"target": "com.amazonaws.ecs#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether or not the execute command functionality is enabled for the service. If\n\t\t\t\t<code>true</code>, the execute command functionality is enabled for all containers\n\t\t\tin tasks as part of the service.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Details on a service within a cluster</p>"
}
},
"com.amazonaws.ecs#ServiceEvent": {
"type": "structure",
"members": {
"id": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The ID string of the event.</p>"
}
},
"createdAt": {
"target": "com.amazonaws.ecs#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The Unix timestamp for when the event was triggered.</p>"
}
},
"message": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The event message.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Details on an event associated with a service.</p>"
}
},
"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": "<p>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 <a>CreateService</a>.</p>",
"smithy.api#error": "client"
}
},
"com.amazonaws.ecs#ServiceNotFoundException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.ecs#String"
}
},
"traits": {
"smithy.api#documentation": "<p>The specified service could not be found. You can view your available services with\n\t\t\t\t<a>ListServices</a>. Amazon ECS services are cluster-specific and\n\t\t\tRegion-specific.</p>",
"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": "<p>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 <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html\">CreateService</a>.</p>"
}
},
"port": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>The port value used if your service discovery service specified an SRV record. This\n\t\t\tfield may be used if both the <code>awsvpc</code> network mode and SRV records are\n\t\t\tused.</p>"
}
},
"containerName": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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 <code>bridge</code> or <code>host</code> network mode, you must specify a\n\t\t\t\t<code>containerName</code> and <code>containerPort</code> combination from the task\n\t\t\tdefinition. If the task definition that your service task specifies uses the\n\t\t\t\t<code>awsvpc</code> network mode and a type SRV DNS record is used, you must specify\n\t\t\teither a <code>containerName</code> and <code>containerPort</code> combination or a\n\t\t\t\t<code>port</code> value, but not both.</p>"
}
},
"containerPort": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>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\t<code>bridge</code> or <code>host</code> network mode, you must specify a\n\t\t\t\t<code>containerName</code> and <code>containerPort</code> combination from the task\n\t\t\tdefinition. If the task definition your service task specifies uses the\n\t\t\t\t<code>awsvpc</code> network mode and a type SRV DNS record is used, you must specify\n\t\t\teither a <code>containerName</code> and <code>containerPort</code> combination or a\n\t\t\t\t<code>port</code> value, but not both.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Details of the service registry.</p>"
}
},
"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": "<p>The ID of the execute command session.</p>"
}
},
"streamUrl": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"tokenValue": {
"target": "com.amazonaws.ecs#SensitiveString",
"traits": {
"smithy.api#documentation": "<p>An encrypted token value containing session and caller information. Used to\n\t\t\tauthenticate the connection to the container.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The details of the execute command session.</p>"
}
},
"com.amazonaws.ecs#Setting": {
"type": "structure",
"members": {
"name": {
"target": "com.amazonaws.ecs#SettingName",
"traits": {
"smithy.api#documentation": "<p>The Amazon ECS resource name.</p>"
}
},
"value": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>Whether the account setting is enabled or disabled for the specified resource.</p>"
}
},
"principalArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The current account setting for a resource.</p>"
}
},
"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": "<p>Starts a new task from the specified task definition on the specified container\n\t\t\tinstance or instances.</p>\n\t\t <p>Alternatively, you can use <a>RunTask</a> to place tasks for you. For more\n\t\t\tinformation, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html\">Scheduling Tasks</a> in the\n\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"com.amazonaws.ecs#StartTaskRequest": {
"type": "structure",
"members": {
"cluster": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"containerInstances": {
"target": "com.amazonaws.ecs#StringList",
"traits": {
"smithy.api#documentation": "<p>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.</p>",
"smithy.api#required": {}
}
},
"enableECSManagedTags": {
"target": "com.amazonaws.ecs#Boolean",
"traits": {
"smithy.api#documentation": "<p>Specifies whether to enable Amazon ECS managed tags for the task. For more information, see\n\t\t\t\t<a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html\">Tagging Your Amazon ECS\n\t\t\t\tResources</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"enableExecuteCommand": {
"target": "com.amazonaws.ecs#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether or not the execute command functionality is enabled for the task. If\n\t\t\t\t<code>true</code>, this enables execute command functionality on all containers in\n\t\t\tthe task.</p>"
}
},
"group": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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).</p>"
}
},
"networkConfiguration": {
"target": "com.amazonaws.ecs#NetworkConfiguration",
"traits": {
"smithy.api#documentation": "<p>The VPC subnet and security group configuration for tasks that receive their own\n elastic network interface by using the <code>awsvpc</code> networking mode.</p>"
}
},
"overrides": {
"target": "com.amazonaws.ecs#TaskOverride",
"traits": {
"smithy.api#documentation": "<p>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 <code>command</code> 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 <code>environment</code> override.</p>\n\t\t <note>\n\t\t\t <p>A total of 8192 characters are allowed for overrides. This limit includes the JSON\n\t\t\t\tformatting characters of the override structure.</p>\n\t\t </note>"
}
},
"propagateTags": {
"target": "com.amazonaws.ecs#PropagateTags",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"referenceId": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The reference ID to use for the task.</p>"
}
},
"startedBy": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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 <code>startedBy</code> parameter. You can then identify which\n\t\t\ttasks belong to that job by filtering the results of a <a>ListTasks</a> call\n\t\t\twith the <code>startedBy</code> value. Up to 36 letters (uppercase and lowercase),\n\t\t\tnumbers, hyphens, and underscores are allowed.</p>\n\t\t <p>If a task is started by an Amazon ECS service, then the <code>startedBy</code> parameter\n\t\t\tcontains the deployment ID of the service that starts it.</p>"
}
},
"tags": {
"target": "com.amazonaws.ecs#Tags",
"traits": {
"smithy.api#documentation": "<p>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.</p>\n\t\t <p>The following basic restrictions apply to tags:</p>\n <ul>\n <li>\n <p>Maximum number of tags per resource - 50</p>\n </li>\n <li>\n <p>For each resource, each tag key must be unique, and each tag key can have only\n one value.</p>\n </li>\n <li>\n <p>Maximum key length - 128 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>Maximum value length - 256 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>If 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: + - = . _ : / @.</p>\n </li>\n <li>\n <p>Tag keys and values are case-sensitive.</p>\n </li>\n <li>\n <p>Do not use <code>aws:</code>, <code>AWS:</code>, 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.</p>\n </li>\n </ul>"
}
},
"taskDefinition": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or\n\t\t\tfull ARN of the task definition to start. If a <code>revision</code> is not specified,\n\t\t\tthe latest <code>ACTIVE</code> revision is used.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.ecs#StartTaskResponse": {
"type": "structure",
"members": {
"tasks": {
"target": "com.amazonaws.ecs#Tasks",
"traits": {
"smithy.api#documentation": "<p>A full description of the tasks that were started. Each task that was successfully\n\t\t\tplaced on your container instances is described.</p>"
}
},
"failures": {
"target": "com.amazonaws.ecs#Failures",
"traits": {
"smithy.api#documentation": "<p>Any failures associated with the call.</p>"
}
}
}
},
"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": "<p>Stops a running task. Any tags associated with the task will be deleted.</p>\n\t\t <p>When <a>StopTask</a> is called on a task, the equivalent of <code>docker\n\t\t\t\tstop</code> is issued to the containers running in the task. This results in a\n\t\t\t\t<code>SIGTERM</code> value and a default 30-second timeout, after which the\n\t\t\t\t<code>SIGKILL</code> value is sent and the containers are forcibly stopped. If the\n\t\t\tcontainer handles the <code>SIGTERM</code> value gracefully and exits within 30 seconds\n\t\t\tfrom receiving it, no <code>SIGKILL</code> value is sent.</p>\n\t\t <note>\n\t\t\t <p>The default 30-second timeout can be configured on the Amazon ECS container agent with\n\t\t\t\tthe <code>ECS_CONTAINER_STOP_TIMEOUT</code> variable. For more information, see\n\t\t\t\t\t<a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html\">Amazon ECS Container Agent Configuration</a> in the\n\t\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t </note>"
}
},
"com.amazonaws.ecs#StopTaskRequest": {
"type": "structure",
"members": {
"cluster": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"task": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The task ID or full Amazon Resource Name (ARN) of the task to stop.</p>",
"smithy.api#required": {}
}
},
"reason": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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 <a>DescribeTasks</a> API\n\t\t\toperations on this task. Up to 255 characters are allowed in this message.</p>"
}
}
}
},
"com.amazonaws.ecs#StopTaskResponse": {
"type": "structure",
"members": {
"task": {
"target": "com.amazonaws.ecs#Task",
"traits": {
"smithy.api#documentation": "<p>The task that was stopped.</p>"
}
}
}
},
"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": "<note>\n <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p>\n </note> \n <p>Sent to\n\t\t\tacknowledge that an attachment changed states.</p>"
}
},
"com.amazonaws.ecs#SubmitAttachmentStateChangesRequest": {
"type": "structure",
"members": {
"cluster": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The short name or full ARN of the cluster that hosts the container instance the\n\t\t\tattachment belongs to.</p>"
}
},
"attachments": {
"target": "com.amazonaws.ecs#AttachmentStateChanges",
"traits": {
"smithy.api#documentation": "<p>Any attachments associated with the state change request.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.ecs#SubmitAttachmentStateChangesResponse": {
"type": "structure",
"members": {
"acknowledgment": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>Acknowledgement of the state change.</p>"
}
}
}
},
"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": "<note>\n <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p>\n </note> \n <p>Sent to\n\t\t\tacknowledge that a container changed states.</p>"
}
},
"com.amazonaws.ecs#SubmitContainerStateChangeRequest": {
"type": "structure",
"members": {
"cluster": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The short name or full ARN of the cluster that hosts the container.</p>"
}
},
"task": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The task ID or full Amazon Resource Name (ARN) of the task that hosts the container.</p>"
}
},
"containerName": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The name of the container.</p>"
}
},
"runtimeId": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The ID of the Docker container.</p>"
}
},
"status": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The status of the state change request.</p>"
}
},
"exitCode": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>The exit code returned for the state change request.</p>"
}
},
"reason": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The reason for the state change request.</p>"
}
},
"networkBindings": {
"target": "com.amazonaws.ecs#NetworkBindings",
"traits": {
"smithy.api#documentation": "<p>The network bindings of the container.</p>"
}
}
}
},
"com.amazonaws.ecs#SubmitContainerStateChangeResponse": {
"type": "structure",
"members": {
"acknowledgment": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>Acknowledgement of the state change.</p>"
}
}
}
},
"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": "<note>\n <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p>\n </note> \n <p>Sent to acknowledge\n\t\t\tthat a task changed states.</p>"
}
},
"com.amazonaws.ecs#SubmitTaskStateChangeRequest": {
"type": "structure",
"members": {
"cluster": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.</p>"
}
},
"task": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The task ID or full ARN of the task in the state change request.</p>"
}
},
"status": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The status of the state change request.</p>"
}
},
"reason": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The reason for the state change request.</p>"
}
},
"containers": {
"target": "com.amazonaws.ecs#ContainerStateChanges",
"traits": {
"smithy.api#documentation": "<p>Any containers associated with the state change request.</p>"
}
},
"attachments": {
"target": "com.amazonaws.ecs#AttachmentStateChanges",
"traits": {
"smithy.api#documentation": "<p>Any attachments associated with the state change request.</p>"
}
},
"managedAgents": {
"target": "com.amazonaws.ecs#ManagedAgentStateChanges",
"traits": {
"smithy.api#documentation": "<p>The details for the managed agent associated with the task.</p>"
}
},
"pullStartedAt": {
"target": "com.amazonaws.ecs#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The Unix timestamp for when the container image pull began.</p>"
}
},
"pullStoppedAt": {
"target": "com.amazonaws.ecs#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The Unix timestamp for when the container image pull completed.</p>"
}
},
"executionStoppedAt": {
"target": "com.amazonaws.ecs#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The Unix timestamp for when the task execution stopped.</p>"
}
}
}
},
"com.amazonaws.ecs#SubmitTaskStateChangeResponse": {
"type": "structure",
"members": {
"acknowledgment": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>Acknowledgement of the state change.</p>"
}
}
}
},
"com.amazonaws.ecs#SystemControl": {
"type": "structure",
"members": {
"namespace": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The namespaced kernel parameter for which to set a <code>value</code>.</p>"
}
},
"value": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The value for the namespaced kernel parameter specified in\n\t\t\t<code>namespace</code>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A list of namespaced kernel parameters to set in the container. This parameter maps to\n\t\t\t\t<code>Sysctls</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the\n\t\t\t<a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--sysctl</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker run</a>.</p>\n\t\t <p>It is not recommended that you specify network-related <code>systemControls</code>\n\t\t\tparameters for multiple containers in a single task that also uses either the\n\t\t\t\t<code>awsvpc</code> or <code>host</code> network mode for the following\n\t\t\treasons:</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>For tasks that use the <code>awsvpc</code> network mode, if you set\n\t\t\t\t\t\t<code>systemControls</code> for any container, it applies to all containers\n\t\t\t\t\tin the task. If you set different <code>systemControls</code> 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\t<code>systemControls</code> take effect.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>For tasks that use the <code>host</code> network mode, the\n\t\t\t\t\t\t<code>systemControls</code> 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.</p>\n\t\t\t </li>\n </ul>"
}
},
"com.amazonaws.ecs#SystemControls": {
"type": "list",
"member": {
"target": "com.amazonaws.ecs#SystemControl"
}
},
"com.amazonaws.ecs#Tag": {
"type": "structure",
"members": {
"key": {
"target": "com.amazonaws.ecs#TagKey",
"traits": {
"smithy.api#documentation": "<p>One part of a key-value pair that make up a tag. A <code>key</code> is a general label\n\t\t\tthat acts like a category for more specific tag values.</p>"
}
},
"value": {
"target": "com.amazonaws.ecs#TagValue",
"traits": {
"smithy.api#documentation": "<p>The optional part of a key-value pair that make up a tag. A <code>value</code> acts as\n\t\t\ta descriptor within a tag category (key).</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>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.</p>\n\t\t <p>The following basic restrictions apply to tags:</p>\n <ul>\n <li>\n <p>Maximum number of tags per resource - 50</p>\n </li>\n <li>\n <p>For each resource, each tag key must be unique, and each tag key can have only\n one value.</p>\n </li>\n <li>\n <p>Maximum key length - 128 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>Maximum value length - 256 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>If 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: + - = . _ : / @.</p>\n </li>\n <li>\n <p>Tag keys and values are case-sensitive.</p>\n </li>\n <li>\n <p>Do not use <code>aws:</code>, <code>AWS:</code>, 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.</p>\n </li>\n </ul>"
}
},
"com.amazonaws.ecs#TagKey": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 128
},
"smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
}
},
"com.amazonaws.ecs#TagKeys": {
"type": "list",
"member": {
"target": "com.amazonaws.ecs#TagKey"
}
},
"com.amazonaws.ecs#TagResource": {
"type": "operation",
"input": {
"target": "com.amazonaws.ecs#TagResourceRequest"
},
"output": {
"target": "com.amazonaws.ecs#TagResourceResponse"
},
"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": "<p>Associates the specified tags to a resource with the specified\n\t\t\t\t<code>resourceArn</code>. 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.</p>"
}
},
"com.amazonaws.ecs#TagResourceRequest": {
"type": "structure",
"members": {
"resourceArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>",
"smithy.api#required": {}
}
},
"tags": {
"target": "com.amazonaws.ecs#Tags",
"traits": {
"smithy.api#documentation": "<p>The tags to add to the resource. A tag is an array of key-value pairs.</p>\n\t\t <p>The following basic restrictions apply to tags:</p>\n <ul>\n <li>\n <p>Maximum number of tags per resource - 50</p>\n </li>\n <li>\n <p>For each resource, each tag key must be unique, and each tag key can have only\n one value.</p>\n </li>\n <li>\n <p>Maximum key length - 128 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>Maximum value length - 256 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>If 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: + - = . _ : / @.</p>\n </li>\n <li>\n <p>Tag keys and values are case-sensitive.</p>\n </li>\n <li>\n <p>Do not use <code>aws:</code>, <code>AWS:</code>, 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.</p>\n </li>\n </ul>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.ecs#TagResourceResponse": {
"type": "structure",
"members": {}
},
"com.amazonaws.ecs#TagValue": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 256
},
"smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
}
},
"com.amazonaws.ecs#Tags": {
"type": "list",
"member": {
"target": "com.amazonaws.ecs#Tag"
},
"traits": {
"smithy.api#length": {
"min": 0,
"max": 50
}
}
},
"com.amazonaws.ecs#TargetNotConnectedException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.ecs#String"
}
},
"traits": {
"smithy.api#documentation": "<p>The target container is not properly configured with the execute command agent or the\n\t\t\tcontainer is no longer active or running.</p>",
"smithy.api#error": "client"
}
},
"com.amazonaws.ecs#TargetNotFoundException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.ecs#String"
}
},
"traits": {
"smithy.api#documentation": "<p>The specified target could not be found. You can view your available container\n\t\t\tinstances with <a>ListContainerInstances</a>. Amazon ECS container instances are\n\t\t\tcluster-specific and Region-specific.</p>",
"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": "<p>The Elastic Network Adapter associated with the task if the task uses the\n\t\t\t\t<code>awsvpc</code> network mode.</p>"
}
},
"attributes": {
"target": "com.amazonaws.ecs#Attributes",
"traits": {
"smithy.api#documentation": "<p>The attributes of the task</p>"
}
},
"availabilityZone": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The availability zone of the task.</p>"
}
},
"capacityProviderName": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The capacity provider associated with the task.</p>"
}
},
"clusterArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The ARN of the cluster that hosts the task.</p>"
}
},
"connectivity": {
"target": "com.amazonaws.ecs#Connectivity",
"traits": {
"smithy.api#documentation": "<p>The connectivity status of a task.</p>"
}
},
"connectivityAt": {
"target": "com.amazonaws.ecs#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The Unix timestamp for when the task last went into <code>CONNECTED</code>\n\t\t\tstatus.</p>"
}
},
"containerInstanceArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The ARN of the container instances that host the task.</p>"
}
},
"containers": {
"target": "com.amazonaws.ecs#Containers",
"traits": {
"smithy.api#documentation": "<p>The containers associated with the task.</p>"
}
},
"cpu": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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 <code>1024</code>. It can also be\n\t\t\texpressed as a string using vCPUs, for example <code>1 vCPU</code> or <code>1\n\t\t\t\tvcpu</code>. String values are converted to an integer indicating the CPU units when\n\t\t\tthe task definition is registered.</p>\n\t\t <p>If you are using the EC2 launch type, this field is optional. Supported\n\t\t\tvalues are between <code>128</code> CPU units (<code>0.125</code> vCPUs) and\n\t\t\t\t<code>10240</code> CPU units (<code>10</code> vCPUs).</p>\n\t\t <p>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 <code>memory</code> parameter:</p> \n <ul>\n <li>\n <p>256 (.25 vCPU) - Available <code>memory</code> values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)</p>\n </li>\n <li>\n <p>512 (.5 vCPU) - Available <code>memory</code> values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)</p>\n </li>\n <li>\n <p>1024 (1 vCPU) - Available <code>memory</code> values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)</p>\n </li>\n <li>\n <p>2048 (2 vCPU) - Available <code>memory</code> values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)</p>\n </li>\n <li>\n <p>4096 (4 vCPU) - Available <code>memory</code> values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)</p>\n </li>\n </ul>"
}
},
"createdAt": {
"target": "com.amazonaws.ecs#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The Unix timestamp for when the task was created (the task entered the\n\t\t\t\t<code>PENDING</code> state).</p>"
}
},
"desiredStatus": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The desired status of the task. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-lifecycle.html\">Task\n\t\t\tLifecycle</a>.</p>"
}
},
"enableExecuteCommand": {
"target": "com.amazonaws.ecs#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether or not execute command functionality is enabled for this task. If\n\t\t\t\t<code>true</code>, this enables execute command functionality on all containers in\n\t\t\tthe task.</p>"
}
},
"executionStoppedAt": {
"target": "com.amazonaws.ecs#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The Unix timestamp for when the task execution stopped.</p>"
}
},
"group": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The name of the task group associated with the task.</p>"
}
},
"healthStatus": {
"target": "com.amazonaws.ecs#HealthStatus",
"traits": {
"smithy.api#documentation": "<p>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\t<code>HEALTHY</code>, then the task status also reports as <code>HEALTHY</code>. If\n\t\t\tany essential containers in the task are reporting as <code>UNHEALTHY</code> or\n\t\t\t\t<code>UNKNOWN</code>, then the task status also reports as <code>UNHEALTHY</code> or\n\t\t\t\t<code>UNKNOWN</code>, accordingly.</p>\n\t\t <note>\n\t\t\t <p>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.</p>\n\t\t </note>"
}
},
"inferenceAccelerators": {
"target": "com.amazonaws.ecs#InferenceAccelerators",
"traits": {
"smithy.api#documentation": "<p>The Elastic Inference accelerator associated with the task.</p>"
}
},
"lastStatus": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The last known status of the task. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-lifecycle.html\">Task\n\t\t\t\tLifecycle</a>.</p>"
}
},
"launchType": {
"target": "com.amazonaws.ecs#LaunchType",
"traits": {
"smithy.api#documentation": "<p>The launch type on which your task is running. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html\">Amazon ECS\n\t\t\t\tLaunch Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"memory": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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 <code>1024</code>. It can also be\n\t\t\texpressed as a string using GB, for example <code>1GB</code> or <code>1 GB</code>.\n\t\t\tString values are converted to an integer indicating the MiB when the task definition is\n\t\t\tregistered.</p>\n\t\t <p>If you are using the EC2 launch type, this field is optional.</p>\n\t\t <p>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 <code>cpu</code> parameter:</p> \n <ul>\n <li>\n <p>512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available <code>cpu</code> values: 256 (.25 vCPU)</p>\n </li>\n <li>\n <p>1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available <code>cpu</code> values: 512 (.5 vCPU)</p>\n </li>\n <li>\n <p>2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available <code>cpu</code> values: 1024 (1 vCPU)</p>\n </li>\n <li>\n <p>Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available <code>cpu</code> values: 2048 (2 vCPU)</p>\n </li>\n <li>\n <p>Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available <code>cpu</code> values: 4096 (4 vCPU)</p>\n </li>\n </ul>"
}
},
"overrides": {
"target": "com.amazonaws.ecs#TaskOverride",
"traits": {
"smithy.api#documentation": "<p>One or more container overrides.</p>"
}
},
"platformVersion": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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 <code>LATEST</code> platform version is used by default. For more\n\t\t\tinformation, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">AWS Fargate Platform\n\t\t\t\tVersions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"pullStartedAt": {
"target": "com.amazonaws.ecs#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The Unix timestamp for when the container image pull began.</p>"
}
},
"pullStoppedAt": {
"target": "com.amazonaws.ecs#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The Unix timestamp for when the container image pull completed.</p>"
}
},
"startedAt": {
"target": "com.amazonaws.ecs#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The Unix timestamp for when the task started (the task transitioned from the\n\t\t\t\t<code>PENDING</code> state to the <code>RUNNING</code> state).</p>"
}
},
"startedBy": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The tag specified when a task is started. If the task is started by an Amazon ECS service,\n\t\t\tthen the <code>startedBy</code> parameter contains the deployment ID of the service that\n\t\t\tstarts it.</p>"
}
},
"stopCode": {
"target": "com.amazonaws.ecs#TaskStopCode",
"traits": {
"smithy.api#documentation": "<p>The stop code indicating why a task was stopped. The <code>stoppedReason</code> may\n\t\t\tcontain additional details.</p>"
}
},
"stoppedAt": {
"target": "com.amazonaws.ecs#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The Unix timestamp for when the task was stopped (the task transitioned from the\n\t\t\t\t<code>RUNNING</code> state to the <code>STOPPED</code> state).</p>"
}
},
"stoppedReason": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The reason that the task was stopped.</p>"
}
},
"stoppingAt": {
"target": "com.amazonaws.ecs#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The Unix timestamp for when the task stops (transitions from the <code>RUNNING</code>\n\t\t\tstate to <code>STOPPED</code>).</p>"
}
},
"tags": {
"target": "com.amazonaws.ecs#Tags",
"traits": {
"smithy.api#documentation": "<p>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.</p>\n\t\t <p>The following basic restrictions apply to tags:</p>\n <ul>\n <li>\n <p>Maximum number of tags per resource - 50</p>\n </li>\n <li>\n <p>For each resource, each tag key must be unique, and each tag key can have only\n one value.</p>\n </li>\n <li>\n <p>Maximum key length - 128 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>Maximum value length - 256 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>If 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: + - = . _ : / @.</p>\n </li>\n <li>\n <p>Tag keys and values are case-sensitive.</p>\n </li>\n <li>\n <p>Do not use <code>aws:</code>, <code>AWS:</code>, 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.</p>\n </li>\n </ul>"
}
},
"taskArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the task.</p>"
}
},
"taskDefinitionArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The ARN of the task definition that creates the task.</p>"
}
},
"version": {
"target": "com.amazonaws.ecs#Long",
"traits": {
"smithy.api#documentation": "<p>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\t<code>detail</code> object) to verify that the version in your event stream is\n\t\t\tcurrent.</p>"
}
},
"ephemeralStorage": {
"target": "com.amazonaws.ecs#EphemeralStorage",
"traits": {
"smithy.api#documentation": "<p>The ephemeral storage settings for the task.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Details on a task in a cluster.</p>"
}
},
"com.amazonaws.ecs#TaskDefinition": {
"type": "structure",
"members": {
"taskDefinitionArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The full Amazon Resource Name (ARN) of the task definition.</p>"
}
},
"containerDefinitions": {
"target": "com.amazonaws.ecs#ContainerDefinitions",
"traits": {
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html\">Amazon ECS Task\n\t\t\t\tDefinitions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"family": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>\n\t\t <p>A 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.</p>"
}
},
"taskRoleArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html\">Amazon ECS\n\t\t\t\tTask Role</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t <p>IAM roles for tasks on Windows require that the <code>-EnableTaskIAMRole</code> 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\t<a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html\">Windows IAM roles\n\t\t\t\tfor tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"executionRoleArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html\">Amazon ECS task\n execution IAM role</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"networkMode": {
"target": "com.amazonaws.ecs#NetworkMode",
"traits": {
"smithy.api#documentation": "<p>The Docker networking mode to use for the containers in the task. The valid values are\n <code>none</code>, <code>bridge</code>, <code>awsvpc</code>, and <code>host</code>.\n If no network mode is specified, the default is <code>bridge</code>.</p>\n <p>For Amazon ECS tasks on Fargate, the <code>awsvpc</code> 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 <code>none</code>, you cannot specify port mappings in your container\n definitions, and the tasks containers do not have external connectivity. The\n <code>host</code> and <code>awsvpc</code> 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 <code>bridge</code> mode.</p>\n <p>With the <code>host</code> and <code>awsvpc</code> network modes, exposed container\n ports are mapped directly to the corresponding host port (for the <code>host</code>\n network mode) or the attached elastic network interface port (for the\n <code>awsvpc</code> network mode), so you cannot take advantage of dynamic host port\n mappings. </p>\n <important>\n <p>When using the <code>host</code> 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.</p>\n </important>\n <p>If the network mode is <code>awsvpc</code>, the task is allocated an elastic network\n interface, and you must specify a <a>NetworkConfiguration</a> value when you create\n a service or run a task with the task definition. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html\">Task Networking</a> in the\n <i>Amazon Elastic Container Service Developer Guide</i>.</p>\n <note>\n <p>Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the\n <code>ecs-init</code> package, or AWS Fargate infrastructure support the\n <code>awsvpc</code> network mode. </p>\n </note>\n <p>If the network mode is <code>host</code>, you cannot run multiple instantiations of the\n same task on a single container instance when port mappings are used.</p>\n <p>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 <code><default></code> network mode object. </p>\n <p>For more information, see <a href=\"https://docs.docker.com/engine/reference/run/#network-settings\">Network\n settings</a> in the <i>Docker run reference</i>.</p>"
}
},
"revision": {
"target": "com.amazonaws.ecs#Integer",
"traits": {
"smithy.api#documentation": "<p>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 <code>1</code>. 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.</p>"
}
},
"volumes": {
"target": "com.amazonaws.ecs#VolumeList",
"traits": {
"smithy.api#documentation": "<p>The list of data volume definitions for the task. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html\">Using data volumes in tasks</a> in the\n\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t <note>\n\t\t\t <p>The <code>host</code> and <code>sourcePath</code> parameters are not supported for\n\t\t\t\ttasks run on AWS Fargate.</p>\n\t\t </note>"
}
},
"status": {
"target": "com.amazonaws.ecs#TaskDefinitionStatus",
"traits": {
"smithy.api#documentation": "<p>The status of the task definition.</p>"
}
},
"requiresAttributes": {
"target": "com.amazonaws.ecs#RequiresAttributes",
"traits": {
"smithy.api#documentation": "<p>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 <a>PutAttributes</a> 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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes\">Attributes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t <note>\n\t\t\t <p>This parameter is not supported for tasks run on AWS Fargate.</p>\n\t\t </note>"
}
},
"placementConstraints": {
"target": "com.amazonaws.ecs#TaskDefinitionPlacementConstraints",
"traits": {
"smithy.api#documentation": "<p>An array of placement constraint objects to use for tasks.</p>\n\t\t <note>\n\t\t\t <p>This parameter is not supported for tasks run on AWS Fargate.</p>\n\t\t </note>"
}
},
"compatibilities": {
"target": "com.amazonaws.ecs#CompatibilityList",
"traits": {
"smithy.api#documentation": "<p>The task launch types the task definition validated against during task definition\n\t\t\tregistration. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html\">Amazon ECS launch types</a>\n\t\t\tin the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"requiresCompatibilities": {
"target": "com.amazonaws.ecs#CompatibilityList",
"traits": {
"smithy.api#documentation": "<p>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 <a>TaskDefinition$compatibilities</a> parameter.</p>"
}
},
"cpu": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The number of <code>cpu</code> 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 <code>memory</code> parameter:</p>\n\t\t <ul>\n <li>\n <p>256 (.25 vCPU) - Available <code>memory</code> values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)</p>\n </li>\n <li>\n <p>512 (.5 vCPU) - Available <code>memory</code> values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)</p>\n </li>\n <li>\n <p>1024 (1 vCPU) - Available <code>memory</code> values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)</p>\n </li>\n <li>\n <p>2048 (2 vCPU) - Available <code>memory</code> values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)</p>\n </li>\n <li>\n <p>4096 (4 vCPU) - Available <code>memory</code> values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)</p>\n </li>\n </ul>"
}
},
"memory": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The amount (in MiB) of memory used by the task.</p>\n\t\t <p>If 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 <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html\">ContainerDefinition</a>.</p>\n\t\t <p>If 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\t<code>cpu</code> parameter:</p> \n <ul>\n <li>\n <p>512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available <code>cpu</code> values: 256 (.25 vCPU)</p>\n </li>\n <li>\n <p>1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available <code>cpu</code> values: 512 (.5 vCPU)</p>\n </li>\n <li>\n <p>2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available <code>cpu</code> values: 1024 (1 vCPU)</p>\n </li>\n <li>\n <p>Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available <code>cpu</code> values: 2048 (2 vCPU)</p>\n </li>\n <li>\n <p>Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available <code>cpu</code> values: 4096 (4 vCPU)</p>\n </li>\n </ul>"
}
},
"inferenceAccelerators": {
"target": "com.amazonaws.ecs#InferenceAccelerators",
"traits": {
"smithy.api#documentation": "<p>The Elastic Inference accelerator associated with the task.</p>"
}
},
"pidMode": {
"target": "com.amazonaws.ecs#PidMode",
"traits": {
"smithy.api#documentation": "<p>The process namespace to use for the containers in the task. The valid\n values are <code>host</code> or <code>task</code>. If <code>host</code>\n is specified, then all containers within the tasks that specified the\n <code>host</code> PID mode on the same container instance share the\n same process namespace with the host Amazon EC2 instance. If <code>task</code> 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 <a href=\"https://docs.docker.com/engine/reference/run/#pid-settings---pid\">PID settings</a> in the <i>Docker run\n reference</i>.</p>\n <p>If the <code>host</code> PID mode is used, be aware that there is a\n heightened risk of undesired process namespace expose. For more\n information, see <a href=\"https://docs.docker.com/engine/security/security/\">Docker\n security</a>.</p> \n <note>\n <p>This parameter is not supported for Windows containers or tasks run on AWS Fargate.</p>\n </note>"
}
},
"ipcMode": {
"target": "com.amazonaws.ecs#IpcMode",
"traits": {
"smithy.api#documentation": "<p>The IPC resource namespace to use for the containers in the task. The valid values are\n <code>host</code>, <code>task</code>, or <code>none</code>. If <code>host</code> is\n specified, then all containers within the tasks that specified the <code>host</code> IPC\n mode on the same container instance share the same IPC resources with the host Amazon EC2\n instance. If <code>task</code> is specified, all containers within the specified task\n share the same IPC resources. If <code>none</code> 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 <a href=\"https://docs.docker.com/engine/reference/run/#ipc-settings---ipc\">IPC\n settings</a> in the <i>Docker run reference</i>.</p>\n <p>If the <code>host</code> IPC mode is used, be aware that there is a heightened risk of\n undesired IPC namespace expose. For more information, see <a href=\"https://docs.docker.com/engine/security/security/\">Docker\n security</a>.</p>\n <p>If you are setting namespaced kernel parameters using <code>systemControls</code> for\n the containers in the task, the following will apply to your IPC resource namespace. For\n more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html\">System\n Controls</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>\n <ul>\n <li>\n <p>For tasks that use the <code>host</code> IPC mode, IPC namespace related\n <code>systemControls</code> are not supported.</p>\n </li>\n <li>\n <p>For tasks that use the <code>task</code> IPC mode, IPC namespace related\n <code>systemControls</code> will apply to all containers within a\n task.</p>\n </li>\n </ul> \n <note>\n <p>This parameter is not supported for Windows containers or tasks run on AWS Fargate.</p>\n </note>"
}
},
"proxyConfiguration": {
"target": "com.amazonaws.ecs#ProxyConfiguration",
"traits": {
"smithy.api#documentation": "<p>The configuration details for the App Mesh proxy.</p>\n\t\t <p>Your 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 <code>ecs-init</code> 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 <code>20190301</code> or later, then they contain the required versions of the\n\t\t\tcontainer agent and <code>ecs-init</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html\">Amazon ECS-optimized Linux AMI</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"registeredAt": {
"target": "com.amazonaws.ecs#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The Unix timestamp for when the task definition was registered.</p>"
}
},
"deregisteredAt": {
"target": "com.amazonaws.ecs#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The Unix timestamp for when the task definition was deregistered.</p>"
}
},
"registeredBy": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The principal that registered the task definition.</p>"
}
},
"ephemeralStorage": {
"target": "com.amazonaws.ecs#EphemeralStorage",
"traits": {
"smithy.api#documentation": "<p>The ephemeral storage settings to use for tasks run with the task definition.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"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": "<p>The type of constraint. The <code>MemberOf</code> constraint restricts selection to be\n\t\t\tfrom a group of valid candidates.</p>"
}
},
"expression": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>A cluster query language expression to apply to the constraint. For more information,\n\t\t\tsee <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html\">Cluster query language</a> in the\n\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object representing a constraint on task placement in the task definition. For more\n\t\t\tinformation, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html\">Task placement constraints</a> in the\n\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t <note>\n\t\t\t <p>Task placement constraints are not supported for tasks run on AWS Fargate.</p>\n\t\t </note>"
}
},
"com.amazonaws.ecs#TaskDefinitionPlacementConstraintType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "memberOf",
"name": "MEMBER_OF"
}
]
}
},
"com.amazonaws.ecs#TaskDefinitionPlacementConstraints": {
"type": "list",
"member": {
"target": "com.amazonaws.ecs#TaskDefinitionPlacementConstraint"
}
},
"com.amazonaws.ecs#TaskDefinitionStatus": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "ACTIVE",
"name": "ACTIVE"
},
{
"value": "INACTIVE",
"name": "INACTIVE"
}
]
}
},
"com.amazonaws.ecs#TaskField": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "TAGS",
"name": "TAGS"
}
]
}
},
"com.amazonaws.ecs#TaskFieldList": {
"type": "list",
"member": {
"target": "com.amazonaws.ecs#TaskField"
}
},
"com.amazonaws.ecs#TaskOverride": {
"type": "structure",
"members": {
"containerOverrides": {
"target": "com.amazonaws.ecs#ContainerOverrides",
"traits": {
"smithy.api#documentation": "<p>One or more container overrides sent to a task.</p>"
}
},
"cpu": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The cpu override for the task.</p>"
}
},
"inferenceAcceleratorOverrides": {
"target": "com.amazonaws.ecs#InferenceAcceleratorOverrides",
"traits": {
"smithy.api#documentation": "<p>The Elastic Inference accelerator override for the task.</p>"
}
},
"executionRoleArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the task execution IAM role override for the task.</p>"
}
},
"memory": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The memory override for the task.</p>"
}
},
"taskRoleArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"ephemeralStorage": {
"target": "com.amazonaws.ecs#EphemeralStorage",
"traits": {
"smithy.api#documentation": "<p>The ephemeral storage setting override for the task.</p>\n\t\t <note>\n\t\t\t <p>This parameter is only supported for tasks hosted on AWS Fargate using platform\n\t\t\t\tversion <code>1.4.0</code> or later.</p>\n\t\t </note>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The overrides associated with a task.</p>"
}
},
"com.amazonaws.ecs#TaskSet": {
"type": "structure",
"members": {
"id": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The ID of the task set.</p>"
}
},
"taskSetArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the task set.</p>"
}
},
"serviceArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the service the task set exists in.</p>"
}
},
"clusterArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists\n\t\t\tin.</p>"
}
},
"startedBy": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy\n\t\t\tdeployment, the <code>startedBy</code> parameter is <code>CODE_DEPLOY</code>. For a task\n\t\t\tset created for an external deployment, the startedBy field isn't used.</p>"
}
},
"externalId": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The external ID associated with the task set.</p>\n\t\t <p>If a task set is created by an AWS CodeDeploy deployment, the <code>externalId</code> parameter\n\t\t\tcontains the AWS CodeDeploy deployment ID.</p>\n\t\t <p>If a task set is created for an external deployment and is associated with a service\n\t\t\tdiscovery registry, the <code>externalId</code> parameter contains the\n\t\t\t\t<code>ECS_TASK_SET_EXTERNAL_ID</code> AWS Cloud Map attribute.</p>"
}
},
"status": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The status of the task set. The following describes each state:</p>\n\t\t <dl>\n <dt>PRIMARY</dt>\n <dd>\n\t\t\t\t\t <p>The task set is serving production traffic.</p>\n\t\t\t\t </dd>\n <dt>ACTIVE</dt>\n <dd>\n\t\t\t\t\t <p>The task set is not serving production traffic.</p>\n\t\t\t\t </dd>\n <dt>DRAINING</dt>\n <dd>\n\t\t\t\t\t <p>The 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.</p>\n\t\t\t\t </dd>\n </dl>"
}
},
"taskDefinition": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The task definition the task set is using.</p>"
}
},
"computedDesiredCount": {
"target": "com.amazonaws.ecs#Integer",
"traits": {
"smithy.api#documentation": "<p>The computed desired count for the task set. This is calculated by multiplying the\n\t\t\tservice's <code>desiredCount</code> by the task set's <code>scale</code> 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.</p>"
}
},
"pendingCount": {
"target": "com.amazonaws.ecs#Integer",
"traits": {
"smithy.api#documentation": "<p>The number of tasks in the task set that are in the <code>PENDING</code> status during\n\t\t\ta deployment. A task in the <code>PENDING</code> state is preparing to enter the\n\t\t\t\t<code>RUNNING</code> state. A task set enters the <code>PENDING</code> status when\n\t\t\tit launches for the first time or when it is restarted after being in the\n\t\t\t\t<code>STOPPED</code> state.</p>"
}
},
"runningCount": {
"target": "com.amazonaws.ecs#Integer",
"traits": {
"smithy.api#documentation": "<p>The number of tasks in the task set that are in the <code>RUNNING</code> status during\n\t\t\ta deployment. A task in the <code>RUNNING</code> state is running and ready for\n\t\t\tuse.</p>"
}
},
"createdAt": {
"target": "com.amazonaws.ecs#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The Unix timestamp for when the task set was created.</p>"
}
},
"updatedAt": {
"target": "com.amazonaws.ecs#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The Unix timestamp for when the task set was last updated.</p>"
}
},
"launchType": {
"target": "com.amazonaws.ecs#LaunchType",
"traits": {
"smithy.api#documentation": "<p>The launch type the tasks in the task set are using. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html\">Amazon ECS\n\t\t\t\tlaunch types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"capacityProviderStrategy": {
"target": "com.amazonaws.ecs#CapacityProviderStrategy",
"traits": {
"smithy.api#documentation": "<p>The capacity provider strategy associated with the task set.</p>"
}
},
"platformVersion": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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\t<a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">AWS Fargate platform\n\t\t\t\tversions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"networkConfiguration": {
"target": "com.amazonaws.ecs#NetworkConfiguration",
"traits": {
"smithy.api#documentation": "<p>The network configuration for the task set.</p>"
}
},
"loadBalancers": {
"target": "com.amazonaws.ecs#LoadBalancers",
"traits": {
"smithy.api#documentation": "<p>Details on a load balancer that is used with a task set.</p>"
}
},
"serviceRegistries": {
"target": "com.amazonaws.ecs#ServiceRegistries",
"traits": {
"smithy.api#documentation": "<p>The details of the service discovery registries to assign to this task set. For more\n\t\t\tinformation, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html\">Service\n\t\t\t\tdiscovery</a>.</p>"
}
},
"scale": {
"target": "com.amazonaws.ecs#Scale",
"traits": {
"smithy.api#documentation": "<p>A floating-point percentage of the desired number of tasks to place and keep running\n\t\t\tin the task set.</p>"
}
},
"stabilityStatus": {
"target": "com.amazonaws.ecs#StabilityStatus",
"traits": {
"smithy.api#documentation": "<p>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\t<code>STEADY_STATE</code>:</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>The task <code>runningCount</code> is equal to the\n\t\t\t\t\t\t<code>computedDesiredCount</code>.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>The <code>pendingCount</code> is <code>0</code>.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>There are no tasks running on container instances in the <code>DRAINING</code>\n\t\t\t\t\tstatus.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>All tasks are reporting a healthy status from the load balancers, service\n\t\t\t\t\tdiscovery, and container health checks.</p>\n\t\t\t </li>\n </ul>\n\t\t <p>If any of those conditions are not met, the stability status returns\n\t\t\t\t<code>STABILIZING</code>.</p>"
}
},
"stabilityStatusAt": {
"target": "com.amazonaws.ecs#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The Unix timestamp for when the task set stability status was retrieved.</p>"
}
},
"tags": {
"target": "com.amazonaws.ecs#Tags",
"traits": {
"smithy.api#documentation": "<p>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.</p>\n\t\t <p>The following basic restrictions apply to tags:</p>\n <ul>\n <li>\n <p>Maximum number of tags per resource - 50</p>\n </li>\n <li>\n <p>For each resource, each tag key must be unique, and each tag key can have only\n one value.</p>\n </li>\n <li>\n <p>Maximum key length - 128 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>Maximum value length - 256 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>If 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: + - = . _ : / @.</p>\n </li>\n <li>\n <p>Tag keys and values are case-sensitive.</p>\n </li>\n <li>\n <p>Do not use <code>aws:</code>, <code>AWS:</code>, 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.</p>\n </li>\n </ul>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an <code>EXTERNAL</code>\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.</p>"
}
},
"com.amazonaws.ecs#TaskSetField": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "TAGS",
"name": "TAGS"
}
]
}
},
"com.amazonaws.ecs#TaskSetFieldList": {
"type": "list",
"member": {
"target": "com.amazonaws.ecs#TaskSetField"
}
},
"com.amazonaws.ecs#TaskSetNotFoundException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.ecs#String"
}
},
"traits": {
"smithy.api#documentation": "<p>The specified task set could not be found. You can view your available task sets with\n\t\t\t\t<a>DescribeTaskSets</a>. Task sets are specific to each cluster, service\n\t\t\tand Region.</p>",
"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": "<p>The absolute file path where the tmpfs volume is to be mounted.</p>",
"smithy.api#required": {}
}
},
"size": {
"target": "com.amazonaws.ecs#Integer",
"traits": {
"smithy.api#documentation": "<p>The maximum size (in MiB) of the tmpfs volume.</p>",
"smithy.api#required": {}
}
},
"mountOptions": {
"target": "com.amazonaws.ecs#StringList",
"traits": {
"smithy.api#documentation": "<p>The list of tmpfs volume mount options.</p>\n\t\t <p>Valid values: <code>\"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\"</code>\n </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The container path, mount options, and size of the tmpfs mount.</p>"
}
},
"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": "<p>The <code>type</code> of the <code>ulimit</code>.</p>",
"smithy.api#required": {}
}
},
"softLimit": {
"target": "com.amazonaws.ecs#Integer",
"traits": {
"smithy.api#documentation": "<p>The soft limit for the ulimit type.</p>",
"smithy.api#required": {}
}
},
"hardLimit": {
"target": "com.amazonaws.ecs#Integer",
"traits": {
"smithy.api#documentation": "<p>The hard limit for the ulimit type.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The <code>ulimit</code> settings to pass to the container.</p>\n\t\t <p>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 <code>nofile</code> resource limit parameter which Fargate\n\t\t\t\t\t\t\toverrides. The <code>nofile</code> 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\t<code>nofile</code> soft limit is <code>1024</code> and hard limit\n\t\t\t\t\t\t\tis <code>4096</code>.</p>"
}
},
"com.amazonaws.ecs#UlimitList": {
"type": "list",
"member": {
"target": "com.amazonaws.ecs#Ulimit"
}
},
"com.amazonaws.ecs#UlimitName": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "core",
"name": "CORE"
},
{
"value": "cpu",
"name": "CPU"
},
{
"value": "data",
"name": "DATA"
},
{
"value": "fsize",
"name": "FSIZE"
},
{
"value": "locks",
"name": "LOCKS"
},
{
"value": "memlock",
"name": "MEMLOCK"
},
{
"value": "msgqueue",
"name": "MSGQUEUE"
},
{
"value": "nice",
"name": "NICE"
},
{
"value": "nofile",
"name": "NOFILE"
},
{
"value": "nproc",
"name": "NPROC"
},
{
"value": "rss",
"name": "RSS"
},
{
"value": "rtprio",
"name": "RTPRIO"
},
{
"value": "rttime",
"name": "RTTIME"
},
{
"value": "sigpending",
"name": "SIGPENDING"
},
{
"value": "stack",
"name": "STACK"
}
]
}
},
"com.amazonaws.ecs#UnsupportedFeatureException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.ecs#String"
}
},
"traits": {
"smithy.api#documentation": "<p>The specified task is not supported in this Region.</p>",
"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": "<p>Deletes specified tags from a resource.</p>"
}
},
"com.amazonaws.ecs#UntagResourceRequest": {
"type": "structure",
"members": {
"resourceArn": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>",
"smithy.api#required": {}
}
},
"tagKeys": {
"target": "com.amazonaws.ecs#TagKeys",
"traits": {
"smithy.api#documentation": "<p>The keys of the tags to be removed.</p>",
"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": "<p>Modifies the parameters for a capacity provider.</p>"
}
},
"com.amazonaws.ecs#UpdateCapacityProviderRequest": {
"type": "structure",
"members": {
"name": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The name of the capacity provider to update.</p>",
"smithy.api#required": {}
}
},
"autoScalingGroupProvider": {
"target": "com.amazonaws.ecs#AutoScalingGroupProviderUpdate",
"traits": {
"smithy.api#documentation": "<p>An object representing the parameters to update for the Auto Scaling group capacity\n\t\t\tprovider.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.ecs#UpdateCapacityProviderResponse": {
"type": "structure",
"members": {
"capacityProvider": {
"target": "com.amazonaws.ecs#CapacityProvider",
"traits": {
"smithy.api#documentation": "<p>Details about the capacity provider.</p>"
}
}
}
},
"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": "<p>Updates the cluster.</p>"
}
},
"com.amazonaws.ecs#UpdateClusterRequest": {
"type": "structure",
"members": {
"cluster": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The name of the cluster to modify the settings for.</p>",
"smithy.api#required": {}
}
},
"settings": {
"target": "com.amazonaws.ecs#ClusterSettings",
"traits": {
"smithy.api#documentation": "<p>The cluster settings for your cluster.</p>"
}
},
"configuration": {
"target": "com.amazonaws.ecs#ClusterConfiguration",
"traits": {
"smithy.api#documentation": "<p>The execute command configuration for the cluster.</p>"
}
}
}
},
"com.amazonaws.ecs#UpdateClusterResponse": {
"type": "structure",
"members": {
"cluster": {
"target": "com.amazonaws.ecs#Cluster",
"traits": {
"smithy.api#documentation": "<p>Details about the cluster.</p>"
}
}
}
},
"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": "<p>Modifies the settings to use for a cluster.</p>"
}
},
"com.amazonaws.ecs#UpdateClusterSettingsRequest": {
"type": "structure",
"members": {
"cluster": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The name of the cluster to modify the settings for.</p>",
"smithy.api#required": {}
}
},
"settings": {
"target": "com.amazonaws.ecs#ClusterSettings",
"traits": {
"smithy.api#documentation": "<p>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\t<code>containerInsights</code> value set with <a>PutAccountSetting</a> or\n\t\t\t\t<a>PutAccountSettingDefault</a>.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.ecs#UpdateClusterSettingsResponse": {
"type": "structure",
"members": {
"cluster": {
"target": "com.amazonaws.ecs#Cluster",
"traits": {
"smithy.api#documentation": "<p>Details about the cluster</p>"
}
}
}
},
"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": "<p>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.</p>\n\t\t <note>\n\t\t\t <p>The <code>UpdateContainerAgent</code> 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 <code>ecs-init</code> package which will update the agent. For\n\t\t\t\tmore information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/agent-update-ecs-ami.html\">Updating the\n\t\t\t\t\tAmazon ECS container agent</a> in the\n\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t </note>\n\t\t <p>The <code>UpdateContainerAgent</code> API requires an Amazon ECS-optimized AMI or Amazon\n\t\t\tLinux AMI with the <code>ecs-init</code> service installed and running. For help\n\t\t\tupdating the Amazon ECS container agent on other operating systems, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html#manually_update_agent\">Manually updating the Amazon ECS container agent</a> in the\n\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"com.amazonaws.ecs#UpdateContainerAgentRequest": {
"type": "structure",
"members": {
"cluster": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"containerInstance": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.ecs#UpdateContainerAgentResponse": {
"type": "structure",
"members": {
"containerInstance": {
"target": "com.amazonaws.ecs#ContainerInstance",
"traits": {
"smithy.api#documentation": "<p>The container instance for which the container agent was updated.</p>"
}
}
}
},
"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": "<p>Modifies the status of an Amazon ECS container instance.</p>\n\t\t <p>Once a container instance has reached an <code>ACTIVE</code> state, you can change the\n\t\t\tstatus of a container instance to <code>DRAINING</code> 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.</p>\n\t\t <important>\n\t\t\t <p>A container instance cannot be changed to <code>DRAINING</code> until it has\n\t\t\t\treached an <code>ACTIVE</code> status. If the instance is in any other status, an\n\t\t\t\terror will be received.</p>\n\t\t </important>\n\t\t <p>When you set a container instance to <code>DRAINING</code>, 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 <code>PENDING</code>\n\t\t\tstate are stopped immediately.</p>\n\t\t <p>Service tasks on the container instance that are in the <code>RUNNING</code> state are\n\t\t\tstopped and replaced according to the service's deployment configuration parameters,\n\t\t\t\t<code>minimumHealthyPercent</code> and <code>maximumPercent</code>. You can change\n\t\t\tthe deployment configuration of your service using <a>UpdateService</a>.</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>If <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore\n\t\t\t\t\t\t<code>desiredCount</code> temporarily during task replacement. For example,\n\t\t\t\t\t\t<code>desiredCount</code> 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 <code>RUNNING</code>\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 <code>RUNNING</code> state and the container instance they are\n\t\t\t\t\thosted on is reported as healthy by the load balancer.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>The <code>maximumPercent</code> 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 <code>desiredCount</code> 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.</p>\n\t\t\t </li>\n </ul>\n\t\t <p>Any <code>PENDING</code> or <code>RUNNING</code> 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.</p>\n\t\t <p>A container instance has completed draining when it has no more <code>RUNNING</code>\n\t\t\ttasks. You can verify this using <a>ListTasks</a>.</p>\n\t\t <p>When a container instance has been drained, you can set a container instance to\n\t\t\t\t<code>ACTIVE</code> status and once it has reached that status the Amazon ECS scheduler\n\t\t\tcan begin scheduling tasks on the instance again.</p>"
}
},
"com.amazonaws.ecs#UpdateContainerInstancesStateRequest": {
"type": "structure",
"members": {
"cluster": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"containerInstances": {
"target": "com.amazonaws.ecs#StringList",
"traits": {
"smithy.api#documentation": "<p>A list of container instance IDs or full ARN entries.</p>",
"smithy.api#required": {}
}
},
"status": {
"target": "com.amazonaws.ecs#ContainerInstanceStatus",
"traits": {
"smithy.api#documentation": "<p>The container instance state with which to update the container instance. The only\n\t\t\tvalid values for this action are <code>ACTIVE</code> and <code>DRAINING</code>. A\n\t\t\tcontainer instance can only be updated to <code>DRAINING</code> status once it has\n\t\t\treached an <code>ACTIVE</code> state. If a container instance is in\n\t\t\t\t<code>REGISTERING</code>, <code>DEREGISTERING</code>, or\n\t\t\t\t<code>REGISTRATION_FAILED</code> state you can describe the container instance but\n\t\t\twill be unable to update the container instance state.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.ecs#UpdateContainerInstancesStateResponse": {
"type": "structure",
"members": {
"containerInstances": {
"target": "com.amazonaws.ecs#ContainerInstances",
"traits": {
"smithy.api#documentation": "<p>The list of container instances.</p>"
}
},
"failures": {
"target": "com.amazonaws.ecs#Failures",
"traits": {
"smithy.api#documentation": "<p>Any failures associated with the call.</p>"
}
}
}
},
"com.amazonaws.ecs#UpdateInProgressException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.ecs#String"
}
},
"traits": {
"smithy.api#documentation": "<p>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 <code>PENDING</code> or <code>STAGING</code>, 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.</p>",
"smithy.api#error": "client"
}
},
"com.amazonaws.ecs#UpdateService": {
"type": "operation",
"input": {
"target": "com.amazonaws.ecs#UpdateServiceRequest"
},
"output": {
"target": "com.amazonaws.ecs#UpdateServiceResponse"
},
"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#ServiceNotActiveException"
},
{
"target": "com.amazonaws.ecs#ServiceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<important>\n\t\t\t <p>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 <a href=\"https://aws.amazon.com/service-terms\">https://aws.amazon.com/service-terms</a> (\"Beta Terms\"). These Beta Terms\n\t\t\t\tapply to your participation in this preview.</p>\n\t\t </important>\n\t\t <p>Modifies the parameters of a service.</p>\n\t\t <p>For services using the rolling update (<code>ECS</code>) 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.</p>\n\t\t <p>For services using the blue/green (<code>CODE_DEPLOY</code>) 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 <a href=\"https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html\">CreateDeployment</a> in the <i>AWS CodeDeploy API Reference</i>.</p>\n\t\t <p>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 <a>CreateTaskSet</a>.</p>\n\t\t <p>You 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\t<code>desiredCount</code> parameter.</p>\n\t\t <p>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.</p>\n\t\t <note>\n\t\t\t <p>If 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, <code>my_image:latest</code>), 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 <code>forceNewDeployment</code> 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.</p>\n\t\t </note>\n\t\t <p>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, <code>minimumHealthyPercent</code> and\n\t\t\t\t<code>maximumPercent</code>, to determine the deployment strategy.</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>If <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore\n\t\t\t\t\t\t<code>desiredCount</code> temporarily during a deployment. For example, if\n\t\t\t\t\t\t<code>desiredCount</code> 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 <code>RUNNING</code> state. Tasks for services that use a load balancer are\n\t\t\t\t\tconsidered healthy if they are in the <code>RUNNING</code> 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.</p>\
}
},
"com.amazonaws.ecs#UpdateServicePrimaryTaskSet": {
"type": "operation",
"input": {
"target": "com.amazonaws.ecs#UpdateServicePrimaryTaskSetRequest"
},
"output": {
"target": "com.amazonaws.ecs#UpdateServicePrimaryTaskSetResponse"
},
"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": "<p>Modifies 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 <code>EXTERNAL</code> deployment controller type. For more\n\t\t\tinformation, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html\">Amazon ECS Deployment\n\t\t\t\tTypes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"com.amazonaws.ecs#UpdateServicePrimaryTaskSetRequest": {
"type": "structure",
"members": {
"cluster": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>",
"smithy.api#required": {}
}
},
"service": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.</p>",
"smithy.api#required": {}
}
},
"primaryTaskSet": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.ecs#UpdateServicePrimaryTaskSetResponse": {
"type": "structure",
"members": {
"taskSet": {
"target": "com.amazonaws.ecs#TaskSet",
"traits": {
"smithy.api#documentation": "<p>Details about the task set.</p>"
}
}
}
},
"com.amazonaws.ecs#UpdateServiceRequest": {
"type": "structure",
"members": {
"cluster": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"service": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The name of the service to update.</p>",
"smithy.api#required": {}
}
},
"desiredCount": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>The number of instantiations of the task to place and keep running in your\n\t\t\tservice.</p>"
}
},
"taskDefinition": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or\n\t\t\tfull ARN of the task definition to run in your service. If a <code>revision</code> is\n\t\t\tnot specified, the latest <code>ACTIVE</code> revision is used. If you modify the task\n\t\t\tdefinition with <code>UpdateService</code>, 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.</p>"
}
},
"capacityProviderStrategy": {
"target": "com.amazonaws.ecs#CapacityProviderStrategy",
"traits": {
"smithy.api#documentation": "<p>The capacity provider strategy to update the service to use.</p>\n\t\t <p>If 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.</p>\n\t\t <p>A capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\t<code>base</code> and <code>weight</code> 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\t<a>PutClusterCapacityProviders</a> API is used to associate a capacity\n\t\t\tprovider with a cluster. Only capacity providers with an <code>ACTIVE</code> or\n\t\t\t\t<code>UPDATING</code> status can be used.</p>\n\t\t <p>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 <a>CreateCapacityProvider</a> API operation.</p>\n\t\t <p>To use a AWS Fargate capacity provider, specify either the <code>FARGATE</code> or\n\t\t\t\t<code>FARGATE_SPOT</code> 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.</p>\n\t\t <p>The <a>PutClusterCapacityProviders</a> API operation is used to update the\n\t\t\tlist of available capacity providers for a cluster after the cluster is created.</p>\n\t\t <p></p>"
}
},
"deploymentConfiguration": {
"target": "com.amazonaws.ecs#DeploymentConfiguration",
"traits": {
"smithy.api#documentation": "<p>Optional deployment parameters that control how many tasks run during the deployment\n\t\t\tand the ordering of stopping and starting tasks.</p>"
}
},
"networkConfiguration": {
"target": "com.amazonaws.ecs#NetworkConfiguration",
"traits": {
"smithy.api#documentation": "<p>An object representing the network configuration for the service.</p>"
}
},
"placementConstraints": {
"target": "com.amazonaws.ecs#PlacementConstraints",
"traits": {
"smithy.api#documentation": "<p>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.</p>\n\t\t <p>You 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).</p>"
}
},
"placementStrategy": {
"target": "com.amazonaws.ecs#PlacementStrategies",
"traits": {
"smithy.api#documentation": "<p>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.</p>\n\t\t <p>You can specify a maximum of five strategy rules per service.</p>"
}
},
"platformVersion": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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 <code>LATEST</code> platform version is used by\n\t\t\tdefault. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">AWS Fargate Platform\n\t\t\t\tVersions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"forceNewDeployment": {
"target": "com.amazonaws.ecs#Boolean",
"traits": {
"smithy.api#documentation": "<p>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 (<code>my_image:latest</code>) or to roll Fargate tasks\n\t\t\tonto a newer platform version.</p>"
}
},
"healthCheckGracePeriodSeconds": {
"target": "com.amazonaws.ecs#BoxedInteger",
"traits": {
"smithy.api#documentation": "<p>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.</p>"
}
},
"enableExecuteCommand": {
"target": "com.amazonaws.ecs#BoxedBoolean",
"traits": {
"smithy.api#documentation": "<p>If <code>true</code>, this enables execute command functionality on all task\n\t\t\tcontainers.</p>\n\t\t <p>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 <code>null</code> when performing this action.</p>"
}
}
}
},
"com.amazonaws.ecs#UpdateServiceResponse": {
"type": "structure",
"members": {
"service": {
"target": "com.amazonaws.ecs#Service",
"traits": {
"smithy.api#documentation": "<p>The full description of your service following the update call.</p>"
}
}
}
},
"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": "<p>Modifies a task set. This is used when a service uses the <code>EXTERNAL</code>\n\t\t\tdeployment controller type. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html\">Amazon ECS Deployment\n\t\t\t\tTypes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"com.amazonaws.ecs#UpdateTaskSetRequest": {
"type": "structure",
"members": {
"cluster": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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.</p>",
"smithy.api#required": {}
}
},
"service": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.</p>",
"smithy.api#required": {}
}
},
"taskSet": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The short name or full Amazon Resource Name (ARN) of the task set to update.</p>",
"smithy.api#required": {}
}
},
"scale": {
"target": "com.amazonaws.ecs#Scale",
"traits": {
"smithy.api#documentation": "<p>A floating-point percentage of the desired number of tasks to place and keep running\n\t\t\tin the task set.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.ecs#UpdateTaskSetResponse": {
"type": "structure",
"members": {
"taskSet": {
"target": "com.amazonaws.ecs#TaskSet",
"traits": {
"smithy.api#documentation": "<p>Details about the task set.</p>"
}
}
}
},
"com.amazonaws.ecs#VersionInfo": {
"type": "structure",
"members": {
"agentVersion": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The version number of the Amazon ECS container agent.</p>"
}
},
"agentHash": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The Git commit hash for the Amazon ECS container agent build on the <a href=\"https://github.com/aws/amazon-ecs-agent/commits/master\">amazon-ecs-agent\n\t\t\t</a> GitHub repository.</p>"
}
},
"dockerVersion": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The Docker version running on the container instance.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The Docker and Amazon ECS container agent version information about a container\n\t\t\tinstance.</p>"
}
},
"com.amazonaws.ecs#Volume": {
"type": "structure",
"members": {
"name": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>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\t<code>sourceVolume</code> parameter of container definition\n\t\t\t<code>mountPoints</code>.</p>"
}
},
"host": {
"target": "com.amazonaws.ecs#HostVolumeProperties",
"traits": {
"smithy.api#documentation": "<p>This parameter is specified when you are using bind mount host volumes. The contents\n\t\t\tof the <code>host</code> parameter determine whether your bind mount host volume\n\t\t\tpersists on the host container instance and where it is stored. If the <code>host</code>\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.</p>\n\t\t <p>Windows containers can mount whole directories on the same drive as\n\t\t\t\t<code>$env:ProgramData</code>. 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\t<code>C:\\my\\path:C:\\my\\path</code> and <code>D:\\:D:\\</code>, but not\n\t\t\t\t<code>D:\\my\\path:C:\\my\\path</code> or <code>D:\\:C:\\my\\path</code>.</p>"
}
},
"dockerVolumeConfiguration": {
"target": "com.amazonaws.ecs#DockerVolumeConfiguration",
"traits": {
"smithy.api#documentation": "<p>This parameter is specified when you are using Docker volumes.</p>\n\t\t <p>Windows containers only support the use of the <code>local</code> driver. To use bind\n\t\t\tmounts, specify the <code>host</code> parameter instead.</p>\n\t\t <note>\n\t\t\t <p>Docker volumes are not supported by tasks run on AWS Fargate.</p>\n\t\t </note>"
}
},
"efsVolumeConfiguration": {
"target": "com.amazonaws.ecs#EFSVolumeConfiguration",
"traits": {
"smithy.api#documentation": "<p>This parameter is specified when you are using an Amazon Elastic File System file system for task\n\t\t\tstorage.</p>"
}
},
"fsxWindowsFileServerVolumeConfiguration": {
"target": "com.amazonaws.ecs#FSxWindowsFileServerVolumeConfiguration",
"traits": {
"smithy.api#documentation": "<p>This parameter is specified when you are using Amazon FSx for Windows File Server file system for task\n\t\t\tstorage.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A data volume used in a task definition. For tasks that use the Amazon Elastic File\n\t\t\tSystem (Amazon EFS), specify an <code>efsVolumeConfiguration</code>. For Windows tasks\n\t\t\tthat use Amazon FSx for Windows File Server file system, specify a\n\t\t\t\t<code>fsxWindowsFileServerVolumeConfiguration</code>. For tasks that use a Docker\n\t\t\tvolume, specify a <code>DockerVolumeConfiguration</code>. For tasks that use a bind\n\t\t\tmount host volume, specify a <code>host</code> and optional <code>sourcePath</code>. For\n\t\t\tmore information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html\">Using Data Volumes in\n\t\t\t\tTasks</a>.</p>"
}
},
"com.amazonaws.ecs#VolumeFrom": {
"type": "structure",
"members": {
"sourceContainer": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The name of another container within the same task definition from which to mount\n\t\t\tvolumes.</p>"
}
},
"readOnly": {
"target": "com.amazonaws.ecs#BoxedBoolean",
"traits": {
"smithy.api#documentation": "<p>If this value is <code>true</code>, the container has read-only access to the volume.\n\t\t\tIf this value is <code>false</code>, then the container can write to the volume. The\n\t\t\tdefault value is <code>false</code>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Details on a data volume from another container in the same task definition.</p>"
}
},
"com.amazonaws.ecs#VolumeFromList": {
"type": "list",
"member": {
"target": "com.amazonaws.ecs#VolumeFrom"
}
},
"com.amazonaws.ecs#VolumeList": {
"type": "list",
"member": {
"target": "com.amazonaws.ecs#Volume"
}
}
}
}