Skip to content

Latest commit

 

History

History

amazonaws_ecs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
index.js
index.js
 
 
openapi.json
openapi.json
 
 
package.json
package.json
 
 

README.md

@datafire/amazonaws_ecs

Client library for Amazon EC2 Container Service

Installation and Usage

npm install --save @datafire/amazonaws_ecs
let amazonaws_ecs = require('@datafire/amazonaws_ecs').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

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 using the Fargate launch type. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage by using the EC2 launch type. For more information about launch types, see Amazon ECS Launch Types.

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

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

Actions

CreateCapacityProvider

amazonaws_ecs.CreateCapacityProvider({
  "name": null,
  "autoScalingGroupProvider": null
}, context)

Input

  • input object
    • tags
    • autoScalingGroupProvider required
      • autoScalingGroupArn required
      • managedScaling
        • instanceWarmupPeriod
        • maximumScalingStepSize
        • minimumScalingStepSize
        • status
        • targetCapacity
      • managedTerminationProtection
    • name required

Output

CreateCluster

amazonaws_ecs.CreateCluster({}, context)

Input

Output

CreateService

amazonaws_ecs.CreateService({
  "serviceName": null
}, context)

Input

  • input object
    • tags
    • capacityProviderStrategy
    • clientToken
    • cluster
    • deploymentConfiguration
      • deploymentCircuitBreaker
        • enable required
        • rollback required
      • maximumPercent
      • minimumHealthyPercent
    • deploymentController
      • type required
    • desiredCount
    • enableECSManagedTags
    • healthCheckGracePeriodSeconds
    • launchType
    • loadBalancers
    • networkConfiguration
      • awsvpcConfiguration
        • assignPublicIp
        • securityGroups
        • subnets required
    • placementConstraints
    • placementStrategy
    • platformVersion
    • propagateTags
    • role
    • schedulingStrategy
    • serviceName required
    • serviceRegistries
    • taskDefinition

Output

CreateTaskSet

amazonaws_ecs.CreateTaskSet({
  "service": null,
  "cluster": null,
  "taskDefinition": null
}, context)

Input

Output

DeleteAccountSetting

amazonaws_ecs.DeleteAccountSetting({
  "name": null
}, context)

Input

  • input object
    • name required
    • principalArn

Output

DeleteAttributes

amazonaws_ecs.DeleteAttributes({
  "attributes": null
}, context)

Input

  • input object
    • attributes required
    • cluster

Output

DeleteCapacityProvider

amazonaws_ecs.DeleteCapacityProvider({
  "capacityProvider": null
}, context)

Input

  • input object
    • capacityProvider required

Output

DeleteCluster

amazonaws_ecs.DeleteCluster({
  "cluster": null
}, context)

Input

  • input object
    • cluster required

Output

DeleteService

amazonaws_ecs.DeleteService({
  "service": null
}, context)

Input

  • input object
    • cluster
    • force
    • service required

Output

DeleteTaskSet

amazonaws_ecs.DeleteTaskSet({
  "cluster": null,
  "service": null,
  "taskSet": null
}, context)

Input

  • input object
    • cluster required
    • force
    • service required
    • taskSet required

Output

DeregisterContainerInstance

amazonaws_ecs.DeregisterContainerInstance({
  "containerInstance": null
}, context)

Input

  • input object
    • cluster
    • containerInstance required
    • force

Output

DeregisterTaskDefinition

amazonaws_ecs.DeregisterTaskDefinition({
  "taskDefinition": null
}, context)

Input

  • input object
    • taskDefinition required

Output

DescribeCapacityProviders

amazonaws_ecs.DescribeCapacityProviders({}, context)

Input

Output

DescribeClusters

amazonaws_ecs.DescribeClusters({}, context)

Input

Output

DescribeContainerInstances

amazonaws_ecs.DescribeContainerInstances({
  "containerInstances": null
}, context)

Input

Output

DescribeServices

amazonaws_ecs.DescribeServices({
  "services": null
}, context)

Input

Output

DescribeTaskDefinition

amazonaws_ecs.DescribeTaskDefinition({
  "taskDefinition": null
}, context)

Input

Output

DescribeTaskSets

amazonaws_ecs.DescribeTaskSets({
  "cluster": null,
  "service": null
}, context)

Input

  • input object

Output

DescribeTasks

amazonaws_ecs.DescribeTasks({
  "tasks": null
}, context)

Input

Output

DiscoverPollEndpoint

amazonaws_ecs.DiscoverPollEndpoint({}, context)

Input

  • input object
    • cluster
    • containerInstance

Output

ListAccountSettings

amazonaws_ecs.ListAccountSettings({}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • effectiveSettings
    • maxResults
    • name
    • nextToken
    • principalArn
    • value

Output

ListAttributes

amazonaws_ecs.ListAttributes({
  "targetType": null
}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • attributeName
    • attributeValue
    • cluster
    • maxResults
    • nextToken
    • targetType required

Output

ListClusters

amazonaws_ecs.ListClusters({}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • maxResults
    • nextToken

Output

ListContainerInstances

amazonaws_ecs.ListContainerInstances({}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • cluster
    • filter
    • maxResults
    • nextToken
    • status

Output

ListServices

amazonaws_ecs.ListServices({}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • cluster
    • launchType
    • maxResults
    • nextToken
    • schedulingStrategy

Output

ListTagsForResource

amazonaws_ecs.ListTagsForResource({
  "resourceArn": null
}, context)

Input

  • input object
    • resourceArn required

Output

ListTaskDefinitionFamilies

amazonaws_ecs.ListTaskDefinitionFamilies({}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • familyPrefix
    • maxResults
    • nextToken
    • status

Output

ListTaskDefinitions

amazonaws_ecs.ListTaskDefinitions({}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • familyPrefix
    • maxResults
    • nextToken
    • sort
    • status

Output

ListTasks

amazonaws_ecs.ListTasks({}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • cluster
    • containerInstance
    • desiredStatus
    • family
    • launchType
    • maxResults
    • nextToken
    • serviceName
    • startedBy

Output

PutAccountSetting

amazonaws_ecs.PutAccountSetting({
  "name": null,
  "value": null
}, context)

Input

  • input object
    • name required
    • principalArn
    • value required

Output

PutAccountSettingDefault

amazonaws_ecs.PutAccountSettingDefault({
  "name": null,
  "value": null
}, context)

Input

  • input object
    • name required
    • value required

Output

PutAttributes

amazonaws_ecs.PutAttributes({
  "attributes": null
}, context)

Input

  • input object
    • attributes required
    • cluster

Output

PutClusterCapacityProviders

amazonaws_ecs.PutClusterCapacityProviders({
  "cluster": null,
  "capacityProviders": null,
  "defaultCapacityProviderStrategy": null
}, context)

Input

Output

RegisterContainerInstance

amazonaws_ecs.RegisterContainerInstance({}, context)

Input

  • input object
    • tags
    • attributes
    • cluster
    • containerInstanceArn
    • instanceIdentityDocument
    • instanceIdentityDocumentSignature
    • platformDevices
    • totalResources
    • versionInfo
      • agentHash
      • agentVersion
      • dockerVersion

Output

RegisterTaskDefinition

amazonaws_ecs.RegisterTaskDefinition({
  "family": null,
  "containerDefinitions": null
}, context)

Input

Output

RunTask

amazonaws_ecs.RunTask({
  "taskDefinition": null
}, context)

Input

Output

StartTask

amazonaws_ecs.StartTask({
  "containerInstances": null,
  "taskDefinition": null
}, context)

Input

  • input object
    • tags
    • cluster
    • containerInstances required
    • enableECSManagedTags
    • group
    • networkConfiguration
      • awsvpcConfiguration
        • assignPublicIp
        • securityGroups
        • subnets required
    • overrides
    • propagateTags
    • referenceId
    • startedBy
    • taskDefinition required

Output

StopTask

amazonaws_ecs.StopTask({
  "task": null
}, context)

Input

  • input object
    • cluster
    • reason
    • task required

Output

SubmitAttachmentStateChanges

amazonaws_ecs.SubmitAttachmentStateChanges({
  "attachments": null
}, context)

Input

Output

SubmitContainerStateChange

amazonaws_ecs.SubmitContainerStateChange({}, context)

Input

  • input object
    • cluster
    • containerName
    • exitCode
    • networkBindings
    • reason
    • runtimeId
    • status
    • task

Output

SubmitTaskStateChange

amazonaws_ecs.SubmitTaskStateChange({}, context)

Input

Output

TagResource

amazonaws_ecs.TagResource({
  "resourceArn": null,
  "tags": null
}, context)

Input

  • input object
    • tags required
    • resourceArn required

Output

UntagResource

amazonaws_ecs.UntagResource({
  "resourceArn": null,
  "tagKeys": null
}, context)

Input

  • input object
    • resourceArn required
    • tagKeys required

Output

UpdateCapacityProvider

amazonaws_ecs.UpdateCapacityProvider({
  "name": null,
  "autoScalingGroupProvider": null
}, context)

Input

  • input object
    • autoScalingGroupProvider required
    • name required

Output

UpdateClusterSettings

amazonaws_ecs.UpdateClusterSettings({
  "cluster": null,
  "settings": null
}, context)

Input

  • input object

Output

UpdateContainerAgent

amazonaws_ecs.UpdateContainerAgent({
  "containerInstance": null
}, context)

Input

  • input object
    • cluster
    • containerInstance required

Output

UpdateContainerInstancesState

amazonaws_ecs.UpdateContainerInstancesState({
  "containerInstances": null,
  "status": null
}, context)

Input

  • input object
    • cluster
    • containerInstances required
    • status required

Output

UpdateService

amazonaws_ecs.UpdateService({
  "service": null
}, context)

Input

  • input object
    • capacityProviderStrategy
    • cluster
    • deploymentConfiguration
      • deploymentCircuitBreaker
        • enable required
        • rollback required
      • maximumPercent
      • minimumHealthyPercent
    • desiredCount
    • forceNewDeployment
    • healthCheckGracePeriodSeconds
    • networkConfiguration NetworkConfiguration
    • placementConstraints
    • placementStrategy
    • platformVersion
    • service required
    • taskDefinition

Output

UpdateServicePrimaryTaskSet

amazonaws_ecs.UpdateServicePrimaryTaskSet({
  "cluster": null,
  "service": null,
  "primaryTaskSet": null
}, context)

Input

  • input object
    • cluster required
    • primaryTaskSet required
    • service required

Output

UpdateTaskSet

amazonaws_ecs.UpdateTaskSet({
  "cluster": null,
  "service": null,
  "taskSet": null,
  "scale": {}
}, context)

Input

  • input object
    • cluster required
    • scale required Scale
    • service required
    • taskSet required

Output

Definitions

AccessDeniedException

AgentUpdateStatus

  • AgentUpdateStatus string (values: PENDING, STAGING, STAGED, UPDATING, UPDATED, FAILED)

AssignPublicIp

  • AssignPublicIp string (values: ENABLED, DISABLED)

Attachment

  • Attachment object: An object representing a container instance or task attachment.

AttachmentDetails

AttachmentStateChange

  • AttachmentStateChange object: An object representing a change in state for a task attachment.
    • attachmentArn required
    • status required

AttachmentStateChanges

Attachments

Attribute

  • Attribute object: An attribute is a name-value pair associated with an Amazon ECS object. Attributes enable you to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
    • name required
    • targetId
    • targetType
    • value

AttributeLimitExceededException

Attributes

AutoScalingGroupProvider

  • AutoScalingGroupProvider object: The details of the Auto Scaling group for the capacity provider.
    • autoScalingGroupArn required
    • managedScaling
      • instanceWarmupPeriod
      • maximumScalingStepSize
      • minimumScalingStepSize
      • status
      • targetCapacity
    • managedTerminationProtection

AutoScalingGroupProviderUpdate

  • AutoScalingGroupProviderUpdate object: The details of the Auto Scaling group capacity provider to update.

AwsVpcConfiguration

  • AwsVpcConfiguration object: An object representing the networking details for a task or service.
    • assignPublicIp
    • securityGroups
    • subnets required

BlockedException

Boolean

  • Boolean boolean

BoxedBoolean

  • BoxedBoolean boolean

BoxedInteger

  • BoxedInteger integer

CapacityProvider

  • CapacityProvider object: The details of a capacity provider.
    • tags
    • autoScalingGroupProvider
      • autoScalingGroupArn required
      • managedScaling
        • instanceWarmupPeriod
        • maximumScalingStepSize
        • minimumScalingStepSize
        • status
        • targetCapacity
      • managedTerminationProtection
    • capacityProviderArn
    • name
    • status
    • updateStatus
    • updateStatusReason

CapacityProviderField

  • CapacityProviderField string (values: TAGS)

CapacityProviderFieldList

CapacityProviderStatus

  • CapacityProviderStatus string (values: ACTIVE, INACTIVE)

CapacityProviderStrategy

CapacityProviderStrategyItem

  • CapacityProviderStrategyItem object: The details of a capacity provider strategy.
    • base
    • capacityProvider required
    • weight

CapacityProviderStrategyItemBase

  • CapacityProviderStrategyItemBase integer

CapacityProviderStrategyItemWeight

  • CapacityProviderStrategyItemWeight integer

CapacityProviderUpdateStatus

  • CapacityProviderUpdateStatus string (values: DELETE_IN_PROGRESS, DELETE_COMPLETE, DELETE_FAILED, UPDATE_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_FAILED)

CapacityProviders

ClientException

Cluster

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

ClusterContainsContainerInstancesException

ClusterContainsServicesException

ClusterContainsTasksException

ClusterField

  • ClusterField string (values: ATTACHMENTS, SETTINGS, STATISTICS, TAGS)

ClusterFieldList

ClusterNotFoundException

ClusterSetting

  • ClusterSetting object: The settings to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster.
    • name
    • value

ClusterSettingName

  • ClusterSettingName string (values: containerInsights)

ClusterSettings

Clusters

Compatibility

  • Compatibility string (values: EC2, FARGATE)

CompatibilityList

Connectivity

  • Connectivity string (values: CONNECTED, DISCONNECTED)

Container

  • Container object: A Docker container that is part of a task.
    • containerArn
    • cpu
    • exitCode
    • gpuIds
    • healthStatus
    • image
    • imageDigest
    • lastStatus
    • memory
    • memoryReservation
    • name
    • networkBindings
    • networkInterfaces
    • reason
    • runtimeId
    • taskArn

ContainerCondition

  • ContainerCondition string (values: START, COMPLETE, SUCCESS, HEALTHY)

ContainerDefinition

  • ContainerDefinition object: Container definitions are used in task definitions to describe the different containers that are launched as part of a task.
    • command
    • cpu
    • dependsOn
    • disableNetworking
    • dnsSearchDomains
    • dnsServers
    • dockerLabels
    • dockerSecurityOptions
    • entryPoint
    • environment
    • environmentFiles
    • essential
    • extraHosts
    • firelensConfiguration
      • options
      • type required
    • healthCheck
      • command required
      • interval
      • retries
      • startPeriod
      • timeout
    • hostname
    • image
    • interactive
    • links
    • linuxParameters
      • capabilities
      • devices
      • initProcessEnabled
      • maxSwap
      • sharedMemorySize
      • swappiness
      • tmpfs
    • logConfiguration
      • logDriver required
      • options
      • secretOptions
    • memory
    • memoryReservation
    • mountPoints
    • name
    • portMappings
    • privileged
    • pseudoTerminal
    • readonlyRootFilesystem
    • repositoryCredentials
      • credentialsParameter required
    • resourceRequirements
    • secrets
    • startTimeout
    • stopTimeout
    • systemControls
    • ulimits
    • user
    • volumesFrom
    • workingDirectory

ContainerDefinitions

ContainerDependencies

ContainerDependency

  • ContainerDependency object:

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

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

    For tasks using the Fargate launch type, this parameter requires that the task or service uses platform version 1.3.0 or later.

    • condition required
    • containerName required

ContainerInstance

  • ContainerInstance object: An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.
    • tags
    • agentConnected
    • agentUpdateStatus
    • attachments
    • attributes
    • capacityProviderName
    • containerInstanceArn
    • ec2InstanceId
    • pendingTasksCount
    • registeredAt
    • registeredResources
    • remainingResources
    • runningTasksCount
    • status
    • statusReason
    • version
    • versionInfo
      • agentHash
      • agentVersion
      • dockerVersion

ContainerInstanceField

  • ContainerInstanceField string (values: TAGS)

ContainerInstanceFieldList

ContainerInstanceStatus

  • ContainerInstanceStatus string (values: ACTIVE, DRAINING, REGISTERING, DEREGISTERING, REGISTRATION_FAILED)

ContainerInstances

ContainerOverride

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

ContainerOverrides

ContainerStateChange

  • ContainerStateChange object: An object representing a change in state for a container.
    • containerName
    • exitCode
    • imageDigest
    • networkBindings
    • reason
    • runtimeId
    • status

ContainerStateChanges

Containers

CreateCapacityProviderRequest

  • CreateCapacityProviderRequest object
    • tags
    • autoScalingGroupProvider required
      • autoScalingGroupArn required
      • managedScaling
        • instanceWarmupPeriod
        • maximumScalingStepSize
        • minimumScalingStepSize
        • status
        • targetCapacity
      • managedTerminationProtection
    • name required

CreateCapacityProviderResponse

  • CreateCapacityProviderResponse object
    • capacityProvider
      • tags
      • autoScalingGroupProvider
        • autoScalingGroupArn required
        • managedScaling
          • instanceWarmupPeriod
          • maximumScalingStepSize
          • minimumScalingStepSize
          • status
          • targetCapacity
        • managedTerminationProtection
      • capacityProviderArn
      • name
      • status
      • updateStatus
      • updateStatusReason

CreateClusterRequest

CreateClusterResponse

  • CreateClusterResponse object

CreateServiceRequest

  • CreateServiceRequest object
    • tags
    • capacityProviderStrategy
    • clientToken
    • cluster
    • deploymentConfiguration
      • deploymentCircuitBreaker
        • enable required
        • rollback required
      • maximumPercent
      • minimumHealthyPercent
    • deploymentController
      • type required
    • desiredCount
    • enableECSManagedTags
    • healthCheckGracePeriodSeconds
    • launchType
    • loadBalancers
    • networkConfiguration
      • awsvpcConfiguration
        • assignPublicIp
        • securityGroups
        • subnets required
    • placementConstraints
    • placementStrategy
    • platformVersion
    • propagateTags
    • role
    • schedulingStrategy
    • serviceName required
    • serviceRegistries
    • taskDefinition

CreateServiceResponse

  • CreateServiceResponse object
    • service
      • tags
      • capacityProviderStrategy
      • clusterArn
      • createdAt
      • createdBy
      • deploymentConfiguration
        • deploymentCircuitBreaker
          • enable required
          • rollback required
        • maximumPercent
        • minimumHealthyPercent
      • deploymentController
        • type required
      • deployments
      • desiredCount
      • enableECSManagedTags
      • events
      • healthCheckGracePeriodSeconds
      • launchType
      • loadBalancers
      • networkConfiguration
        • awsvpcConfiguration
          • assignPublicIp
          • securityGroups
          • subnets required
      • pendingCount
      • placementConstraints
      • placementStrategy
      • platformVersion
      • propagateTags
      • roleArn
      • runningCount
      • schedulingStrategy
      • serviceArn
      • serviceName
      • serviceRegistries
      • status
      • taskDefinition
      • taskSets

CreateTaskSetRequest

CreateTaskSetResponse

  • CreateTaskSetResponse object

DeleteAccountSettingRequest

  • DeleteAccountSettingRequest object
    • name required
    • principalArn

DeleteAccountSettingResponse

  • DeleteAccountSettingResponse object
    • setting
      • name
      • principalArn
      • value

DeleteAttributesRequest

  • DeleteAttributesRequest object
    • attributes required
    • cluster

DeleteAttributesResponse

  • DeleteAttributesResponse object

DeleteCapacityProviderRequest

  • DeleteCapacityProviderRequest object
    • capacityProvider required

DeleteCapacityProviderResponse

DeleteClusterRequest

  • DeleteClusterRequest object
    • cluster required

DeleteClusterResponse

  • DeleteClusterResponse object

DeleteServiceRequest

  • DeleteServiceRequest object
    • cluster
    • force
    • service required

DeleteServiceResponse

  • DeleteServiceResponse object
    • service
      • tags
      • capacityProviderStrategy
      • clusterArn
      • createdAt
      • createdBy
      • deploymentConfiguration
        • deploymentCircuitBreaker
          • enable required
          • rollback required
        • maximumPercent
        • minimumHealthyPercent
      • deploymentController
        • type required
      • deployments
      • desiredCount
      • enableECSManagedTags
      • events
      • healthCheckGracePeriodSeconds
      • launchType
      • loadBalancers
      • networkConfiguration
        • awsvpcConfiguration
          • assignPublicIp
          • securityGroups
          • subnets required
      • pendingCount
      • placementConstraints
      • placementStrategy
      • platformVersion
      • propagateTags
      • roleArn
      • runningCount
      • schedulingStrategy
      • serviceArn
      • serviceName
      • serviceRegistries
      • status
      • taskDefinition
      • taskSets

DeleteTaskSetRequest

  • DeleteTaskSetRequest object
    • cluster required
    • force
    • service required
    • taskSet required

DeleteTaskSetResponse

  • DeleteTaskSetResponse object

Deployment

  • Deployment object: The details of an Amazon ECS service deployment. This is used only when a service uses the ECS deployment controller type.
    • capacityProviderStrategy
    • createdAt
    • desiredCount
    • failedTasks
    • id
    • launchType
    • networkConfiguration
      • awsvpcConfiguration
        • assignPublicIp
        • securityGroups
        • subnets required
    • pendingCount
    • platformVersion
    • rolloutState
    • rolloutStateReason
    • runningCount
    • status
    • taskDefinition
    • updatedAt

DeploymentCircuitBreaker

  • DeploymentCircuitBreaker object:

    The deployment circuit breaker can only be used for services using the rolling update (ECS) deployment type that are not behind a Classic Load Balancer.

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

    • enable required
    • rollback required

DeploymentConfiguration

  • DeploymentConfiguration object: Optional deployment parameters that control how many tasks run during a deployment and the ordering of stopping and starting tasks.
    • deploymentCircuitBreaker
      • enable required
      • rollback required
    • maximumPercent
    • minimumHealthyPercent

DeploymentController

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

DeploymentControllerType

  • DeploymentControllerType string (values: ECS, CODE_DEPLOY, EXTERNAL)

DeploymentRolloutState

  • DeploymentRolloutState string (values: COMPLETED, FAILED, IN_PROGRESS)

Deployments

DeregisterContainerInstanceRequest

  • DeregisterContainerInstanceRequest object
    • cluster
    • containerInstance required
    • force

DeregisterContainerInstanceResponse

  • DeregisterContainerInstanceResponse object
    • containerInstance
      • tags
      • agentConnected
      • agentUpdateStatus
      • attachments
      • attributes
      • capacityProviderName
      • containerInstanceArn
      • ec2InstanceId
      • pendingTasksCount
      • registeredAt
      • registeredResources
      • remainingResources
      • runningTasksCount
      • status
      • statusReason
      • version
      • versionInfo
        • agentHash
        • agentVersion
        • dockerVersion

DeregisterTaskDefinitionRequest

  • DeregisterTaskDefinitionRequest object
    • taskDefinition required

DeregisterTaskDefinitionResponse

DescribeCapacityProvidersRequest

DescribeCapacityProvidersResponse

  • DescribeCapacityProvidersResponse object

DescribeClustersRequest

DescribeClustersResponse

  • DescribeClustersResponse object

DescribeContainerInstancesRequest

DescribeContainerInstancesResponse

DescribeServicesRequest

  • DescribeServicesRequest object

DescribeServicesResponse

  • DescribeServicesResponse object

DescribeTaskDefinitionRequest

  • DescribeTaskDefinitionRequest object

DescribeTaskDefinitionResponse

DescribeTaskSetsRequest

  • DescribeTaskSetsRequest object

DescribeTaskSetsResponse

  • DescribeTaskSetsResponse object

DescribeTasksRequest

  • DescribeTasksRequest object

DescribeTasksResponse

  • DescribeTasksResponse object

DesiredStatus

  • DesiredStatus string (values: RUNNING, PENDING, STOPPED)

Device

  • Device object: An object representing a container instance host device.

DeviceCgroupPermission

  • DeviceCgroupPermission string (values: read, write, mknod)

DeviceCgroupPermissions

DevicesList

  • DevicesList array

DiscoverPollEndpointRequest

  • DiscoverPollEndpointRequest object
    • cluster
    • containerInstance

DiscoverPollEndpointResponse

  • DiscoverPollEndpointResponse object
    • endpoint
    • telemetryEndpoint

DockerLabelsMap

  • DockerLabelsMap object

DockerVolumeConfiguration

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

Double

  • Double number

EFSAuthorizationConfig

  • EFSAuthorizationConfig object: The authorization configuration details for the Amazon EFS file system.
    • accessPointId
    • iam

EFSAuthorizationConfigIAM

  • EFSAuthorizationConfigIAM string (values: ENABLED, DISABLED)

EFSTransitEncryption

  • EFSTransitEncryption string (values: ENABLED, DISABLED)

EFSVolumeConfiguration

  • EFSVolumeConfiguration object: This parameter is specified when you are using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS Volumes in the Amazon Elastic Container Service Developer Guide.
    • authorizationConfig
      • accessPointId
      • iam
    • fileSystemId required
    • rootDirectory
    • transitEncryption
    • transitEncryptionPort

EnvironmentFile

  • EnvironmentFile object:

    A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file should contain an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored. For more information on the environment variable file syntax, see Declare default environment variables in file.

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

    This field is not valid for containers in tasks using the Fargate launch type.

    • type required
    • value required

EnvironmentFileType

  • EnvironmentFileType string (values: s3)

EnvironmentFiles

EnvironmentVariables

FSxWindowsFileServerAuthorizationConfig

  • FSxWindowsFileServerAuthorizationConfig object:

    The authorization configuration details for Amazon FSx for Windows File Server file system. See FSxWindowsFileServerVolumeConfiguration in the Amazon Elastic Container Service API Reference.

    For more information and the input format, see Amazon FSx for Windows File Server Volumes in the Amazon Elastic Container Service Developer Guide.

    • credentialsParameter required
    • domain required

FSxWindowsFileServerVolumeConfiguration

  • FSxWindowsFileServerVolumeConfiguration object:

    This parameter is specified when you are using Amazon FSx for Windows File Server file system for task storage.

    For more information and the input format, see Amazon FSx for Windows File Server Volumes in the Amazon Elastic Container Service Developer Guide.

    • authorizationConfig required
      • credentialsParameter required
      • domain required
    • fileSystemId required
    • rootDirectory required

Failure

  • Failure object: A failed resource. For a list of common causes, see API failure reasons in the Amazon Elastic Container Service Developer Guide.
    • arn
    • detail
    • reason

Failures

FirelensConfiguration

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

FirelensConfigurationOptionsMap

  • FirelensConfigurationOptionsMap object

FirelensConfigurationType

  • FirelensConfigurationType string (values: fluentd, fluentbit)

GpuIds

HealthCheck

  • HealthCheck object:

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

    You can view the health status of both individual containers and a task with the DescribeTasks API operation or when viewing the task details in the console.

    The following describes the possible healthStatus values for a container:

    • HEALTHY-The container health check has passed successfully.

    • UNHEALTHY-The container health check has failed.

    • UNKNOWN-The container health check is being evaluated or there is no container health check defined.

    The following describes the possible healthStatus values for a task. The container health check status of nonessential containers do not have an effect on the health status of a task.

    • HEALTHY-All essential containers within the task have passed their health checks.

    • UNHEALTHY-One or more essential containers have failed their health check.

    • UNKNOWN-The essential containers within the task are still having their health checks evaluated or there are no container health checks defined.

    If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it.

    The following are notes about container health check support:

    • Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS Container Agent.

    • Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see AWS Fargate Platform Versions.

    • Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer.

    • command required
    • interval
    • retries
    • startPeriod
    • timeout

HealthStatus

  • HealthStatus string (values: HEALTHY, UNHEALTHY, UNKNOWN)

HostEntry

  • HostEntry object: Hostnames and IP address entries that are added to the /etc/hosts file of a container via the extraHosts parameter of its ContainerDefinition.
    • hostname required
    • ipAddress required

HostEntryList

HostVolumeProperties

  • HostVolumeProperties object: Details on a container instance bind mount host volume.
    • sourcePath

InferenceAccelerator

InferenceAcceleratorOverride

  • InferenceAcceleratorOverride object: Details on an Elastic Inference accelerator task override. This parameter is used to override the Elastic Inference accelerator specified in the task definition. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.
    • deviceName
    • deviceType

InferenceAcceleratorOverrides

InferenceAccelerators

Integer

  • Integer integer

InvalidParameterException

IpcMode

  • IpcMode string (values: host, task, none)

KernelCapabilities

  • KernelCapabilities object: The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For more information on the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference. For more detailed information on these Linux capabilities, see the capabilities(7) Linux manual page.

KeyValuePair

  • KeyValuePair object: A key-value pair object.
    • name
    • value

LaunchType

  • LaunchType string (values: EC2, FARGATE)

LimitExceededException

LinuxParameters

  • LinuxParameters object: Linux-specific options that are applied to the container, such as Linux KernelCapabilities.
    • capabilities
    • devices
    • initProcessEnabled
    • maxSwap
    • sharedMemorySize
    • swappiness
    • tmpfs

ListAccountSettingsRequest

  • ListAccountSettingsRequest object
    • effectiveSettings
    • maxResults
    • name
    • nextToken
    • principalArn
    • value

ListAccountSettingsResponse

  • ListAccountSettingsResponse object

ListAttributesRequest

  • ListAttributesRequest object
    • attributeName
    • attributeValue
    • cluster
    • maxResults
    • nextToken
    • targetType required

ListAttributesResponse

  • ListAttributesResponse object

ListClustersRequest

  • ListClustersRequest object
    • maxResults
    • nextToken

ListClustersResponse

  • ListClustersResponse object
    • clusterArns
    • nextToken

ListContainerInstancesRequest

  • ListContainerInstancesRequest object
    • cluster
    • filter
    • maxResults
    • nextToken
    • status

ListContainerInstancesResponse

  • ListContainerInstancesResponse object
    • containerInstanceArns
    • nextToken

ListServicesRequest

  • ListServicesRequest object
    • cluster
    • launchType
    • maxResults
    • nextToken
    • schedulingStrategy

ListServicesResponse

  • ListServicesResponse object
    • nextToken
    • serviceArns

ListTagsForResourceRequest

  • ListTagsForResourceRequest object
    • resourceArn required

ListTagsForResourceResponse

  • ListTagsForResourceResponse object
    • tags

ListTaskDefinitionFamiliesRequest

  • ListTaskDefinitionFamiliesRequest object
    • familyPrefix
    • maxResults
    • nextToken
    • status

ListTaskDefinitionFamiliesResponse

  • ListTaskDefinitionFamiliesResponse object
    • families
    • nextToken

ListTaskDefinitionsRequest

  • ListTaskDefinitionsRequest object
    • familyPrefix
    • maxResults
    • nextToken
    • sort
    • status

ListTaskDefinitionsResponse

  • ListTaskDefinitionsResponse object
    • nextToken
    • taskDefinitionArns

ListTasksRequest

  • ListTasksRequest object
    • cluster
    • containerInstance
    • desiredStatus
    • family
    • launchType
    • maxResults
    • nextToken
    • serviceName
    • startedBy

ListTasksResponse

  • ListTasksResponse object
    • nextToken
    • taskArns

LoadBalancer

  • LoadBalancer object:

    The load balancer configuration to use with a service or task set.

    For specific notes and restrictions regarding the use of load balancers with services and task sets, see the CreateService and CreateTaskSet actions.

    • containerName
    • containerPort
    • loadBalancerName
    • targetGroupArn

LoadBalancers

LogConfiguration

  • LogConfiguration object:

    The log configuration for the container. This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run .

    By default, containers use the same logging driver that the Docker daemon uses; however the container may use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

    The following should be noted when specifying a log configuration for your containers:

    • Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the valid values below). Additional log drivers may be available in future releases of the Amazon ECS container agent.

    • This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.

    • For tasks hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide.

    • For tasks on AWS Fargate, because you do not have access to the underlying infrastructure your tasks are hosted on, any additional software needed will have to be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.

    • logDriver required
    • options
    • secretOptions

LogConfigurationOptionsMap

  • LogConfigurationOptionsMap object

LogDriver

  • LogDriver string (values: json-file, syslog, journald, gelf, fluentd, awslogs, splunk, awsfirelens)

Long

  • Long integer

ManagedScaling

  • ManagedScaling object:

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

    When managed scaling is enabled, Amazon ECS manages the scale-in and scale-out actions of the Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS-managed CloudWatch metric with the specified targetCapacity value as the target value for the metric. For more information, see Using Managed Scaling in the Amazon Elastic Container Service Developer Guide.

    If managed scaling is disabled, the user must manage the scaling of the Auto Scaling group.

    • instanceWarmupPeriod
    • maximumScalingStepSize
    • minimumScalingStepSize
    • status
    • targetCapacity

ManagedScalingInstanceWarmupPeriod

  • ManagedScalingInstanceWarmupPeriod integer

ManagedScalingStatus

  • ManagedScalingStatus string (values: ENABLED, DISABLED)

ManagedScalingStepSize

  • ManagedScalingStepSize integer

ManagedScalingTargetCapacity

  • ManagedScalingTargetCapacity integer

ManagedTerminationProtection

  • ManagedTerminationProtection string (values: ENABLED, DISABLED)

MissingVersionException

MountPoint

  • MountPoint object: Details on a volume mount point that is used in a container definition.
    • containerPath
    • readOnly
    • sourceVolume

MountPointList

NetworkBinding

  • NetworkBinding object: Details on the network bindings between a container and its host container instance. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.
    • bindIP
    • containerPort
    • hostPort
    • protocol

NetworkBindings

NetworkConfiguration

  • NetworkConfiguration object: An object representing the network configuration for a task or service.
    • awsvpcConfiguration
      • assignPublicIp
      • securityGroups
      • subnets required

NetworkInterface

  • NetworkInterface object: An object representing the elastic network interface for tasks that use the awsvpc network mode.
    • attachmentId
    • ipv6Address
    • privateIpv4Address

NetworkInterfaces

NetworkMode

  • NetworkMode string (values: bridge, host, awsvpc, none)

NoUpdateAvailableException

PidMode

  • PidMode string (values: host, task)

PlacementConstraint

  • PlacementConstraint object:

    An object representing a constraint on task placement. For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.

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

    • expression
    • type

PlacementConstraintType

  • PlacementConstraintType string (values: distinctInstance, memberOf)

PlacementConstraints

PlacementStrategies

PlacementStrategy

  • PlacementStrategy object: The task placement strategy for a task or service. For more information, see Task Placement Strategies in the Amazon Elastic Container Service Developer Guide.
    • field
    • type

PlacementStrategyType

  • PlacementStrategyType string (values: random, spread, binpack)

PlatformDevice

  • PlatformDevice object: The devices that are available on the container instance. The only supported device type is a GPU.
    • id required
    • type required

PlatformDeviceType

  • PlatformDeviceType string (values: GPU)

PlatformDevices

PlatformTaskDefinitionIncompatibilityException

PlatformUnknownException

PortMapping

  • PortMapping object:

    Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.

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

    After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.

    • containerPort
    • hostPort
    • protocol

PortMappingList

PropagateTags

  • PropagateTags string (values: TASK_DEFINITION, SERVICE)

ProxyConfiguration

  • ProxyConfiguration object:

    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

ProxyConfigurationProperties

ProxyConfigurationType

  • ProxyConfigurationType string (values: APPMESH)

PutAccountSettingDefaultRequest

  • PutAccountSettingDefaultRequest object
    • name required
    • value required

PutAccountSettingDefaultResponse

  • PutAccountSettingDefaultResponse object

PutAccountSettingRequest

  • PutAccountSettingRequest object
    • name required
    • principalArn
    • value required

PutAccountSettingResponse

  • PutAccountSettingResponse object
    • setting
      • name
      • principalArn
      • value

PutAttributesRequest

  • PutAttributesRequest object
    • attributes required
    • cluster

PutAttributesResponse

  • PutAttributesResponse object

PutClusterCapacityProvidersRequest

  • PutClusterCapacityProvidersRequest object

PutClusterCapacityProvidersResponse

  • PutClusterCapacityProvidersResponse object

RegisterContainerInstanceRequest

  • RegisterContainerInstanceRequest object
    • tags
    • attributes
    • cluster
    • containerInstanceArn
    • instanceIdentityDocument
    • instanceIdentityDocumentSignature
    • platformDevices
    • totalResources
    • versionInfo
      • agentHash
      • agentVersion
      • dockerVersion

RegisterContainerInstanceResponse

  • RegisterContainerInstanceResponse object
    • containerInstance
      • tags
      • agentConnected
      • agentUpdateStatus
      • attachments
      • attributes
      • capacityProviderName
      • containerInstanceArn
      • ec2InstanceId
      • pendingTasksCount
      • registeredAt
      • registeredResources
      • remainingResources
      • runningTasksCount
      • status
      • statusReason
      • version
      • versionInfo
        • agentHash
        • agentVersion
        • dockerVersion

RegisterTaskDefinitionRequest

RegisterTaskDefinitionResponse

RepositoryCredentials

  • RepositoryCredentials object: The repository credentials for private registry authentication.
    • credentialsParameter required

RequiresAttributes

Resource

  • Resource object: Describes the resources available for a container instance.
    • doubleValue
    • integerValue
    • longValue
    • name
    • stringSetValue
    • type

ResourceInUseException

ResourceNotFoundException

ResourceRequirement

ResourceRequirements

ResourceType

  • ResourceType string (values: GPU, InferenceAccelerator)

Resources

RunTaskRequest

RunTaskResponse

  • RunTaskResponse object

Scale

  • Scale object: A floating-point percentage of the desired number of tasks to place and keep running in the task set.
    • unit
    • value

ScaleUnit

  • ScaleUnit string (values: PERCENT)

SchedulingStrategy

  • SchedulingStrategy string (values: REPLICA, DAEMON)

Scope

  • Scope string (values: task, shared)

Secret

  • Secret object:

    An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:

    • To inject sensitive data into your containers as environment variables, use the secrets container definition parameter.

    • To reference sensitive information in the log configuration of a container, use the secretOptions container definition parameter.

    For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

    • name required
    • valueFrom required

SecretList

  • SecretList array

ServerException

Service

  • Service object: Details on a service within a cluster
    • tags
    • capacityProviderStrategy
    • clusterArn
    • createdAt
    • createdBy
    • deploymentConfiguration
      • deploymentCircuitBreaker
        • enable required
        • rollback required
      • maximumPercent
      • minimumHealthyPercent
    • deploymentController
      • type required
    • deployments
    • desiredCount
    • enableECSManagedTags
    • events
    • healthCheckGracePeriodSeconds
    • launchType
    • loadBalancers
    • networkConfiguration
      • awsvpcConfiguration
        • assignPublicIp
        • securityGroups
        • subnets required
    • pendingCount
    • placementConstraints
    • placementStrategy
    • platformVersion
    • propagateTags
    • roleArn
    • runningCount
    • schedulingStrategy
    • serviceArn
    • serviceName
    • serviceRegistries
    • status
    • taskDefinition
    • taskSets

ServiceEvent

  • ServiceEvent object: Details on an event associated with a service.
    • createdAt
    • id
    • message

ServiceEvents

ServiceField

  • ServiceField string (values: TAGS)

ServiceFieldList

ServiceNotActiveException

ServiceNotFoundException

ServiceRegistries

ServiceRegistry

  • ServiceRegistry object: Details of the service registry.
    • containerName
    • containerPort
    • port
    • registryArn

Services

Setting

  • Setting object: The current account setting for a resource.
    • name
    • principalArn
    • value

SettingName

  • SettingName string (values: serviceLongArnFormat, taskLongArnFormat, containerInstanceLongArnFormat, awsvpcTrunking, containerInsights)

Settings

SortOrder

  • SortOrder string (values: ASC, DESC)

StabilityStatus

  • StabilityStatus string (values: STEADY_STATE, STABILIZING)

StartTaskRequest

  • StartTaskRequest object
    • tags
    • cluster
    • containerInstances required
    • enableECSManagedTags
    • group
    • networkConfiguration
      • awsvpcConfiguration
        • assignPublicIp
        • securityGroups
        • subnets required
    • overrides
    • propagateTags
    • referenceId
    • startedBy
    • taskDefinition required

StartTaskResponse

  • StartTaskResponse object

Statistics

StopTaskRequest

  • StopTaskRequest object
    • cluster
    • reason
    • task required

StopTaskResponse

  • StopTaskResponse object
    • task
      • tags
      • attachments
      • attributes
      • availabilityZone
      • capacityProviderName
      • clusterArn
      • connectivity
      • connectivityAt
      • containerInstanceArn
      • containers
      • cpu
      • createdAt
      • desiredStatus
      • executionStoppedAt
      • group
      • healthStatus
      • inferenceAccelerators
      • lastStatus
      • launchType
      • memory
      • overrides
      • platformVersion
      • pullStartedAt
      • pullStoppedAt
      • startedAt
      • startedBy
      • stopCode
      • stoppedAt
      • stoppedReason
      • stoppingAt
      • taskArn
      • taskDefinitionArn
      • version

String

  • String string

StringList

  • StringList array

StringMap

  • StringMap object

SubmitAttachmentStateChangesRequest

SubmitAttachmentStateChangesResponse

  • SubmitAttachmentStateChangesResponse object
    • acknowledgment

SubmitContainerStateChangeRequest

  • SubmitContainerStateChangeRequest object
    • cluster
    • containerName
    • exitCode
    • networkBindings
    • reason
    • runtimeId
    • status
    • task

SubmitContainerStateChangeResponse

  • SubmitContainerStateChangeResponse object
    • acknowledgment

SubmitTaskStateChangeRequest

SubmitTaskStateChangeResponse

  • SubmitTaskStateChangeResponse object
    • acknowledgment

SystemControl

  • SystemControl object:

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

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

    • For tasks that use the awsvpc network mode, if you set systemControls for any container, it applies to all containers in the task. If you set different systemControls for multiple containers in a single task, the container that is started last determines which systemControls take effect.

    • For tasks that use the host network mode, the systemControls parameter applies to the container instance's kernel parameter as well as that of all containers of any tasks running on that container instance.

    • namespace
    • value

SystemControls

Tag

  • Tag object:

    The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

    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.

    • key
    • value

TagKey

  • TagKey string

TagKeys

TagResourceRequest

  • TagResourceRequest object
    • tags required
    • resourceArn required

TagResourceResponse

  • TagResourceResponse object

TagValue

  • TagValue string

Tags

  • Tags array

TargetNotFoundException

TargetType

  • TargetType string (values: container-instance)

Task

  • Task object: Details on a task in a cluster.
    • tags
    • attachments
    • attributes
    • availabilityZone
    • capacityProviderName
    • clusterArn
    • connectivity
    • connectivityAt
    • containerInstanceArn
    • containers
    • cpu
    • createdAt
    • desiredStatus
    • executionStoppedAt
    • group
    • healthStatus
    • inferenceAccelerators
    • lastStatus
    • launchType
    • memory
    • overrides
    • platformVersion
    • pullStartedAt
    • pullStoppedAt
    • startedAt
    • startedBy
    • stopCode
    • stoppedAt
    • stoppedReason
    • stoppingAt
    • taskArn
    • taskDefinitionArn
    • version

TaskDefinition

  • TaskDefinition object: The details of a task definition which describes the container and volume definitions of an Amazon Elastic Container Service task. You can specify which Docker images to use, the required resources, and other configurations related to launching the task definition through an Amazon ECS service or task.

TaskDefinitionFamilyStatus

  • TaskDefinitionFamilyStatus string (values: ACTIVE, INACTIVE, ALL)

TaskDefinitionField

  • TaskDefinitionField string (values: TAGS)

TaskDefinitionFieldList

TaskDefinitionPlacementConstraint

  • TaskDefinitionPlacementConstraint object:

    An object representing a constraint on task placement in the task definition. For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.

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

    • expression
    • type

TaskDefinitionPlacementConstraintType

  • TaskDefinitionPlacementConstraintType string (values: memberOf)

TaskDefinitionPlacementConstraints

TaskDefinitionStatus

  • TaskDefinitionStatus string (values: ACTIVE, INACTIVE)

TaskField

  • TaskField string (values: TAGS)

TaskFieldList

TaskOverride

TaskSet

  • TaskSet object: Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.
    • tags
    • capacityProviderStrategy
    • clusterArn
    • computedDesiredCount
    • createdAt
    • externalId
    • id
    • launchType
    • loadBalancers
    • networkConfiguration
      • awsvpcConfiguration
        • assignPublicIp
        • securityGroups
        • subnets required
    • pendingCount
    • platformVersion
    • runningCount
    • scale
      • unit
      • value
    • serviceArn
    • serviceRegistries
    • stabilityStatus
    • stabilityStatusAt
    • startedBy
    • status
    • taskDefinition
    • taskSetArn
    • updatedAt

TaskSetField

  • TaskSetField string (values: TAGS)

TaskSetFieldList

TaskSetNotFoundException

TaskSets

TaskStopCode

  • TaskStopCode string (values: TaskFailedToStart, EssentialContainerExited, UserInitiated)

Tasks

  • Tasks array

Timestamp

  • Timestamp string

Tmpfs

  • Tmpfs object: The container path, mount options, and size of the tmpfs mount.
    • containerPath required
    • mountOptions
    • size required

TmpfsList

  • TmpfsList array

TransportProtocol

  • TransportProtocol string (values: tcp, udp)

Ulimit

  • Ulimit object: The ulimit settings to pass to the container.
    • hardLimit required
    • name required
    • softLimit required

UlimitList

  • UlimitList array

UlimitName

  • UlimitName string (values: core, cpu, data, fsize, locks, memlock, msgqueue, nice, nofile, nproc, rss, rtprio, rttime, sigpending, stack)

UnsupportedFeatureException

UntagResourceRequest

  • UntagResourceRequest object
    • resourceArn required
    • tagKeys required

UntagResourceResponse

  • UntagResourceResponse object

UpdateCapacityProviderRequest

  • UpdateCapacityProviderRequest object
    • autoScalingGroupProvider required
    • name required

UpdateCapacityProviderResponse

UpdateClusterSettingsRequest

  • UpdateClusterSettingsRequest object

UpdateClusterSettingsResponse

  • UpdateClusterSettingsResponse object

UpdateContainerAgentRequest

  • UpdateContainerAgentRequest object
    • cluster
    • containerInstance required

UpdateContainerAgentResponse

  • UpdateContainerAgentResponse object
    • containerInstance
      • tags
      • agentConnected
      • agentUpdateStatus
      • attachments
      • attributes
      • capacityProviderName
      • containerInstanceArn
      • ec2InstanceId
      • pendingTasksCount
      • registeredAt
      • registeredResources
      • remainingResources
      • runningTasksCount
      • status
      • statusReason
      • version
      • versionInfo
        • agentHash
        • agentVersion
        • dockerVersion

UpdateContainerInstancesStateRequest

  • UpdateContainerInstancesStateRequest object
    • cluster
    • containerInstances required
    • status required

UpdateContainerInstancesStateResponse

UpdateInProgressException

UpdateServicePrimaryTaskSetRequest

  • UpdateServicePrimaryTaskSetRequest object
    • cluster required
    • primaryTaskSet required
    • service required

UpdateServicePrimaryTaskSetResponse

  • UpdateServicePrimaryTaskSetResponse object

UpdateServiceRequest

  • UpdateServiceRequest object
    • capacityProviderStrategy
    • cluster
    • deploymentConfiguration
      • deploymentCircuitBreaker
        • enable required
        • rollback required
      • maximumPercent
      • minimumHealthyPercent
    • desiredCount
    • forceNewDeployment
    • healthCheckGracePeriodSeconds
    • networkConfiguration NetworkConfiguration
    • placementConstraints
    • placementStrategy
    • platformVersion
    • service required
    • taskDefinition

UpdateServiceResponse

  • UpdateServiceResponse object
    • service
      • tags
      • capacityProviderStrategy
      • clusterArn
      • createdAt
      • createdBy
      • deploymentConfiguration
        • deploymentCircuitBreaker
          • enable required
          • rollback required
        • maximumPercent
        • minimumHealthyPercent
      • deploymentController
        • type required
      • deployments
      • desiredCount
      • enableECSManagedTags
      • events
      • healthCheckGracePeriodSeconds
      • launchType
      • loadBalancers
      • networkConfiguration
        • awsvpcConfiguration
          • assignPublicIp
          • securityGroups
          • subnets required
      • pendingCount
      • placementConstraints
      • placementStrategy
      • platformVersion
      • propagateTags
      • roleArn
      • runningCount
      • schedulingStrategy
      • serviceArn
      • serviceName
      • serviceRegistries
      • status
      • taskDefinition
      • taskSets

UpdateTaskSetRequest

  • UpdateTaskSetRequest object
    • cluster required
    • scale required Scale
    • service required
    • taskSet required

UpdateTaskSetResponse

  • UpdateTaskSetResponse object

VersionInfo

  • VersionInfo object: The Docker and Amazon ECS container agent version information about a container instance.
    • agentHash
    • agentVersion
    • dockerVersion

Volume

  • Volume object: A data volume used in a task definition. For tasks that use the Amazon Elastic File System (Amazon EFS), specify an efsVolumeConfiguration. For Windows tasks that use Amazon FSx for Windows File Server file system, specify a fsxWindowsFileServerVolumeConfiguration. For tasks that use a Docker volume, specify a DockerVolumeConfiguration. For tasks that use a bind mount host volume, specify a host and optional sourcePath. For more information, see Using Data Volumes in Tasks.
    • host
      • sourcePath
    • dockerVolumeConfiguration
      • autoprovision
      • driver
      • driverOpts
      • labels
      • scope
    • efsVolumeConfiguration
      • authorizationConfig
        • accessPointId
        • iam
      • fileSystemId required
      • rootDirectory
      • transitEncryption
      • transitEncryptionPort
    • fsxWindowsFileServerVolumeConfiguration
      • authorizationConfig required
        • credentialsParameter required
        • domain required
      • fileSystemId required
      • rootDirectory required
    • name

VolumeFrom

  • VolumeFrom object: Details on a data volume from another container in the same task definition.
    • readOnly
    • sourceContainer

VolumeFromList

VolumeList

  • VolumeList array