const tags = [ "TAGS" ] ; const launchTypes = [ "EC2" , "FARGATE" , "EXTERNAL" ] ; const schedulingStrategy = [ "REPLICA" , "DAEMON" ] ; const tagsToPropagate = [ "TASK_DEFINITION" , "SERVICE" ] ; const clusterInformation = [ "ATTACHMENTS" , "CONFIGURATIONS" , "SETTINGS" , "STATISTICS" , "TAGS" , ] ; const accountSettingsResourceNames = [ "serviceLongArnFormat" , "taskLongArnFormat" , "containerInstanceLongArnFormat" , "awsvpcTrunking" , "containerInsights" , ] ; const status = [ "ACTIVE" , "DRAINING" , "REGISTERING" , "DEREGISTERING" , "REGISTRATION_FAILED" , ] ; const taskDefinitionFamilyStatus = [ "ACTIVE" , "INACTIVE" , "ALL" ] ; const postPrecessGenerator = ( out , parentKey , childKey = "" ) : Fig . Suggestion [ ] => { try { const list = JSON . parse ( out ) [ parentKey ] ; if ( ! Array . isArray ( list ) ) { return [ { name : list [ childKey ] , icon : "fig://icon?type=aws" , } , ] ; } return list . map ( ( resource ) => { const name = ( childKey ? resource [ childKey ] : resource ) as string ; return { name , icon : "fig://icon?type=aws" , } ; } ) ; } catch ( e ) { console . log ( e ) ; } return [ ] ; } ; const customGenerator = async ( tokens , executeShellCommand , command , options , parentKey , childKey = "" ) : Promise < Fig . Suggestion [ ] > => { try { let cmd = `aws ecs ${ command }` ; for ( const option of options ) { const idx = tokens . indexOf ( option ) ; if ( idx < 0 ) { continue ; } const param = tokens [ idx + 1 ] ; cmd += ` ${ option } ${ param }` ; } const out = await executeShellCommand ( cmd ) ; const list = JSON . parse ( out ) [ parentKey ] ; if ( ! Array . isArray ( list ) ) { return [ { name : list [ childKey ] , icon : "fig://icon?type=aws" , } , ] ; } return list . map ( ( resource ) => { const name = ( childKey ? resource [ childKey ] : resource ) as string ; return { name , icon : "fig://icon?type=aws" , } ; } ) ; } catch ( e ) { console . log ( e ) ; } return [ ] ; } ; const MultiSuggestionsGenerator = async ( tokens , executeShellCommand , enabled ) => { try { const list = [ ] ; const promises = [ ] ; for ( let i = 0 ; i < enabled . length ; i ++ ) { promises [ i ] = executeShellCommand ( enabled [ i ] [ "command" ] ) ; } const result = await Promise . all ( promises ) ; for ( let i = 0 ; i < enabled . length ; i ++ ) { list [ i ] = postPrecessGenerator ( result [ i ] , enabled [ i ] [ "parentKey" ] , enabled [ i ] [ "childKey" ] ) ; } return list . flat ( ) ; } catch ( e ) { console . log ( e ) ; } return [ ] ; } ; const _prefixFile = "file://" ; const appendFolderPath = ( tokens , prefix ) : string => { const baseLSCommand = "\\ls -1ApL " ; let whatHasUserTyped = tokens [ tokens . length - 1 ] ; if ( ! whatHasUserTyped . startsWith ( prefix ) ) { return `echo '${ prefix }'` ; } whatHasUserTyped = whatHasUserTyped . slice ( prefix . length ) ; let folderPath = "" ; const lastSlashIndex = whatHasUserTyped . lastIndexOf ( "/" ) ; if ( lastSlashIndex > - 1 ) { if ( whatHasUserTyped . startsWith ( "/" ) && lastSlashIndex === 0 ) { folderPath = "/" ; } else { folderPath = whatHasUserTyped . slice ( 0 , lastSlashIndex + 1 ) ; } } return baseLSCommand + folderPath ; } ; const postProcessFiles = ( out , prefix ) : Fig . Suggestion [ ] => { if ( out . trim ( ) === prefix ) { return [ { name : prefix , insertValue : prefix , } , ] ; } return sortSuggestions ( out . split ( "\n" ) , false ) ; } ; const triggerPrefix = ( newToken , oldToken , prefix ) : boolean => { if ( ! newToken . startsWith ( prefix ) ) { if ( ! oldToken ) return false ; return oldToken . startsWith ( prefix ) ; } return newToken . lastIndexOf ( "/" ) !== oldToken . lastIndexOf ( "/" ) ; } ; const filterWithPrefix = ( token , prefix ) : string => { if ( ! token . startsWith ( prefix ) ) return token ; return token . slice ( token . lastIndexOf ( "/" ) + 1 ) ; } ; const sortSuggestions = ( arr , isS3 ? ) : Fig . Suggestion [ ] => { const sortFnStrings = ( a , b ) => { return a . localeCompare ( b ) ; } ; const alphabeticalSortFilesAndFolders = ( arr ) => { const dots_arr = [ ] ; const other_arr = [ ] ; arr . map ( ( fsObject ) => { if ( fsObject . toLowerCase ( ) == ".ds_store" ) return ; if ( fsObject . slice ( 0 , 1 ) === "." ) { dots_arr . push ( fsObject ) ; } else { other_arr . push ( fsObject ) ; } } ) ; if ( isS3 ) { return [ ... other_arr . sort ( sortFnStrings ) , ... dots_arr . sort ( sortFnStrings ) , ] ; } return [ ... other_arr . sort ( sortFnStrings ) , "../" , ... dots_arr . sort ( sortFnStrings ) , ] ; } ; const temp_array = alphabeticalSortFilesAndFolders ( arr ) ; const final_array = [ ] ; temp_array . forEach ( ( item ) => { if ( item !== "" && item !== null ) { const outputType = item . slice ( - 1 ) === "/" ? "folder" : "file" ; final_array . push ( { type : outputType , name : item , insertValue : item , } ) ; } } ) ; return final_array ; } ; const generators = { listFiles : { script : ( tokens ) => { return appendFolderPath ( tokens , _prefixFile ) ; } , postProcess : ( out ) => { return postProcessFiles ( out , _prefixFile ) ; } , trigger : ( newToken , oldToken ) => { return triggerPrefix ( newToken , oldToken , _prefixFile ) ; } , getQueryTerm : ( token ) => { return filterWithPrefix ( token , _prefixFile ) ; } , } , listCapacityProviders : { script : "aws ecs describe-capacity-providers" , postProcess : ( out ) => postPrecessGenerator ( out , "capacityProviders" , "name" ) , } , listClusters : { script : "aws ecs list-clusters" , postProcess : ( out ) => postPrecessGenerator ( out , "clusterArns" ) , } , listTaskDefinitions : { script : "aws ecs list-task-definitions" , postProcess : ( out ) => postPrecessGenerator ( out , "taskDefinitionArns" ) , } , listTaskSets : { custom : ( out , executeShellCommand ) => customGenerator ( out , executeShellCommand , "describe-task-sets" , [ "--cluster" , "--service" ] , "taskSets" , "taskSetArn" ) , } , listRoles : { script : "aws iam list-roles" , postProcess : ( out ) => postPrecessGenerator ( out , "Roles" , "RoleName" ) , } , listServices : { script : "aws ecs list-services" , postProcess : ( out ) => postPrecessGenerator ( out , "serviceArns" ) , } , listUsers : { script : "aws iam list-users" , postProcess : ( out ) => postPrecessGenerator ( out , "Users" , "Arn" ) , } , listContainerInstances : { script : "aws ecs list-container-instances" , postProcess : ( out ) => postPrecessGenerator ( out , "containerInstanceArns" ) , } , listTasks : { script : "aws ecs list-tasks" , postProcess : ( out ) => postPrecessGenerator ( out , "taskArns" ) , } , listAttributeNames : { script : "aws ecs list-attributes --target-type container-instance" , postProcess : ( out ) => postPrecessGenerator ( out , "attributes" , "name" ) , } , listAttributeValueForName : { custom : ( out , executeShellCommand ) => customGenerator ( out , executeShellCommand , "list-attributes --target-type container-instance" , [ "--attribute-name" ] , "attributes" , "value" ) , } , listTaskDefinitionFamilies : { script : "aws ecs list-task-definition-families" , postProcess : ( out ) => postPrecessGenerator ( out , "families" ) , } , listStartedBy : { custom : async ( tokens , executeShellCommand ) => { const out = await executeShellCommand ( "aws ecs list-tasks" ) ; const list = JSON . parse ( out ) [ "taskArns" ] ; const tasks = list . map ( ( arn ) => ( { command : `aws ecs describe-tasks --tasks ${ arn }` , parentKey : "tasks" , childKey : "startedBy" , } ) ) ; return MultiSuggestionsGenerator ( tokens , executeShellCommand , [ ... tasks ] ) ; } , } , listTaskGroups : { custom : async ( tokens , executeShellCommand ) => { const idx = tokens . indexOf ( "--cluster" ) ; if ( idx < 0 ) { return ; } const param = tokens [ idx + 1 ] ; const out = await executeShellCommand ( `aws ecs list-tasks --cluster ${ param }` ) ; const list = JSON . parse ( out ) [ "taskArns" ] ; const tasks = list . map ( ( arn ) => ( { command : `aws ecs describe-tasks --tasks ${ arn }` , parentKey : "tasks" , childKey : "group" , } ) ) ; return MultiSuggestionsGenerator ( tokens , executeShellCommand , [ ... tasks ] ) ; } , } , listTagsForResource : { custom : ( out , executeShellCommand ) => customGenerator ( out , executeShellCommand , "aws ecs list-tags-for-resource" , [ "--resource-arn" ] , "tags" , "key" ) , } , listCodedeployApplications : { script : "aws deploy list-applications" , postProcess : ( out ) => postPrecessGenerator ( out , "applications" ) , } , listCodedeployDeploymentGroups : { custom : async ( tokens , executeShellCommand ) => { try { const idx = tokens . indexOf ( "--codedeploy-application" ) ; if ( idx < 0 ) { return ; } const param = tokens [ idx + 1 ] ; const out = await executeShellCommand ( `aws deploy list-deployment-groups --application-name ${ param }` ) ; const list = JSON . parse ( out ) [ "deploymentGroups" ] ; return list . map ( ( group ) => { return { name : group , icon : "fig://icon?type=aws" , } ; } ) ; } catch ( e ) { console . log ( e ) ; } } , } , } ; const completionSpec = { name : "ecs" , description : "Amazon Elastic Container Service Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster. You can host your cluster on a serverless infrastructure that is managed by Amazon ECS by launching your services or tasks on AWS Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage. Amazon ECS makes it easy to launch and stop container-based applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features. You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon ECS eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure" , subcommands : [ { name : "create-capacity-provider" , description : "Creates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used in capacity provider strategies to facilitate cluster auto scaling. Only capacity providers using an Auto Scaling group can be created. Amazon ECS tasks on AWS Fargate use the FARGATE and FARGATE_SPOT capacity providers which are already created and available to all accounts in Regions supported by AWS Fargate" , options : [ { name : "--name" , description : 'The name of the capacity provider. Up to 255 characters are allowed, including letters (upper and lowercase), numbers, underscores, and hyphens. The name cannot be prefixed with "aws", "ecs", or "fargate"' , args : { name : "string" , } , } , { name : "--auto-scaling-group-provider" , description : "The details of the Auto Scaling group for the capacity provider" , args : { name : "structure" , } , } , { name : "--tags" , description : "The metadata that you apply to the capacity provider to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. The following basic restrictions apply to tags:   Maximum number of tags per resource - 50   For each resource, each tag key must be unique, and each tag key can have only one value.   Maximum key length - 128 Unicode characters in UTF-8   Maximum value length - 256 Unicode characters in UTF-8   If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.   Tag keys and values are case-sensitive.   Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit" , args : { name : "list" , isVariadic : true , description : "Key=string,value=string" , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "create-cluster" , description : "Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster action.  When you call the CreateCluster API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account so that required resources in other AWS services can be managed on your behalf. However, if the IAM user that makes the call does not have permissions to create the service-linked role, it is not created. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide" , options : [ { name : "--cluster-name" , description : "The name of your cluster. If you do not specify a name for your cluster, you create a cluster named default. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed" , args : { name : "string" , } , } , { name : "--tags" , description : "The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. The following basic restrictions apply to tags:   Maximum number of tags per resource - 50   For each resource, each tag key must be unique, and each tag key can have only one value.   Maximum key length - 128 Unicode characters in UTF-8   Maximum value length - 256 Unicode characters in UTF-8   If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.   Tag keys and values are case-sensitive.   Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit" , args : { name : "list" , isVariadic : true , description : "Key=string,value=string" , } , } , { name : "--settings" , description : "The setting to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault" , args : { name : "list" , isVariadic : true , suggestions : [ "name=containerInsights,value=enabled" , "name=containerInsights,value=disabled" , ] , } , } , { name : "--configuration" , description : "The execute command configuration for the cluster" , args : { name : "structure" , } , } , { name : "--capacity-providers" , description : "The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the CreateService or RunTask actions. If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created and not already associated with another cluster. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation. To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used. The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created" , args : { name : "list" , isVariadic : true , generators : generators . listCapacityProviders , } , } , { name : "--default-capacity-provider-strategy" , description : "The capacity provider strategy to set as the default for the cluster. When a default capacity provider strategy is set for a cluster, when calling the RunTask or CreateService APIs wtih no capacity provider strategy or launch type specified, the default capacity provider strategy for the cluster is used. If a default capacity provider strategy is not defined for a cluster during creation, it can be defined later with the PutClusterCapacityProviders API operation" , args : { name : "list" , isVariadic : true , description : "CapacityProvider=string,weight=integer,base=integer" , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "create-service" , description : "Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the desiredCount, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, see the UpdateService action. In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide. Tasks for services that do not use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that do use a load balancer are considered healthy if they're in the RUNNING state and the container instance that they're hosted on is reported as healthy by the load balancer. There are two service scheduler strategies available:    REPLICA - The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see Service Scheduler Concepts in the Amazon Elastic Container Service Developer Guide.    DAEMON - The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that do not meet the placement constraints. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see Service Scheduler Concepts in the Amazon Elastic Container Service Developer Guide.   You can optionally specify a deployment configuration for your service. The deployment is triggered by changing properties, such as the task definition or the desired count of a service, with an UpdateService operation. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%. If a service is using the ECS deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that do use a load balancer are considered healthy if they're in the RUNNING state and they're reported as healthy by the load balancer. The default value for minimum healthy percent is 100%. If a service is using the ECS deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desired number of tasks (rounded down to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%. If a service is using either the CODE_DEPLOY or EXTERNAL deployment controller types and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren't used, although they're currently visible when describing your service. When creating a service that uses the EXTERNAL deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide. When the service scheduler launches new tasks, it determines task placement in your cluster using the following logic:   Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).   By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy) with the placementStrategy parameter):   Sort the valid container instances, giving priority to instances that have the fewest number of running tasks for this service in their respective Availability Zone. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.   Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service" , options : [ { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. If you do not specify a cluster, the default cluster is assumed" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--service-name" , description : "The name of your service. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions" , args : { name : "string" , } , } , { name : "--task-definition" , description : "The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used. A task definition must be specified if the service is using either the ECS or CODE_DEPLOY deployment controllers" , args : { name : "string" , generators : generators . listTaskDefinitions , } , } , { name : "--load-balancers" , description : "A load balancer object representing the load balancers to use with your service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide. If the service is using the rolling update (ECS) deployment controller and using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach to the service. The service-linked role is required for services that make use of multiple target groups. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide. If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, AWS CodeDeploy determines which task set in your service has the status PRIMARY and associates one target group with it, and then associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that allows you perform validation tests with Lambda functions before routing production traffic to it. After you create a service using the ECS deployment controller, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable. If you are using the CODE_DEPLOY deployment controller, these values can be changed when updating the service. For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. The load balancer name parameter must be omitted. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here. For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. The target group ARN parameter must be omitted. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here. Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance" , args : { name : "list" , isVariadic : true , description : "TargetGroupArn=string,loadBalancerName=string,containerName=string,containerPort=integer" , } , } , { name : "--service-registries" , description : "The details of the service discovery registries to assign to this service. For more information, see Service discovery.  Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see AWS Fargate platform versions" , args : { name : "list" , isVariadic : true , description : "RegistryArn=string,port=integer,containerName=string,containerPort=integer" , } , } , { name : "--desired-count" , description : "The number of instantiations of the specified task definition to place and keep running on your cluster. This is required if schedulingStrategy is REPLICA or is not specified. If schedulingStrategy is DAEMON then this is not required" , args : { name : "integer" , } , } , { name : "--client-token" , description : "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed" , args : { name : "string" , } , } , { name : "--launch-type" , description : "The launch type on which to run your service. The accepted values are FARGATE and EC2. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide. When a value of FARGATE is specified, your tasks are launched on AWS Fargate On-Demand infrastructure. To use Fargate Spot, you must use a capacity provider strategy with the FARGATE_SPOT capacity provider. When a value of EC2 is specified, your tasks are launched on Amazon EC2 instances registered to your cluster. If a launchType is specified, the capacityProviderStrategy parameter must be omitted" , args : { name : "string" , suggestions : launchTypes , } , } , { name : "--capacity-provider-strategy" , description : "The capacity provider strategy to use for the service. If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used" , args : { name : "list" , isVariadic : true , description : "CapacityProvider=string,weight=integer,base=integer" , } , } , { name : "--platform-version" , description : "The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default. For more information, see AWS Fargate platform versions in the Amazon Elastic Container Service Developer Guide" , args : { name : "string" , } , } , { name : "--role" , description : "The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.  If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you should not specify a role here. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.  If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide" , args : { name : "string" , generators : generators . listRoles , } , } , { name : "--deployment-configuration" , description : "Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks" , args : { name : "structure" , isVariadic : true , } , } , { name : "--placement-constraints" , description : "An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime)" , args : { name : "list" , isVariadic : true , description : "Type=distinctInstance|memberOf,expression=string" , } , } , { name : "--placement-strategy" , description : "The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules per service" , args : { name : "list" , isVariadic : true , description : "Type=random|spread|binpack,field=string" , } , } , { name : "--network-configuration" , description : "The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide" , args : { name : "structure" , description : "AwsvpcConfiguration={subnets=[string,string],securityGroups=[string,string],assignPublicIp=ENABLED|DISABLED}" , } , } , { name : "--health-check-grace-period-seconds" , description : "The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of 0 is used. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up" , args : { name : "integer" , } , } , { name : "--scheduling-strategy" , description : "The scheduling strategy to use for the service. For more information, see Services. There are two service scheduler strategies available:    REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service is using the CODE_DEPLOY or EXTERNAL deployment controller types.    DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that do not meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.  Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy" , args : { name : "string" , suggestions : [ "REPLICA" , "DAEMON" ] , } , } , { name : "--deployment-controller" , description : "The deployment controller to use for the service" , args : { name : "structure" , suggestions : [ "type=ECS" , "type=CODE_DEPLOY" , "type=EXTERNAL" ] , } , } , { name : "--tags" , description : "The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well. The following basic restrictions apply to tags:   Maximum number of tags per resource - 50   For each resource, each tag key must be unique, and each tag key can have only one value.   Maximum key length - 128 Unicode characters in UTF-8   Maximum value length - 256 Unicode characters in UTF-8   If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.   Tag keys and values are case-sensitive.   Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit" , args : { name : "list" , isVariadic : true , description : "Key=string,value=string" , } , } , { name : "--enable-ecs-managed-tags" , description : "Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide" , } , { name : "--no-enable-ecs-managed-tags" , description : "Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide" , } , { name : "--propagate-tags" , description : "Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the TagResource API action" , args : { name : "string" , suggestions : [ "TASK_DEFINITION" , "SERVICE" ] , } , } , { name : "--enable-execute-command" , description : "Whether or not the execute command functionality is enabled for the service. If true, this enables execute command functionality on all containers in the service tasks" , } , { name : "--disable-execute-command" , description : "Whether or not the execute command functionality is enabled for the service. If true, this enables execute command functionality on all containers in the service tasks" , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "create-task-set" , description : "Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide" , options : [ { name : "--service" , description : "The short name or full Amazon Resource Name (ARN) of the service to create the task set in" , args : { name : "string" , generators : generators . listServices , } , } , { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--external-id" , description : "An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value" , args : { name : "string" , } , } , { name : "--task-definition" , description : "The task definition for the tasks in the task set to use" , args : { name : "string" , generators : generators . listTaskDefinitions , } , } , { name : "--network-configuration" , description : "An object representing the network configuration for a task or service" , args : { name : "structure" , description : "AwsvpcConfiguration={subnets=[string,string],securityGroups=[string,string],assignPublicIp=string}" , } , } , { name : "--load-balancers" , description : "A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer" , args : { name : "list" , isVariadic : true , description : "TargetGroupArn=string,loadBalancerName=string,containerName=string,containerPort=integer" , } , } , { name : "--service-registries" , description : "The details of the service discovery registries to assign to this task set. For more information, see Service Discovery" , args : { name : "list" , isVariadic : true , description : "RegistryArn=string,port=integer,containerName=string,containerPort=integer" , } , } , { name : "--launch-type" , description : "The launch type that new tasks in the task set will use. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide. If a launchType is specified, the capacityProviderStrategy parameter must be omitted" , args : { name : "string" , suggestions : launchTypes , } , } , { name : "--capacity-provider-strategy" , description : "The capacity provider strategy to use for the task set. A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used. If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used. If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation. To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used. The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created" , args : { name : "list" , isVariadic : true , description : "CapacityProvider=string,weight=integer,base=integer" , } , } , { name : "--platform-version" , description : "The platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default" , args : { name : "string" , } , } , { name : "--scale" , description : "A floating-point percentage of the desired number of tasks to place and keep running in the task set" , args : { name : "structure" , description : "Value=double,unit=string" , } , } , { name : "--client-token" , description : "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed" , args : { name : "string" , } , } , { name : "--tags" , description : "The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well. The following basic restrictions apply to tags:   Maximum number of tags per resource - 50   For each resource, each tag key must be unique, and each tag key can have only one value.   Maximum key length - 128 Unicode characters in UTF-8   Maximum value length - 256 Unicode characters in UTF-8   If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.   Tag keys and values are case-sensitive.   Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit" , args : { name : "list" , isVariadic : true , description : "Key=string,value=string" , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "delete-account-setting" , description : "Disables an account setting for a specified IAM user, IAM role, or the root user for an account" , options : [ { name : "--name" , description : "The resource name for which to disable the account setting. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected. If awsvpcTrunking is specified, the ENI limit for your Amazon ECS container instances is affected" , args : { name : "string" , suggestions : accountSettingsResourceNames , } , } , { name : "--principal-arn" , description : "The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you specify the root user, it disables the account setting for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user" , args : { name : "string" , generators : [ generators . listRoles , generators . listUsers ] , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listUsers , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "delete-attributes" , description : "Deletes one or more custom attributes from an Amazon ECS resource" , options : [ { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete attributes. If you do not specify a cluster, the default cluster is assumed" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--attributes" , description : "The attributes to delete from your resource. You can specify up to 10 attributes per request. For custom attributes, specify the attribute name and target ID, but do not specify the value. If you specify the target ID using the short form, you must also specify the target type" , args : { name : "list" , isVariadic : true , description : "Name=string,value=string,targetType=string,targetId=string" , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "delete-capacity-provider" , description : "Deletes the specified capacity provider.  The FARGATE and FARGATE_SPOT capacity providers are reserved and cannot be deleted. You can disassociate them from a cluster using either the PutClusterCapacityProviders API or by deleting the cluster.  Prior to a capacity provider being deleted, the capacity provider must be removed from the capacity provider strategy from all services. The UpdateService API can be used to remove a capacity provider from a service's capacity provider strategy. When updating a service, the forceNewDeployment option can be used to ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity provider are transitioned to use the capacity from the remaining capacity providers. Only capacity providers that are not associated with a cluster can be deleted. To remove a capacity provider from a cluster, you can either use PutClusterCapacityProviders or delete the cluster" , options : [ { name : "--capacity-provider" , description : "The short name or full Amazon Resource Name (ARN) of the capacity provider to delete" , args : { name : "string" , generators : generators . listCapacityProviders , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "delete-cluster" , description : "Deletes the specified cluster. The cluster will transition to the INACTIVE state. Clusters with an INACTIVE status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future, so you should not rely on INACTIVE clusters persisting. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance" , options : [ { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN) of the cluster to delete" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "delete-service" , description : "Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you cannot delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService.  When you delete a service, if there are still running tasks that require cleanup, the service status moves from ACTIVE to DRAINING, and the service is no longer visible in the console or in the ListServices API operation. After all tasks have transitioned to either STOPPING or STOPPED status, the service status moves from DRAINING to INACTIVE. Services in the DRAINING or INACTIVE status can still be viewed with the DescribeServices API operation. However, in the future, INACTIVE services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices calls on those services return a ServiceNotFoundException error.   If you attempt to create a new service with the same name as an existing service in either ACTIVE or DRAINING status, you receive an error" , options : [ { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--service" , description : "The name of the service to delete" , args : { name : "string" , generators : generators . listServices , } , } , { name : "--force" , description : "If true, allows you to delete a service even if it has not been scaled down to zero tasks. It is only necessary to use this if the service is using the REPLICA scheduling strategy" , } , { name : "--no-force" , description : "If true, allows you to delete a service even if it has not been scaled down to zero tasks. It is only necessary to use this if the service is using the REPLICA scheduling strategy" , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "delete-task-set" , description : "Deletes a specified task set within a service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide" , options : [ { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in to delete" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--service" , description : "The short name or full Amazon Resource Name (ARN) of the service that hosts the task set to delete" , args : { name : "string" , generators : generators . listServices , } , } , { name : "--task-set" , description : "The task set ID or full Amazon Resource Name (ARN) of the task set to delete" , args : { name : "string" , generators : generators . listTaskSets , } , } , { name : "--force" , description : "If true, this allows you to delete a task set even if it hasn't been scaled down to zero" , } , { name : "--no-force" , description : "If true, this allows you to delete a task set even if it hasn't been scaled down to zero" , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "deregister-container-instance" , description : "Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks. If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration. That prevents any orphaned tasks from consuming resources. Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.  If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents are not automatically deregistered when terminated)" , options : [ { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--container-instance" , description : "The container instance ID or full ARN of the container instance to deregister. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID" , args : { name : "string" , generators : generators . listContainerInstances , } , } , { name : "--force" , description : "Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible.  Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group" , } , { name : "--no-force" , description : "Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible.  Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group" , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "deregister-task-definition" , description : "Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE. Existing tasks and services that reference an INACTIVE task definition continue to run without disruption. Existing services that reference an INACTIVE task definition can still scale up or down by modifying the service's desired count. You cannot use an INACTIVE task definition to run new tasks or create new services, and you cannot update an existing service to reference an INACTIVE task definition. However, there may be up to a 10-minute window following deregistration where these restrictions have not yet taken effect.  At this time, INACTIVE task definitions remain discoverable in your account indefinitely. However, this behavior is subject to change in the future, so you should not rely on INACTIVE task definitions persisting beyond the lifecycle of any associated tasks and services" , options : [ { name : "--task-definition" , description : "The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to deregister. You must specify a revision" , args : { name : "string" , generators : generators . listTaskDefinitions , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "describe-capacity-providers" , description : "Describes one or more of your capacity providers" , options : [ { name : "--capacity-providers" , description : "The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100 capacity providers can be described in an action" , args : { name : "list" , isVariadic : true , generators : generators . listCapacityProviders , } , } , { name : "--include" , description : "Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response" , args : { name : "list" , isVariadic : true , suggestions : tags , } , } , { name : "--max-results" , description : "The maximum number of account setting results returned by DescribeCapacityProviders in paginated output. When this parameter is used, DescribeCapacityProviders only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeCapacityProviders request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then DescribeCapacityProviders returns up to 10 results and a nextToken value if applicable" , args : { name : "integer" , } , } , { name : "--next-token" , description : "The nextToken value returned from a previous paginated DescribeCapacityProviders request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.  This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes" , args : { name : "string" , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "describe-clusters" , description : "Describes one or more of your clusters" , options : [ { name : "--clusters" , description : "A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed" , args : { name : "list" , isVariadic : true , generators : generators . listClusters , } , } , { name : "--include" , description : "Whether to include additional information about your clusters in the response. If this field is omitted, the attachments, statistics, and tags are not included. If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included. If SETTINGS is specified, the settings for the cluster are included. If STATISTICS is specified, the following additional information, separated by launch type, is included:   runningEC2TasksCount   runningFargateTasksCount   pendingEC2TasksCount   pendingFargateTasksCount   activeEC2ServiceCount   activeFargateServiceCount   drainingEC2ServiceCount   drainingFargateServiceCount   If TAGS is specified, the metadata tags associated with the cluster are included" , args : { name : "list" , isVariadic : true , suggestions : clusterInformation , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "describe-container-instances" , description : "Describes Amazon Elastic Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested" , options : [ { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance or container instances you are describing were launched in any cluster other than the default cluster" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--container-instances" , description : "A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries" , args : { name : "list" , isVariadic : true , generators : generators . listContainerInstances , } , } , { name : "--include" , description : "Specifies whether you want to see the resource tags for the container instance. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response" , args : { name : "list" , isVariadic : true , suggestions : tags , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "describe-services" , description : "Describes the specified services running in your cluster" , options : [ { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the service or services you are describing were launched in any cluster other than the default cluster" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--services" , description : "A list of services to describe. You may specify up to 10 services to describe in a single operation" , args : { name : "list" , isVariadic : true , generators : generators . listServices , } , } , { name : "--include" , description : "Specifies whether you want to see the resource tags for the service. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response" , args : { name : "list" , isVariadic : true , suggestions : tags , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "describe-task-definition" , description : "Describes a task definition. You can specify a family and revision to find information about a specific task definition, or you can simply specify the family to find the latest ACTIVE revision in that family.  You can only describe INACTIVE task definitions while an active task or service references them" , options : [ { name : "--task-definition" , description : "The family for the latest ACTIVE revision, family and revision (family:revision) for a specific revision in the family, or full Amazon Resource Name (ARN) of the task definition to describe" , args : { name : "string" , generators : generators . listTaskDefinitions , } , } , { name : "--include" , description : "Specifies whether to see the resource tags for the task definition. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response" , args : { name : "list" , isVariadic : true , suggestions : tags , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "describe-task-sets" , description : "Describes the task sets in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide" , options : [ { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--service" , description : "The short name or full Amazon Resource Name (ARN) of the service that the task sets exist in" , args : { name : "string" , generators : generators . listServices , } , } , { name : "--task-sets" , description : "The ID or full Amazon Resource Name (ARN) of task sets to describe" , args : { name : "list" , isVariadic : true , generators : generators . listTaskSets , } , } , { name : "--include" , description : "Specifies whether to see the resource tags for the task set. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response" , args : { name : "list" , isVariadic : true , suggestions : tags , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "describe-tasks" , description : "Describes a specified task or tasks" , options : [ { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you are describing were launched in any cluster other than the default cluster" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--tasks" , description : "A list of up to 100 task IDs or full ARN entries" , args : { name : "list" , isVariadic : true , generators : generators . listTasks , } , } , { name : "--include" , description : "Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response" , args : { name : "list" , isVariadic : true , suggestions : tags , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "discover-poll-endpoint" , description : "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.  Returns an endpoint for the Amazon ECS agent to poll for updates" , options : [ { name : "--container-instance" , description : "The container instance ID or full ARN of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID" , args : { name : "string" , generators : generators . listContainerInstances , } , } , { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN) of the cluster to which the container instance belongs" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "execute-command" , description : "Runs a command remotely on a container within a task" , options : [ { name : "--cluster" , description : "The Amazon Resource Name (ARN) or short name of the cluster the task is running in. If you do not specify a cluster, the default cluster is assumed" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--container" , description : "The name of the container to execute the command on. A container name only needs to be specified for tasks containing multiple containers" , args : { name : "string" , } , } , { name : "--command" , description : "The command to run on the container" , args : { name : "string" , } , } , { name : "--interactive" , description : "Use this flag to run your command in interactive mode" , } , { name : "--task" , description : "The Amazon Resource Name (ARN) or ID of the task the container is part of" , args : { name : "string" , generators : generators . listTasks , } , } , { name : "--non-interactive" , description : "Use this flag to run your command in interactive mode" , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "list-account-settings" , description : "Lists the account settings for a specified principal" , options : [ { name : "--name" , description : "The name of the account setting you want to list the settings for" , args : { name : "string" , suggestions : accountSettingsResourceNames , } , } , { name : "--value" , description : "The value of the account settings with which to filter results. You must also specify an account setting name to use this parameter" , args : { name : "string" , } , } , { name : "--principal-arn" , description : "The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user" , args : { name : "string" , generators : [ generators . listRoles , generators . listUsers ] , } , } , { name : "--effective-settings" , description : "Specifies whether to return the effective settings. If true, the account settings for the root user or the default setting for the principalArn are returned. If false, the account settings for the principalArn are returned if they are set. Otherwise, no account settings are returned" , } , { name : "--no-effective-settings" , description : "Specifies whether to return the effective settings. If true, the account settings for the root user or the default setting for the principalArn are returned. If false, the account settings for the principalArn are returned if they are set. Otherwise, no account settings are returned" , } , { name : "--next-token" , description : "The nextToken value returned from a ListAccountSettings request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.  This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes" , args : { name : "string" , } , } , { name : "--max-results" , description : "The maximum number of account setting results returned by ListAccountSettings in paginated output. When this parameter is used, ListAccountSettings only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAccountSettings request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then ListAccountSettings returns up to 10 results and a nextToken value if applicable" , args : { name : "integer" , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--starting-token" , description : "A token to specify where to start paginating.  This is the\nNextToken from a previously truncated response.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide" , args : { name : "string" , } , } , { name : "--page-size" , description : "The size of each page to get in the AWS service call.  This\ndoes not affect the number of items returned in the command's\noutput.  Setting a smaller page size results in more calls to\nthe AWS service, retrieving fewer items in each call.  This can\nhelp prevent the AWS service calls from timing out.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide" , args : { name : "integer" , } , } , { name : "--max-items" , description : "The total number of items to return in the command's output.\nIf the total number of items available is more than the value\nspecified, a NextToken is provided in the command's\noutput.  To resume pagination, provide the\nNextToken value in the starting-token\nargument of a subsequent command.  Do not use the\nNextToken response element directly outside of the\nAWS CLI.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide" , args : { name : "integer" , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "list-attributes" , description : "Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, ListAttributes returns a list of attribute objects, one for each attribute on each resource. You can filter the list of results to a single attribute name to only return results that have that name. You can also filter the results by attribute name and value, for example, to see which container instances in a cluster are running a Linux AMI (ecs.os-type=linux)" , options : [ { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--target-type" , description : "The type of the target with which to list attributes" , args : { name : "string" , suggestions : [ "container-instance" ] , } , } , { name : "--attribute-name" , description : "The name of the attribute with which to filter the results" , args : { name : "string" , generators : generators . listAttributeNames , } , } , { name : "--attribute-value" , description : "The value of the attribute with which to filter results. You must also specify an attribute name to use this parameter" , args : { name : "string" , generators : generators . listAttributeValueForName , } , } , { name : "--next-token" , description : "The nextToken value returned from a ListAttributes request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.  This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes" , args : { name : "string" , } , } , { name : "--max-results" , description : "The maximum number of cluster results returned by ListAttributes in paginated output. When this parameter is used, ListAttributes only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAttributes request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListAttributes returns up to 100 results and a nextToken value if applicable" , args : { name : "integer" , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--starting-token" , description : "A token to specify where to start paginating.  This is the\nNextToken from a previously truncated response.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide" , args : { name : "string" , } , } , { name : "--page-size" , description : "The size of each page to get in the AWS service call.  This\ndoes not affect the number of items returned in the command's\noutput.  Setting a smaller page size results in more calls to\nthe AWS service, retrieving fewer items in each call.  This can\nhelp prevent the AWS service calls from timing out.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide" , args : { name : "integer" , } , } , { name : "--max-items" , description : "The total number of items to return in the command's output.\nIf the total number of items available is more than the value\nspecified, a NextToken is provided in the command's\noutput.  To resume pagination, provide the\nNextToken value in the starting-token\nargument of a subsequent command.  Do not use the\nNextToken response element directly outside of the\nAWS CLI.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide" , args : { name : "integer" , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "list-clusters" , description : "Returns a list of existing clusters" , options : [ { name : "--next-token" , description : "The nextToken value returned from a ListClusters request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.  This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes" , args : { name : "string" , } , } , { name : "--max-results" , description : "The maximum number of cluster results returned by ListClusters in paginated output. When this parameter is used, ListClusters only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListClusters returns up to 100 results and a nextToken value if applicable" , args : { name : "integer" , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--starting-token" , description : "A token to specify where to start paginating.  This is the\nNextToken from a previously truncated response.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide" , args : { name : "string" , } , } , { name : "--page-size" , description : "The size of each page to get in the AWS service call.  This\ndoes not affect the number of items returned in the command's\noutput.  Setting a smaller page size results in more calls to\nthe AWS service, retrieving fewer items in each call.  This can\nhelp prevent the AWS service calls from timing out.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide" , args : { name : "integer" , } , } , { name : "--max-items" , description : "The total number of items to return in the command's output.\nIf the total number of items available is more than the value\nspecified, a NextToken is provided in the command's\noutput.  To resume pagination, provide the\nNextToken value in the starting-token\nargument of a subsequent command.  Do not use the\nNextToken response element directly outside of the\nAWS CLI.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide" , args : { name : "integer" , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "list-container-instances" , description : "Returns a list of container instances in a specified cluster. You can filter the results of a ListContainerInstances operation with cluster query language statements inside the filter parameter. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide" , options : [ { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--filter" , description : "You can filter the results of a ListContainerInstances operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide" , args : { name : "string" , } , } , { name : "--next-token" , description : "The nextToken value returned from a ListContainerInstances request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.  This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes" , args : { name : "string" , } , } , { name : "--max-results" , description : "The maximum number of container instance results returned by ListContainerInstances in paginated output. When this parameter is used, ListContainerInstances only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable" , args : { name : "integer" , } , } , { name : "--status" , description : "Filters the container instances by status. For example, if you specify the DRAINING status, the results include only container instances that have been set to DRAINING using UpdateContainerInstancesState. If you do not specify this parameter, the default is to include container instances set to all states other than INACTIVE" , args : { name : "string" , suggestions : status , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--starting-token" , description : "A token to specify where to start paginating.  This is the\nNextToken from a previously truncated response.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide" , args : { name : "string" , } , } , { name : "--page-size" , description : "The size of each page to get in the AWS service call.  This\ndoes not affect the number of items returned in the command's\noutput.  Setting a smaller page size results in more calls to\nthe AWS service, retrieving fewer items in each call.  This can\nhelp prevent the AWS service calls from timing out.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide" , args : { name : "integer" , } , } , { name : "--max-items" , description : "The total number of items to return in the command's output.\nIf the total number of items available is more than the value\nspecified, a NextToken is provided in the command's\noutput.  To resume pagination, provide the\nNextToken value in the starting-token\nargument of a subsequent command.  Do not use the\nNextToken response element directly outside of the\nAWS CLI.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide" , args : { name : "integer" , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "list-services" , description : "Lists the services that are running in a specified cluster" , options : [ { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the services to list. If you do not specify a cluster, the default cluster is assumed" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--next-token" , description : "The nextToken value returned from a ListServices request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.  This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes" , args : { name : "string" , } , } , { name : "--max-results" , description : "The maximum number of service results returned by ListServices in paginated output. When this parameter is used, ListServices only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListServices request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListServices returns up to 10 results and a nextToken value if applicable" , args : { name : "integer" , } , } , { name : "--launch-type" , description : "The launch type for the services to list" , args : { name : "string" , suggestions : launchTypes , } , } , { name : "--scheduling-strategy" , description : "The scheduling strategy for services to list" , args : { name : "string" , suggestions : schedulingStrategy , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--starting-token" , description : "A token to specify where to start paginating.  This is the\nNextToken from a previously truncated response.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide" , args : { name : "string" , } , } , { name : "--page-size" , description : "The size of each page to get in the AWS service call.  This\ndoes not affect the number of items returned in the command's\noutput.  Setting a smaller page size results in more calls to\nthe AWS service, retrieving fewer items in each call.  This can\nhelp prevent the AWS service calls from timing out.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide" , args : { name : "integer" , } , } , { name : "--max-items" , description : "The total number of items to return in the command's output.\nIf the total number of items available is more than the value\nspecified, a NextToken is provided in the command's\noutput.  To resume pagination, provide the\nNextToken value in the starting-token\nargument of a subsequent command.  Do not use the\nNextToken response element directly outside of the\nAWS CLI.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide" , args : { name : "integer" , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "list-tags-for-resource" , description : "List the tags for an Amazon ECS resource" , options : [ { name : "--resource-arn" , description : "The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances" , args : { name : "string" , generators : [ generators . listTasks , generators . listTaskDefinitions , generators . listClusters , generators . listServices , generators . listContainerInstances , ] , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "list-task-definition-families" , description : "Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any ACTIVE task definition revisions). You can filter out task definition families that do not contain any ACTIVE task definition revisions by setting the status parameter to ACTIVE. You can also filter the results with the familyPrefix parameter" , options : [ { name : "--family-prefix" , description : "The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family names that begin with the familyPrefix string are returned" , args : { name : "string" , } , } , { name : "--status" , description : "The task definition family status with which to filter the ListTaskDefinitionFamilies results. By default, both ACTIVE and INACTIVE task definition families are listed. If this parameter is set to ACTIVE, only task definition families that have an ACTIVE task definition revision are returned. If this parameter is set to INACTIVE, only task definition families that do not have any ACTIVE task definition revisions are returned. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request" , args : { name : "string" , suggestions : taskDefinitionFamilyStatus , } , } , { name : "--next-token" , description : "The nextToken value returned from a ListTaskDefinitionFamilies request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.  This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes" , args : { name : "string" , } , } , { name : "--max-results" , description : "The maximum number of task definition family results returned by ListTaskDefinitionFamilies in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitionFamilies request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken value if applicable" , args : { name : "integer" , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--starting-token" , description : "A token to specify where to start paginating.  This is the\nNextToken from a previously truncated response.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide" , args : { name : "string" , } , } , { name : "--page-size" , description : "The size of each page to get in the AWS service call.  This\ndoes not affect the number of items returned in the command's\noutput.  Setting a smaller page size results in more calls to\nthe AWS service, retrieving fewer items in each call.  This can\nhelp prevent the AWS service calls from timing out.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide" , args : { name : "integer" , } , } , { name : "--max-items" , description : "The total number of items to return in the command's output.\nIf the total number of items available is more than the value\nspecified, a NextToken is provided in the command's\noutput.  To resume pagination, provide the\nNextToken value in the starting-token\nargument of a subsequent command.  Do not use the\nNextToken response element directly outside of the\nAWS CLI.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide" , args : { name : "integer" , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "list-task-definitions" , description : "Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter or by status with the status parameter" , options : [ { name : "--family-prefix" , description : "The full family name with which to filter the ListTaskDefinitions results. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family" , args : { name : "string" , } , } , { name : "--status" , description : "The task definition status with which to filter the ListTaskDefinitions results. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request" , args : { name : "string" , suggestions : [ "ACTIVE" , "INACTIVE" ] , } , } , { name : "--sort" , description : "The order in which to sort the results. Valid values are ASC and DESC. By default (ASC), task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision so that the newest task definitions in a family are listed first" , args : { name : "string" , suggestions : [ "ASC" , "DESC" ] , } , } , { name : "--next-token" , description : "The nextToken value returned from a ListTaskDefinitions request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.  This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes" , args : { name : "string" , } , } , { name : "--max-results" , description : "The maximum number of task definition results returned by ListTaskDefinitions in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable" , args : { name : "integer" , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--starting-token" , description : "A token to specify where to start paginating.  This is the\nNextToken from a previously truncated response.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide" , args : { name : "string" , } , } , { name : "--page-size" , description : "The size of each page to get in the AWS service call.  This\ndoes not affect the number of items returned in the command's\noutput.  Setting a smaller page size results in more calls to\nthe AWS service, retrieving fewer items in each call.  This can\nhelp prevent the AWS service calls from timing out.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide" , args : { name : "integer" , } , } , { name : "--max-items" , description : "The total number of items to return in the command's output.\nIf the total number of items available is more than the value\nspecified, a NextToken is provided in the command's\noutput.  To resume pagination, provide the\nNextToken value in the starting-token\nargument of a subsequent command.  Do not use the\nNextToken response element directly outside of the\nAWS CLI.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide" , args : { name : "integer" , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "list-tasks" , description : "Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the family, containerInstance, and desiredStatus parameters. Recently stopped tasks might appear in the returned results. Currently, stopped tasks appear in the returned results for at least one hour" , options : [ { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list. If you do not specify a cluster, the default cluster is assumed" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--container-instance" , description : "The container instance ID or full ARN of the container instance with which to filter the ListTasks results. Specifying a containerInstance limits the results to tasks that belong to that container instance" , args : { name : "string" , generators : generators . listContainerInstances , } , } , { name : "--family" , description : "The name of the family with which to filter the ListTasks results. Specifying a family limits the results to tasks that belong to that family" , args : { name : "string" , generators : generators . listTaskDefinitionFamilies , } , } , { name : "--next-token" , description : "The nextToken value returned from a ListTasks request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.  This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes" , args : { name : "string" , } , } , { name : "--max-results" , description : "The maximum number of task results returned by ListTasks in paginated output. When this parameter is used, ListTasks only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTasks request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTasks returns up to 100 results and a nextToken value if applicable" , args : { name : "integer" , } , } , { name : "--started-by" , description : "The startedBy value with which to filter the task results. Specifying a startedBy value limits the results to tasks that were started with that value" , args : { name : "string" , generators : generators . listStartedBy , } , } , { name : "--service-name" , description : "The name of the service with which to filter the ListTasks results. Specifying a serviceName limits the results to tasks that belong to that service" , args : { name : "string" , } , } , { name : "--desired-status" , description : "The task desired status with which to filter the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the desired status to STOPPED. This can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that Amazon ECS has set the desired status to RUNNING.  Although you can filter results based on a desired status of PENDING, this does not return any results. Amazon ECS never sets the desired status of a task to that value (only a task's lastStatus may have a value of PENDING)" , args : { name : "string" , suggestions : [ "RUNNING" , "PENDING" , "STOPPED" ] , } , } , { name : "--launch-type" , description : "The launch type for services to list" , args : { name : "string" , suggestions : launchTypes , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--starting-token" , description : "A token to specify where to start paginating.  This is the\nNextToken from a previously truncated response.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide" , args : { name : "string" , } , } , { name : "--page-size" , description : "The size of each page to get in the AWS service call.  This\ndoes not affect the number of items returned in the command's\noutput.  Setting a smaller page size results in more calls to\nthe AWS service, retrieving fewer items in each call.  This can\nhelp prevent the AWS service calls from timing out.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide" , args : { name : "integer" , } , } , { name : "--max-items" , description : "The total number of items to return in the command's output.\nIf the total number of items available is more than the value\nspecified, a NextToken is provided in the command's\noutput.  To resume pagination, provide the\nNextToken value in the starting-token\nargument of a subsequent command.  Do not use the\nNextToken response element directly outside of the\nAWS CLI.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide" , args : { name : "integer" , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "put-account-setting" , description : "Modifies an account setting. Account settings are set on a per-Region basis. If you change the account setting for the root user, the default settings for all of the IAM users and roles for which no individual account setting has been specified are reset. For more information, see Account Settings in the Amazon Elastic Container Service Developer Guide. When serviceLongArnFormat, taskLongArnFormat, or containerInstanceLongArnFormat are specified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified IAM user, IAM role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource will be defined by the opt-in status of the IAM user or role that created the resource. You must enable this setting to use Amazon ECS features such as resource tagging. When awsvpcTrunking is specified, the elastic network interface (ENI) limit for any new container instances that support the feature is changed. If awsvpcTrunking is enabled, any new container instances that support the feature are launched have the increased ENI limits available to them. For more information, see Elastic Network Interface Trunking in the Amazon Elastic Container Service Developer Guide. When containerInsights is specified, the default setting indicating whether CloudWatch Container Insights is enabled for your clusters is changed. If containerInsights is enabled, any new clusters that are created will have Container Insights enabled unless you disable it during cluster creation. For more information, see CloudWatch Container Insights in the Amazon Elastic Container Service Developer Guide" , options : [ { name : "--name" , description : "The Amazon ECS resource name for which to modify the account setting. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected. If awsvpcTrunking is specified, the elastic network interface (ENI) limit for your Amazon ECS container instances is affected. If containerInsights is specified, the default setting for CloudWatch Container Insights for your clusters is affected" , args : { name : "string" , suggestions : accountSettingsResourceNames , } , } , { name : "--value" , description : "The account setting value for the specified principal ARN. Accepted values are enabled and disabled" , args : { name : "string" , suggestions : [ "enabled" , "disabled" ] , } , } , { name : "--principal-arn" , description : "The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you specify the root user, it modifies the account setting for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user" , args : { name : "string" , generators : [ generators . listRoles , generators . listUsers ] , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "put-account-setting-default" , description : "Modifies an account setting for all IAM users on an account for whom no individual account setting has been specified. Account settings are set on a per-Region basis" , options : [ { name : "--name" , description : "The resource name for which to modify the account setting. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected. If awsvpcTrunking is specified, the ENI limit for your Amazon ECS container instances is affected. If containerInsights is specified, the default setting for CloudWatch Container Insights for your clusters is affected" , args : { name : "string" , suggestions : accountSettingsResourceNames , } , } , { name : "--value" , description : "The account setting value for the specified principal ARN. Accepted values are enabled and disabled" , args : { name : "string" , suggestions : [ "enabled" , "disabled" ] , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "put-attributes" , description : "Create or update an attribute on an Amazon ECS resource. If the attribute does not exist, it is created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use DeleteAttributes. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide" , options : [ { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply attributes. If you do not specify a cluster, the default cluster is assumed" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--attributes" , description : "The attributes to apply to your resource. You can specify up to 10 custom attributes per resource. You can specify up to 10 attributes in a single call" , args : { name : "list" , isVariadic : true , description : "Name=string,value=string,targetType=string,targetId=string" , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "put-cluster-capacity-providers" , description : "Modifies the available capacity providers and the default capacity provider strategy for a cluster. You must specify both the available capacity providers and a default capacity provider strategy for the cluster. If the specified cluster has existing capacity providers associated with it, you must specify all existing capacity providers in addition to any new ones you want to add. Any existing capacity providers associated with a cluster that are omitted from a PutClusterCapacityProviders API call will be disassociated with the cluster. You can only disassociate an existing capacity provider from a cluster if it's not being used by any existing tasks. When creating a service or running a task on a cluster, if no capacity provider or launch type is specified, then the cluster's default capacity provider strategy is used. It is recommended to define a default capacity provider strategy for your cluster, however you may specify an empty array ([]) to bypass defining a default strategy" , options : [ { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you do not specify a cluster, the default cluster is assumed" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--capacity-providers" , description : "The name of one or more capacity providers to associate with the cluster. If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation. To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used" , args : { name : "list" , isVariadic : true , generators : generators . listCapacityProviders , } , } , { name : "--default-capacity-provider-strategy" , description : "The capacity provider strategy to use by default for the cluster. When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used. A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used. If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation. To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used" , args : { name : "list" , isVariadic : true , description : "CapacityProvider=string,weight=integer,base=integer" , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "register-container-instance" , description : "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.  Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on" , options : [ { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN) of the cluster with which to register your container instance. If you do not specify a cluster, the default cluster is assumed" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--instance-identity-document" , description : "The instance identity document for the EC2 instance to register. This document can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/document/" , args : { name : "string" , } , } , { name : "--instance-identity-document-signature" , description : "The instance identity document signature for the EC2 instance to register. This signature can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/signature/" , args : { name : "string" , } , } , { name : "--total-resources" , description : "The resources available on the instance" , args : { name : "list" , isVariadic : true , description : "Name=string,type=string,doubleValue=double,longValue=long,integerValue=integer,stringSetValue=string,string" , } , } , { name : "--version-info" , description : "The version information for the Amazon ECS container agent and Docker daemon running on the container instance" , args : { name : "structure" , description : "AgentVersion=string,agentHash=string,dockerVersion=string" , } , } , { name : "--container-instance-arn" , description : "The ARN of the container instance (if it was previously registered)" , args : { name : "string" , generators : generators . listContainerInstances , } , } , { name : "--attributes" , description : "The container instance attributes that this container instance supports" , args : { name : "list" , isVariadic : true , description : "Name=string,value=string,targetType=string,targetId=string" , } , } , { name : "--platform-devices" , description : "The devices that are available on the container instance. The only supported device type is a GPU" , args : { name : "list" , isVariadic : true , description : "Id=string,type=GPU" , } , } , { name : "--tags" , description : "The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. The following basic restrictions apply to tags:   Maximum number of tags per resource - 50   For each resource, each tag key must be unique, and each tag key can have only one value.   Maximum key length - 128 Unicode characters in UTF-8   Maximum value length - 256 Unicode characters in UTF-8   If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.   Tag keys and values are case-sensitive.   Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit" , args : { name : "list" , isVariadic : true , description : "Key=string,value=string" , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "register-task-definition" , description : "Registers a new task definition from the supplied family and containerDefinitions. Optionally, you can add data volumes to your containers with the volumes parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide. You can specify an IAM role for your task with the taskRoleArn parameter. When you specify an IAM role for a task, its containers can then use the latest versions of the AWS CLI or SDKs to make API requests to the AWS services that are specified in the IAM policy associated with the role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide. You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. The available network modes correspond to those described in Network settings in the Docker run reference. If you specify the awsvpc network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide" , options : [ { name : "--family" , description : "You must specify a family for a task definition, which allows you to track multiple versions of the same task definition. The family is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed" , args : { name : "string" , generators : generators . listTaskDefinitionFamilies , } , } , { name : "--task-role-arn" , description : "The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide" , args : { name : "string" , generators : generators . listTasks , } , } , { name : "--execution-role-arn" , description : "The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide" , args : { name : "string" , generators : generators . listRoles , } , } , { name : "--network-mode" , description : "The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge. For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 instances, any network mode can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode. With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.   When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.  If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.  Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init package, or AWS Fargate infrastructure support the awsvpc network mode.   If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used. Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the &lt;default&gt; network mode object.  For more information, see Network settings in the Docker run reference" , args : { name : "string" , suggestions : [ "bridge" , "host" , "awsvpc" , "none" ] , } , } , { name : "--container-definitions" , description : "A list of container definitions in JSON format that describe the different containers that make up your task" , args : { name : "list" , isVariadic : true , generators : generators . listFiles , } , } , { name : "--volumes" , description : "A list of volume definitions in JSON format that containers in your task may use" , args : { name : "list" , isVariadic : true , generators : generators . listFiles , } , } , { name : "--placement-constraints" , description : "An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime)" , args : { name : "list" , isVariadic : true , description : "Type=string,expression=string" , } , } , { name : "--requires-compatibilities" , description : "The task launch type that Amazon ECS should validate the task definition against. A client exception is returned if the task definition doesn't validate against the compatibilities specified. If no value is specified, the parameter is omitted from the response" , args : { name : "list" , suggestions : launchTypes , } , } , { name : "--cpu" , description : "The number of CPU units used by the task. It can be expressed as an integer using CPU units, for example 1024, or as a string using vCPUs, for example 1 vCPU or 1 vcpu, in a task definition. String values are converted to an integer indicating the CPU units when the task definition is registered.  Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.  If you are using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs). If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter:   256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)   512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)   1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)   2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)   4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)" , args : { name : "string" , } , } , { name : "--memory" , description : "The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB, for example 1024, or as a string using GB, for example 1GB or 1 GB, in a task definition. String values are converted to an integer indicating the MiB when the task definition is registered.  Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.  If using the EC2 launch type, this field is optional. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the cpu parameter:   512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)   1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)   2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)   Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)   Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)" , args : { name : "string" , } , } , { name : "--tags" , description : "The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. The following basic restrictions apply to tags:   Maximum number of tags per resource - 50   For each resource, each tag key must be unique, and each tag key can have only one value.   Maximum key length - 128 Unicode characters in UTF-8   Maximum value length - 256 Unicode characters in UTF-8   If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.   Tag keys and values are case-sensitive.   Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit" , args : { name : "list" , isVariadic : true , description : "Key=string,value=string" , } , } , { name : "--pid-mode" , description : "The process namespace to use for the containers in the task. The valid values are host or task. If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference. If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security.  This parameter is not supported for Windows containers or tasks run on AWS Fargate" , args : { name : "string" , suggestions : [ "host" , "task" ] , } , } , { name : "--ipc-mode" , description : "The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference. If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security. If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.   For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.   For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.    This parameter is not supported for Windows containers or tasks run on AWS Fargate" , args : { name : "string" , suggestions : [ "host" , "task" , "none" ] , } , } , { name : "--proxy-configuration" , description : "The configuration details for the App Mesh proxy. For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to enable a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI" , args : { name : "structure" , description : "Type=string,containerName=string,properties=[{name=string,value=string},{name=string,value=string}]" , } , } , { name : "--inference-accelerators" , description : "The Elastic Inference accelerators to use for the containers in the task" , args : { name : "list" , isVariadic : true , description : "DeviceName=string,deviceType=string" , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "run-task" , description : "Starts a new task using the specified task definition. You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide. Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances. The Amazon ECS API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command. To manage eventual consistency, you can do the following:   Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time.   Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time" , options : [ { name : "--capacity-provider-strategy" , description : "The capacity provider strategy to use for the task. If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used" , args : { name : "list" , isVariadic : true , description : "CapacityProvider=string,weight=integer,base=integer" , } , } , { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--count" , description : "The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call" , args : { name : "integer" , suggestions : Array . from ( { length : 10 } , ( _ , i ) => i + 1 ) . map ( ( number ) => number . toString ( ) ) , } , } , { name : "--enable-ecs-managed-tags" , description : "Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide" , } , { name : "--no-enable-ecs-managed-tags" , description : "Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide" , } , { name : "--enable-execute-command" , description : "Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task" , } , { name : "--group" , description : "The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name)" , args : { name : "string" , generators : generators . listTaskGroups , } , } , { name : "--launch-type" , description : "The launch type on which to run your task. The accepted values are FARGATE and EC2. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide. When a value of FARGATE is specified, your tasks are launched on AWS Fargate On-Demand infrastructure. To use Fargate Spot, you must use a capacity provider strategy with the FARGATE_SPOT capacity provider. When a value of EC2 is specified, your tasks are launched on Amazon EC2 instances registered to your cluster. If a launchType is specified, the capacityProviderStrategy parameter must be omitted" , args : { name : "string" , suggestions : launchTypes , } , } , { name : "--network-configuration" , description : "The network configuration for the task. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide" , args : { name : "structure" , description : "AwsvpcConfiguration={subnets=[string,string],securityGroups=[string,string],assignPublicIp=string}" , } , } , { name : "--overrides" , description : "A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.  A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure" , args : { name : "structure" , generators : generators . listFiles , } , } , { name : "--placement-constraints" , description : "An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime)" , args : { name : "list" , isVariadic : true , suggestions : [ "type=distinctInstance,expression=string" , "type=memberOf,expression=string" , ] , } , } , { name : "--placement-strategy" , description : "The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task" , args : { name : "list" , isVariadic : true , suggestions : [ "type=random,field=string" , "type=spread,field=string" , "type=binpack,field=string" , ] , } , } , { name : "--platform-version" , description : "The platform version the task should run. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide" , args : { name : "string" , } , } , { name : "--propagate-tags" , description : "Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.  An error will be received if you specify the SERVICE option when running a task" , args : { name : "string" , suggestions : tagsToPropagate , } , } , { name : "--reference-id" , description : "The reference ID to use for the task" , args : { name : "string" , } , } , { name : "--started-by" , description : "An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it" , args : { name : "string" , generators : generators . listStartedBy , } , } , { name : "--tags" , description : "The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. The following basic restrictions apply to tags:   Maximum number of tags per resource - 50   For each resource, each tag key must be unique, and each tag key can have only one value.   Maximum key length - 128 Unicode characters in UTF-8   Maximum value length - 256 Unicode characters in UTF-8   If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.   Tag keys and values are case-sensitive.   Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit" , args : { name : "list" , isVariadic : true , description : "Key=string,value=string" , } , } , { name : "--task-definition" , description : "The family and revision (family:revision) or full ARN of the task definition to run. If a revision is not specified, the latest ACTIVE revision is used" , args : { name : "string" , generators : generators . listTaskDefinitions , } , } , { name : "--disable-execute-command" , description : "Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task" , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "start-task" , description : "Starts a new task from the specified task definition on the specified container instance or instances. Alternatively, you can use RunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide" , options : [ { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--container-instances" , description : "The container instance IDs or full ARN entries for the container instances on which you would like to place your task. You can specify up to 10 container instances" , args : { name : "list" , isVariadic : true , generators : generators . listContainerInstances , } , } , { name : "--enable-ecs-managed-tags" , description : "Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide" , } , { name : "--no-enable-ecs-managed-tags" , description : "Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide" , } , { name : "--enable-execute-command" , description : "Whether or not the execute command functionality is enabled for the task. If true, this enables execute command functionality on all containers in the task" , } , { name : "--group" , description : "The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name)" , args : { name : "string" , generators : generators . listTaskGroups , } , } , { name : "--network-configuration" , description : "The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode" , args : { name : "structure" , description : "AwsvpcConfiguration={subnets=[string,string],securityGroups=[string,string],assignPublicIp=string}" , } , } , { name : "--overrides" , description : "A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.  A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure" , args : { name : "structure" , generators : generators . listFiles , } , } , { name : "--propagate-tags" , description : "Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated" , args : { name : "string" , suggestions : tagsToPropagate , } , } , { name : "--reference-id" , description : "The reference ID to use for the task" , args : { name : "string" , } , } , { name : "--started-by" , description : "An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it" , args : { name : "string" , generators : generators . listStartedBy , } , } , { name : "--tags" , description : "The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. The following basic restrictions apply to tags:   Maximum number of tags per resource - 50   For each resource, each tag key must be unique, and each tag key can have only one value.   Maximum key length - 128 Unicode characters in UTF-8   Maximum value length - 256 Unicode characters in UTF-8   If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.   Tag keys and values are case-sensitive.   Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit" , args : { name : "list" , isVariadic : true , description : "Key=string,value=string" , } , } , { name : "--task-definition" , description : "The family and revision (family:revision) or full ARN of the task definition to start. If a revision is not specified, the latest ACTIVE revision is used" , args : { name : "string" , generators : generators . listTaskDefinitions , } , } , { name : "--disable-execute-command" , description : "Whether or not the execute command functionality is enabled for the task. If true, this enables execute command functionality on all containers in the task" , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "stop-task" , description : "Stops a running task. Any tags associated with the task will be deleted. When StopTask is called on a task, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM value and a default 30-second timeout, after which the SIGKILL value is sent and the containers are forcibly stopped. If the container handles the SIGTERM value gracefully and exits within 30 seconds from receiving it, no SIGKILL value is sent.  The default 30-second timeout can be configured on the Amazon ECS container agent with the ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide" , options : [ { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--task" , description : "The task ID or full Amazon Resource Name (ARN) of the task to stop" , args : { name : "string" , generators : generators . listTasks , } , } , { name : "--reason" , description : "An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message" , args : { name : "string" , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "submit-attachment-state-changes" , description : "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.  Sent to acknowledge that an attachment changed states" , options : [ { name : "--cluster" , description : "The short name or full ARN of the cluster that hosts the container instance the attachment belongs to" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--attachments" , description : "Any attachments associated with the state change request" , args : { name : "list" , isVariadic : true , description : "AttachmentArn=string,status=string" , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "submit-container-state-change" , description : "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.  Sent to acknowledge that a container changed states" , options : [ { name : "--cluster" , description : "The short name or full ARN of the cluster that hosts the container" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--task" , description : "The task ID or full Amazon Resource Name (ARN) of the task that hosts the container" , args : { name : "string" , generators : generators . listTasks , } , } , { name : "--container-name" , description : "The name of the container" , args : { name : "string" , } , } , { name : "--runtime-id" , description : "The ID of the Docker container" , args : { name : "string" , } , } , { name : "--status" , description : "The status of the state change request" , args : { name : "string" , } , } , { name : "--exit-code" , description : "The exit code returned for the state change request" , args : { name : "integer" , } , } , { name : "--reason" , description : "The reason for the state change request" , args : { name : "string" , } , } , { name : "--network-bindings" , description : "The network bindings of the container" , args : { name : "list" , isVariadic : true , suggestions : [ "bindIP=string,containerPort=integer,hostPort=integer,protocol=tcp" , "bindIP=string,containerPort=integer,hostPort=integer,protocol=udp" , ] , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "submit-task-state-change" , description : "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.  Sent to acknowledge that a task changed states" , options : [ { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--task" , description : "The task ID or full ARN of the task in the state change request" , args : { name : "string" , generators : generators . listTasks , } , } , { name : "--status" , description : "The status of the state change request" , args : { name : "string" , } , } , { name : "--reason" , description : "The reason for the state change request" , args : { name : "string" , } , } , { name : "--containers" , description : "Any containers associated with the state change request" , args : { name : "list" , } , } , { name : "--attachments" , description : "Any attachments associated with the state change request" , args : { name : "list" , } , } , { name : "--managed-agents" , description : "The details for the managed agent associated with the task" , args : { name : "list" , isVariadic : true , description : "ContainerName=string,managedAgentName=string,status=string,reason=string" , } , } , { name : "--pull-started-at" , description : "The Unix timestamp for when the container image pull began" , args : { name : "timestamp" , } , } , { name : "--pull-stopped-at" , description : "The Unix timestamp for when the container image pull completed" , args : { name : "timestamp" , } , } , { name : "--execution-stopped-at" , description : "The Unix timestamp for when the task execution stopped" , args : { name : "timestamp" , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "tag-resource" , description : "Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well" , options : [ { name : "--resource-arn" , description : "The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container instances" , args : { name : "string" , generators : [ generators . listTasks , generators . listTaskDefinitions , generators . listClusters , generators . listServices , generators . listContainerInstances , ] , } , } , { name : "--tags" , description : "The tags to add to the resource. A tag is an array of key-value pairs. The following basic restrictions apply to tags:   Maximum number of tags per resource - 50   For each resource, each tag key must be unique, and each tag key can have only one value.   Maximum key length - 128 Unicode characters in UTF-8   Maximum value length - 256 Unicode characters in UTF-8   If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.   Tag keys and values are case-sensitive.   Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit" , args : { name : "list" , isVariadic : true , description : "Key=string,value=string" , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "untag-resource" , description : "Deletes specified tags from a resource" , options : [ { name : "--resource-arn" , description : "The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported resources are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container instances" , args : { name : "string" , generators : [ generators . listTasks , generators . listTaskDefinitions , generators . listClusters , generators . listServices , generators . listContainerInstances , ] , } , } , { name : "--tag-keys" , description : "The keys of the tags to be removed" , args : { name : "list" , isVariadic : true , generators : generators . listTagsForResource , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "update-capacity-provider" , description : "Modifies the parameters for a capacity provider" , options : [ { name : "--name" , description : "The name of the capacity provider to update" , args : { name : "string" , } , } , { name : "--auto-scaling-group-provider" , description : "An object representing the parameters to update for the Auto Scaling group capacity provider" , args : { name : "structure" , description : "ManagedScaling={status=string,targetCapacity=integer,minimumScalingStepSize=integer,maximumScalingStepSize=integer,instanceWarmupPeriod=integer},managedTerminationProtection=string" , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "update-cluster" , description : "Updates the cluster" , options : [ { name : "--cluster" , description : "The name of the cluster to modify the settings for" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--settings" , description : "The cluster settings for your cluster" , args : { name : "list" , isVariadic : true , suggestions : [ "name=containerInsights,value=enabled" , "name=containerInsights,value=disabled" , ] , } , } , { name : "--configuration" , description : "The execute command configuration for the cluster" , args : { name : "structure" , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "update-cluster-settings" , description : "Modifies the settings to use for a cluster" , options : [ { name : "--cluster" , description : "The name of the cluster to modify the settings for" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--settings" , description : "The setting to use by default for a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault" , args : { name : "list" , isVariadic : true , suggestions : [ "name=containerInsights,value=enabled" , "name=containerInsights,value=disabled" , ] , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "update-container-agent" , description : "Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent does not interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system.  UpdateContainerAgent requires the Amazon ECS-optimized AMI or Amazon Linux with the ecs-init service installed and running. For help updating the Amazon ECS container agent on other operating systems, see Manually Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide" , options : [ { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is running on. If you do not specify a cluster, the default cluster is assumed" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--container-instance" , description : "The container instance ID or full ARN entries for the container instance on which you would like to update the Amazon ECS container agent" , args : { name : "string" , generators : generators . listContainerInstances , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "update-container-instances-state" , description : "Modifies the status of an Amazon ECS container instance. Once a container instance has reached an ACTIVE state, you can change the status of a container instance to DRAINING to manually remove an instance from a cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size.  A container instance cannot be changed to DRAINING until it has reached an ACTIVE status. If the instance is in any other status, an error will be received.  When you set a container instance to DRAINING, Amazon ECS prevents new tasks from being scheduled for placement on the container instance and replacement service tasks are started on other container instances in the cluster if the resources are available. Service tasks on the container instance that are in the PENDING state are stopped immediately. Service tasks on the container instance that are in the RUNNING state are stopped and replaced according to the service's deployment configuration parameters, minimumHealthyPercent and maximumPercent. You can change the deployment configuration of your service using UpdateService.   If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during task replacement. For example, desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. If the minimum is 100%, the service scheduler can't remove existing tasks until the replacement tasks are considered healthy. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer.   The maximumPercent parameter represents an upper limit on the number of running tasks during task replacement, which enables you to define the replacement batch size. For example, if desiredCount is four tasks, a maximum of 200% starts four new tasks before stopping the four tasks to be drained, provided that the cluster resources required to do this are available. If the maximum is 100%, then replacement tasks can't start until the draining tasks have stopped.   Any PENDING or RUNNING tasks that do not belong to a service are not affected. You must wait for them to finish or stop them manually. A container instance has completed draining when it has no more RUNNING tasks. You can verify this using ListTasks. When a container instance has been drained, you can set a container instance to ACTIVE status and once it has reached that status the Amazon ECS scheduler can begin scheduling tasks on the instance again" , options : [ { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to update. If you do not specify a cluster, the default cluster is assumed" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--container-instances" , description : "A list of container instance IDs or full ARN entries" , args : { name : "list" , generators : generators . listContainerInstances , } , } , { name : "--status" , description : "The container instance state with which to update the container instance. The only valid values for this action are ACTIVE and DRAINING. A container instance can only be updated to DRAINING status once it has reached an ACTIVE state. If a container instance is in REGISTERING, DEREGISTERING, or REGISTRATION_FAILED state you can describe the container instance but will be unable to update the container instance state" , args : { name : "string" , suggestions : status , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "update-service" , description : "Updating the task placement strategies and constraints on an Amazon ECS service remains in preview and is a Beta Service as defined by and subject to the Beta Service Participation Service Terms located at https://aws.amazon.com/service-terms (\"Beta Terms\"). These Beta Terms apply to your participation in this preview.  Modifies the parameters of a service. For services using the rolling update (ECS) deployment controller, the desired count, deployment configuration, network configuration, task placement constraints and strategies, or task definition used can be updated. For services using the blue/green (CODE_DEPLOY) deployment controller, only the desired count, deployment configuration, task placement constraints and strategies, and health check grace period can be updated using this API. If the network configuration, platform version, or task definition need to be updated, a new AWS CodeDeploy deployment should be created. For more information, see CreateDeployment in the AWS CodeDeploy API Reference. For services using an external deployment controller, you can update only the desired count, task placement constraints and strategies, and health check grace period using this API. If the launch type, load balancer, network configuration, platform version, or task definition need to be updated, you should create a new task set. For more information, see CreateTaskSet. You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter. If you have updated the Docker image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service's deployment configuration) to determine the deployment strategy.  If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, my_image:latest), you do not need to create a new revision of your task definition. You can update the service using the forceNewDeployment option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start.  You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, minimumHealthyPercent and maximumPercent, to determine the deployment strategy.   If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during a deployment. For example, if desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer.   The maximumPercent parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if desiredCount is four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).   When UpdateService stops a task during a deployment, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent. When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic:   Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).   By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy):   Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.   Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.     When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic:    Sort the container instances by the largest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have two, container instances in either zone B or C are considered optimal for termination.   Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service" , options : [ { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--service" , description : "The name of the service to update" , args : { name : "string" , generators : generators . listServices , } , } , { name : "--desired-count" , description : "The number of instantiations of the task to place and keep running in your service" , args : { name : "integer" , } , } , { name : "--task-definition" , description : "The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running" , args : { name : "string" , generators : generators . listTaskDefinitions , } , } , { name : "--capacity-provider-strategy" , description : "The capacity provider strategy to update the service to use. If the service is using the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers as opposed to the default capacity provider strategy. However, when a service is using a capacity provider strategy that is not the default capacity provider strategy, the service cannot be updated to use the cluster's default capacity provider strategy. A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used. If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation. To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used. The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created" , args : { name : "list" , isVariadic : true , description : "CapacityProvider=string,weight=integer,base=integer" , } , } , { name : "--deployment-configuration" , description : "Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks" , args : { name : "structure" , suggestions : [ "deploymentCircuitBreaker={enable=true,rollback=true},maximumPercent=integer,minimumHealthyPercent=integer" , "deploymentCircuitBreaker={enable=true,rollback=false},maximumPercent=integer,minimumHealthyPercent=integer" , "deploymentCircuitBreaker={enable=false,rollback=true},maximumPercent=integer,minimumHealthyPercent=integer" , "deploymentCircuitBreaker={enable=false,rollback=false},maximumPercent=integer,minimumHealthyPercent=integer" , ] , } , } , { name : "--network-configuration" , description : "An object representing the network configuration for a task or service" , args : { name : "structure" , description : "AwsvpcConfiguration={subnets=[string,string],securityGroups=[string,string],assignPublicIp=string}" , } , } , { name : "--placement-constraints" , description : "An array of task placement constraint objects to update the service to use. If no value is specified, the existing placement constraints for the service will remain unchanged. If this value is specified, it will override any existing placement constraints defined for the service. To remove all existing placement constraints, specify an empty array. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime)" , args : { name : "list" , isVariadic : true , suggestions : [ "type=distinctInstance,expression=string" , "type=memberOf,expression=string" , ] , } , } , { name : "--placement-strategy" , description : "The task placement strategy objects to update the service to use. If no value is specified, the existing placement strategy for the service will remain unchanged. If this value is specified, it will override the existing placement strategy defined for the service. To remove an existing placement strategy, specify an empty object. You can specify a maximum of five strategy rules per service" , args : { name : "list" , isVariadic : true , suggestions : [ "type=random,field=string" , "type=spread,field=string" , "type=binpack,field=string" , ] , } , } , { name : "--platform-version" , description : "The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If a platform version is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide" , args : { name : "string" , } , } , { name : "--force-new-deployment" , description : "Whether to force a new deployment of the service. Deployments are not forced by default. You can use this option to trigger a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination (my_image:latest) or to roll Fargate tasks onto a newer platform version" , } , { name : "--no-force-new-deployment" , description : "Whether to force a new deployment of the service. Deployments are not forced by default. You can use this option to trigger a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination (my_image:latest) or to roll Fargate tasks onto a newer platform version" , } , { name : "--health-check-grace-period-seconds" , description : "The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up" , args : { name : "integer" , } , } , { name : "--enable-execute-command" , description : "If true, this enables execute command functionality on all task containers. If you do not want to override the value that was set when the service was created, you can set this to null when performing this action" , } , { name : "--disable-execute-command" , description : "If true, this enables execute command functionality on all task containers. If you do not want to override the value that was set when the service was created, you can set this to null when performing this action" , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "update-service-primary-task-set" , description : "Modifies which task set in a service is the primary task set. Any parameters that are updated on the primary task set in a service will transition to the service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide" , options : [ { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--service" , description : "The short name or full Amazon Resource Name (ARN) of the service that the task set exists in" , args : { name : "string" , generators : generators . listServices , } , } , { name : "--primary-task-set" , description : "The short name or full Amazon Resource Name (ARN) of the task set to set as the primary task set in the deployment" , args : { name : "string" , generators : generators . listTaskSets , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "update-task-set" , description : "Modifies a task set. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide" , options : [ { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--service" , description : "The short name or full Amazon Resource Name (ARN) of the service that the task set exists in" , args : { name : "string" , generators : generators . listServices , } , } , { name : "--task-set" , description : "The short name or full Amazon Resource Name (ARN) of the task set to update" , args : { name : "string" , generators : generators . listTaskSets , } , } , { name : "--scale" , description : "A floating-point percentage of the desired number of tasks to place and keep running in the task set" , args : { name : "structure" , description : "Value=double,unit=string" , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "deploy" , description : "Deploys a new task definition to the specified ECS service. Only services that use CodeDeploy for deployments are supported. This command will register a new task definition, update the CodeDeploy appspec with the new task definition revision, create a CodeDeploy deployment, and wait for the deployment to successfully complete. This command will exit with a return code of 255 if the deployment does not succeed within 30 minutes by default or up to 10 minutes more than your deployment group's configured wait time (max of 6 hours)" , options : [ { name : "--service" , description : "The short name or full Amazon Resource Name (ARN) of the service to update" , args : { name : "string" , generators : generators . listServices , } , } , { name : "--task-definition" , description : "The file path where your task definition file is located. The format of the file must be the same as the JSON output of: aws ecs register-task-definition --generate-cli-skeleton" , args : { name : "string" , generators : generators . listTaskDefinitions , } , } , { name : "--codedeploy-appspec" , description : "The file path where your AWS CodeDeploy appspec file is located. The appspec file may be in JSON or YAML format. The TaskDefinition property will be updated within the appspec with the newly registered task definition ARN, overwriting any placeholder values in the file" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--cluster" , description : 'The short name or full Amazon Resource Name (ARN) of the cluster that your service is running within. If you do not specify a cluster, the "default" cluster is assumed' , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--codedeploy-application" , description : "The name of the AWS CodeDeploy application to use for the deployment. The specified application must use the 'ECS' compute platform. If you do not specify an application, the application name AppECS-[CLUSTER_NAME]-[SERVICE_NAME] is assumed" , args : { name : "string" , generators : generators . listCodedeployApplications , } , } , { name : "--codedeploy-deployment-group" , description : "The name of the AWS CodeDeploy deployment group to use for the deployment. The specified deployment group must be associated with the specified ECS service and cluster. If you do not specify a deployment group, the deployment group name DgpECS-[CLUSTER_NAME]-[SERVICE_NAME] is assumed" , args : { name : "string" , generators : generators . listCodedeployDeploymentGroups , } , } , ] , subcommands : [ { name : "push" , description : "Bundles and uploads to Amazon Simple Storage Service (Amazon S3) an application revision, which is a zip archive file that contains deployable content and an accompanying Application Specification file (AppSpec file). If the upload is successful, a message is returned that describes how to call the create-deployment command to deploy the application revision from Amazon S3 to target Amazon Elastic Compute Cloud (Amazon EC2) instances" , options : [ { name : "--application-name" , description : "Required. The name of the AWS CodeDeploy application to be associated with the application revision" , args : { name : "string" , } , } , { name : "--s3-location" , description : "Required. Information about the location of the application revision to be uploaded to Amazon S3. You must specify both a bucket and a key that represent the Amazon S3 bucket name and the object key name. Content will be zipped before uploading. Use the format s3://\\/\\" , args : { name : "string" , } , } , { name : "--ignore-hidden-files" , description : "Optional. Set the --ignore-hidden-files flag to not bundle and upload hidden files to Amazon S3; otherwise, set the --no-ignore-hidden-files flag (the default) to bundle and upload hidden files to Amazon S3" , } , { name : "--no-ignore-hidden-files" , } , { name : "--source" , description : "Optional. The location of the deployable content and the accompanying AppSpec file on the development machine to be zipped and uploaded to Amazon S3. If not specified, the current directory is used" , args : { name : "string" , } , } , { name : "--description" , description : "Optional. A comment that summarizes the application revision. If not specified, the default string \"Uploaded by AWS CLI 'time' UTC\" is used, where 'time' is the current system time in Coordinated Universal Time (UTC)" , args : { name : "string" , } , } , ] , } , { name : "register" , description : "Creates an IAM user for the on-premises instance, if not provided, and saves the user's credentials to an on-premises instance configuration file; registers the on-premises instance with AWS CodeDeploy; and optionally adds tags to the on-premises instance" , options : [ { name : "--instance-name" , description : "Required. The name of the on-premises instance" , args : { name : "string" , } , } , { name : "--tags" , description : "Optional. The list of key/value pairs to tag the on-premises instance" , args : { name : "list" , isVariadic : true , } , } , { name : "--iam-user-arn" , description : "Optional. The IAM user associated with the on-premises instance" , args : { name : "string" , } , } , ] , } , { name : "deregister" , description : "Removes any tags from the on-premises instance; deregisters the on-premises instance from AWS CodeDeploy; and, unless requested otherwise, deletes the IAM user for the on-premises instance" , options : [ { name : "--instance-name" , description : "Required. The name of the on-premises instance" , args : { name : "string" , } , } , { name : "--no-delete-iam-user" , description : "Optional. Do not delete the IAM user for the registered on-premises instance" , } , ] , } , { name : "install" , description : "Configures and installs the AWS CodeDeploy Agent on the on-premises instance" , options : [ { name : "--config-file" , description : "Required. The path to the on-premises instance configuration file" , args : { name : "string" , } , } , { name : "--override-config" , description : "Optional. Overrides the on-premises instance configuration file" , } , { name : "--agent-installer" , description : "Optional. The AWS CodeDeploy Agent installer file" , args : { name : "string" , } , } , ] , } , { name : "uninstall" , description : "Uninstalls the AWS CodeDeploy Agent from the on-premises instance" , } , ] , } , { name : "wait" , description : "Wait until a particular condition is satisfied. Each subcommand polls an API until the listed requirement is met" , subcommands : [ { name : "services-inactive" , description : "Wait until JMESPath query services[].status returns INACTIVE for any element when polling with ``describe-services``. It will poll every 15 seconds until a successful state has been reached. This will exit with a return code of 255 after 40 failed checks" , options : [ { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the service or services you are describing were launched in any cluster other than the default cluster" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--services" , description : "A list of services to describe. You may specify up to 10 services to describe in a single operation" , args : { name : "list" , generators : generators . listServices , } , } , { name : "--include" , description : "Specifies whether you want to see the resource tags for the service. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response" , args : { name : "list" , isVariadic : true , suggestions : tags , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "services-stable" , description : "Wait until JMESPath query length(services[?!(length(deployments) == `1` && runningCount == desiredCount)]) == `0` returns True when polling with ``describe-services``. It will poll every 15 seconds until a successful state has been reached. This will exit with a return code of 255 after 40 failed checks" , options : [ { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the service or services you are describing were launched in any cluster other than the default cluster" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--services" , description : "A list of services to describe. You may specify up to 10 services to describe in a single operation" , args : { name : "list" , generators : generators . listServices , } , } , { name : "--include" , description : "Specifies whether you want to see the resource tags for the service. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response" , args : { name : "list" , isVariadic : true , suggestions : tags , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "tasks-running" , description : "Wait until JMESPath query tasks[].lastStatus returns RUNNING for all elements when polling with ``describe-tasks``. It will poll every 6 seconds until a successful state has been reached. This will exit with a return code of 255 after 100 failed checks" , options : [ { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you are describing were launched in any cluster other than the default cluster" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--tasks" , description : "A list of up to 100 task IDs or full ARN entries" , args : { name : "list" , isVariadic : true , generators : generators . listTasks , } , } , { name : "--include" , description : "Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response" , args : { name : "list" , isVariadic : true , suggestions : tags , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , { name : "tasks-stopped" , description : "Wait until JMESPath query tasks[].lastStatus returns STOPPED for all elements when polling with ``describe-tasks``. It will poll every 6 seconds until a successful state has been reached. This will exit with a return code of 255 after 100 failed checks" , options : [ { name : "--cluster" , description : "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you are describing were launched in any cluster other than the default cluster" , args : { name : "string" , generators : generators . listClusters , } , } , { name : "--tasks" , description : "A list of up to 100 task IDs or full ARN entries" , args : { name : "list" , generators : generators . listTasks , } , } , { name : "--include" , description : "Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response" , args : { name : "list" , isVariadic : true , suggestions : tags , } , } , { name : "--cli-input-json" , description : "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally" , args : { name : "string" , generators : generators . listFiles , } , } , { name : "--generate-cli-skeleton" , description : "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command" , args : { name : "string" , suggestions : [ "input" , "output" ] , } , } , ] , } , ] , } , ] , } ; export default completionSpec ;