@datafire/amazonaws_ecs
v5.0.0
Published
DataFire integration for Amazon EC2 Container Service
Downloads
23
Readme
@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: ""
});
amazonaws_ecs.CreateCluster({}).then(data => {
console.log(data);
});
Description
Actions
CreateCluster
amazonaws_ecs.CreateCluster({}, context)
Input
- input
object
- clusterName String
Output
- output CreateClusterResponse
CreateService
amazonaws_ecs.CreateService({
"serviceName": "",
"taskDefinition": "",
"desiredCount": 0
}, context)
Input
- input
object
- clientToken String
- cluster String
- deploymentConfiguration DeploymentConfiguration
- desiredCount required BoxedInteger
- healthCheckGracePeriodSeconds BoxedInteger
- launchType LaunchType
- loadBalancers LoadBalancers
- networkConfiguration NetworkConfiguration
- placementConstraints PlacementConstraints
- placementStrategy PlacementStrategies
- platformVersion String
- role String
- serviceName required String
- taskDefinition required String
Output
- output CreateServiceResponse
DeleteAttributes
amazonaws_ecs.DeleteAttributes({
"attributes": []
}, context)
Input
- input
object
- attributes required Attributes
- cluster String
Output
- output DeleteAttributesResponse
DeleteCluster
amazonaws_ecs.DeleteCluster({
"cluster": ""
}, context)
Input
- input
object
- cluster required String
Output
- output DeleteClusterResponse
DeleteService
amazonaws_ecs.DeleteService({
"service": ""
}, context)
Input
Output
- output DeleteServiceResponse
DeregisterContainerInstance
amazonaws_ecs.DeregisterContainerInstance({
"containerInstance": ""
}, context)
Input
- input
object
- cluster String
- containerInstance required String
- force BoxedBoolean
Output
DeregisterTaskDefinition
amazonaws_ecs.DeregisterTaskDefinition({
"taskDefinition": ""
}, context)
Input
- input
object
- taskDefinition required String
Output
DescribeClusters
amazonaws_ecs.DescribeClusters({}, context)
Input
- input
object
- clusters StringList
- include ClusterFieldList
Output
- output DescribeClustersResponse
DescribeContainerInstances
amazonaws_ecs.DescribeContainerInstances({
"containerInstances": []
}, context)
Input
- input
object
- cluster String
- containerInstances required StringList
Output
DescribeServices
amazonaws_ecs.DescribeServices({
"services": []
}, context)
Input
- input
object
- cluster String
- services required StringList
Output
- output DescribeServicesResponse
DescribeTaskDefinition
amazonaws_ecs.DescribeTaskDefinition({
"taskDefinition": ""
}, context)
Input
- input
object
- taskDefinition required String
Output
DescribeTasks
amazonaws_ecs.DescribeTasks({
"tasks": []
}, context)
Input
- input
object
- cluster String
- tasks required StringList
Output
- output DescribeTasksResponse
DiscoverPollEndpoint
amazonaws_ecs.DiscoverPollEndpoint({}, context)
Input
Output
- output DiscoverPollEndpointResponse
ListAttributes
amazonaws_ecs.ListAttributes({
"targetType": ""
}, context)
Input
- input
object
- attributeName String
- attributeValue String
- cluster String
- maxResults BoxedInteger
- nextToken String
- targetType required TargetType
Output
- output ListAttributesResponse
ListClusters
amazonaws_ecs.ListClusters({}, context)
Input
- input
object
- maxResults
string
- nextToken
string
- maxResults BoxedInteger
- nextToken String
- maxResults
Output
- output ListClustersResponse
ListContainerInstances
amazonaws_ecs.ListContainerInstances({}, context)
Input
- input
object
- maxResults
string
- nextToken
string
- cluster String
- filter String
- maxResults BoxedInteger
- nextToken String
- status ContainerInstanceStatus
- maxResults
Output
ListServices
amazonaws_ecs.ListServices({}, context)
Input
- input
object
- maxResults
string
- nextToken
string
- cluster String
- launchType LaunchType
- maxResults BoxedInteger
- nextToken String
- maxResults
Output
- output ListServicesResponse
ListTaskDefinitionFamilies
amazonaws_ecs.ListTaskDefinitionFamilies({}, context)
Input
- input
object
- maxResults
string
- nextToken
string
- familyPrefix String
- maxResults BoxedInteger
- nextToken String
- status TaskDefinitionFamilyStatus
- maxResults
Output
ListTaskDefinitions
amazonaws_ecs.ListTaskDefinitions({}, context)
Input
- input
object
- maxResults
string
- nextToken
string
- familyPrefix String
- maxResults BoxedInteger
- nextToken String
- sort SortOrder
- status TaskDefinitionStatus
- maxResults
Output
- output ListTaskDefinitionsResponse
ListTasks
amazonaws_ecs.ListTasks({}, context)
Input
- input
object
- maxResults
string
- nextToken
string
- cluster String
- containerInstance String
- desiredStatus DesiredStatus
- family String
- launchType LaunchType
- maxResults BoxedInteger
- nextToken String
- serviceName String
- startedBy String
- maxResults
Output
- output ListTasksResponse
PutAttributes
amazonaws_ecs.PutAttributes({
"attributes": []
}, context)
Input
- input
object
- attributes required Attributes
- cluster String
Output
- output PutAttributesResponse
RegisterContainerInstance
amazonaws_ecs.RegisterContainerInstance({}, context)
Input
- input
object
- attributes Attributes
- cluster String
- containerInstanceArn String
- instanceIdentityDocument String
- instanceIdentityDocumentSignature String
- totalResources Resources
- versionInfo VersionInfo
Output
RegisterTaskDefinition
amazonaws_ecs.RegisterTaskDefinition({
"family": "",
"containerDefinitions": []
}, context)
Input
- input
object
- containerDefinitions required ContainerDefinitions
- cpu String
- executionRoleArn String
- family required String
- memory String
- networkMode NetworkMode
- placementConstraints TaskDefinitionPlacementConstraints
- requiresCompatibilities CompatibilityList
- taskRoleArn String
- volumes VolumeList
Output
RunTask
amazonaws_ecs.RunTask({
"taskDefinition": ""
}, context)
Input
- input
object
- cluster String
- count BoxedInteger
- group String
- launchType LaunchType
- networkConfiguration NetworkConfiguration
- overrides TaskOverride
- placementConstraints PlacementConstraints
- placementStrategy PlacementStrategies
- platformVersion String
- startedBy String
- taskDefinition required String
Output
- output RunTaskResponse
StartTask
amazonaws_ecs.StartTask({
"taskDefinition": "",
"containerInstances": []
}, context)
Input
- input
object
- cluster String
- containerInstances required StringList
- group String
- networkConfiguration NetworkConfiguration
- overrides TaskOverride
- startedBy String
- taskDefinition required String
Output
- output StartTaskResponse
StopTask
amazonaws_ecs.StopTask({
"task": ""
}, context)
Input
Output
- output StopTaskResponse
SubmitContainerStateChange
amazonaws_ecs.SubmitContainerStateChange({}, context)
Input
- input
object
- cluster String
- containerName String
- exitCode BoxedInteger
- networkBindings NetworkBindings
- reason String
- status String
- task String
Output
SubmitTaskStateChange
amazonaws_ecs.SubmitTaskStateChange({}, context)
Input
- input
object
- attachments AttachmentStateChanges
- cluster String
- containers ContainerStateChanges
- executionStoppedAt Timestamp
- pullStartedAt Timestamp
- pullStoppedAt Timestamp
- reason String
- status String
- task String
Output
UpdateContainerAgent
amazonaws_ecs.UpdateContainerAgent({
"containerInstance": ""
}, context)
Input
Output
- output UpdateContainerAgentResponse
UpdateContainerInstancesState
amazonaws_ecs.UpdateContainerInstancesState({
"containerInstances": [],
"status": ""
}, context)
Input
- input
object
- cluster String
- containerInstances required StringList
- status required ContainerInstanceStatus
Output
UpdateService
amazonaws_ecs.UpdateService({
"service": ""
}, context)
Input
- input
object
- cluster String
- deploymentConfiguration DeploymentConfiguration
- desiredCount BoxedInteger
- forceNewDeployment Boolean
- healthCheckGracePeriodSeconds BoxedInteger
- networkConfiguration NetworkConfiguration
- platformVersion String
- service required String
- taskDefinition String
Output
- output UpdateServiceResponse
Definitions
AccessDeniedException
- AccessDeniedException
object
: You do not have authorization to perform the requested action.
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.- details AttachmentDetails
- id String
- status String
- type String
AttachmentDetails
- AttachmentDetails
array
- items KeyValuePair
AttachmentStateChange
- AttachmentStateChange
object
: An object representing a change in state for a task attachment.
AttachmentStateChanges
- AttachmentStateChanges
array
- items AttachmentStateChange
Attachments
- Attachments
array
- items Attachment
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 String
- targetId String
- targetType TargetType
- value String
AttributeLimitExceededException
- AttributeLimitExceededException
object
: You can apply up to 10 custom attributes per resource. You can view the attributes of a resource with ListAttributes. You can remove existing attributes on a resource with DeleteAttributes.
Attributes
- Attributes
array
- items Attribute
AwsVpcConfiguration
- AwsVpcConfiguration
object
: An object representing the networking details for a task or service.- assignPublicIp AssignPublicIp
- securityGroups StringList
- subnets required StringList
BlockedException
- BlockedException
object
: Your AWS account has been blocked. Contact AWS Customer Support for more information.
Boolean
- Boolean
boolean
BoxedBoolean
- BoxedBoolean
boolean
BoxedInteger
- BoxedInteger
integer
ClientException
- ClientException
object
: These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.- message String
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
- ClusterContainsContainerInstancesException
object
: You cannot delete a cluster that has registered container instances. You must first deregister the container instances before you can delete the cluster. For more information, see DeregisterContainerInstance.
ClusterContainsServicesException
- ClusterContainsServicesException
object
: You cannot delete a cluster that contains services. You must first update the service to reduce its desired task count to 0 and then delete the service. For more information, see UpdateService and DeleteService.
ClusterContainsTasksException
- ClusterContainsTasksException
object
: You cannot delete a cluster that has active tasks.
ClusterField
- ClusterField
string
(values: STATISTICS)
ClusterFieldList
- ClusterFieldList
array
- items ClusterField
ClusterNotFoundException
- ClusterNotFoundException
object
: The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.
Clusters
- Clusters
array
- items Cluster
Compatibility
- Compatibility
string
(values: EC2, FARGATE)
CompatibilityList
- CompatibilityList
array
- items Compatibility
Connectivity
- Connectivity
string
(values: CONNECTED, DISCONNECTED)
Container
- Container
object
: A Docker container that is part of a task.- containerArn String
- exitCode BoxedInteger
- lastStatus String
- name String
- networkBindings NetworkBindings
- networkInterfaces NetworkInterfaces
- reason String
- taskArn String
ContainerDefinition
- ContainerDefinition
object
: Container definitions are used in task definitions to describe the different containers that are launched as part of a task.- command StringList
- cpu Integer
- disableNetworking BoxedBoolean
- dnsSearchDomains StringList
- dnsServers StringList
- dockerLabels DockerLabelsMap
- dockerSecurityOptions StringList
- entryPoint StringList
- environment EnvironmentVariables
- essential BoxedBoolean
- extraHosts HostEntryList
- hostname String
- image String
- links StringList
- linuxParameters LinuxParameters
- logConfiguration LogConfiguration
- memory BoxedInteger
- memoryReservation BoxedInteger
- mountPoints MountPointList
- name String
- portMappings PortMappingList
- privileged BoxedBoolean
- readonlyRootFilesystem BoxedBoolean
- ulimits UlimitList
- user String
- volumesFrom VolumeFromList
- workingDirectory String
ContainerDefinitions
- ContainerDefinitions
array
- items ContainerDefinition
ContainerInstance
- ContainerInstance
object
: An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.- agentConnected Boolean
- agentUpdateStatus AgentUpdateStatus
- attachments Attachments
- attributes Attributes
- containerInstanceArn String
- ec2InstanceId String
- pendingTasksCount Integer
- registeredAt Timestamp
- registeredResources Resources
- remainingResources Resources
- runningTasksCount Integer
- status String
- version Long
- versionInfo VersionInfo
ContainerInstanceStatus
- ContainerInstanceStatus
string
(values: ACTIVE, DRAINING)
ContainerInstances
- ContainerInstances
array
- items ContainerInstance
ContainerOverride
- ContainerOverride
object
: The overrides that should be sent to a container.- command StringList
- cpu BoxedInteger
- environment EnvironmentVariables
- memory BoxedInteger
- memoryReservation BoxedInteger
- name String
ContainerOverrides
- ContainerOverrides
array
- items ContainerOverride
ContainerStateChange
- ContainerStateChange
object
: An object representing a change in state for a container.- containerName String
- exitCode BoxedInteger
- networkBindings NetworkBindings
- reason String
- status String
ContainerStateChanges
- ContainerStateChanges
array
- items ContainerStateChange
Containers
- Containers
array
- items Container
CreateClusterRequest
- CreateClusterRequest
object
- clusterName String
CreateClusterResponse
- CreateClusterResponse
object
- cluster Cluster
CreateServiceRequest
- CreateServiceRequest
object
- clientToken String
- cluster String
- deploymentConfiguration DeploymentConfiguration
- desiredCount required BoxedInteger
- healthCheckGracePeriodSeconds BoxedInteger
- launchType LaunchType
- loadBalancers LoadBalancers
- networkConfiguration NetworkConfiguration
- placementConstraints PlacementConstraints
- placementStrategy PlacementStrategies
- platformVersion String
- role String
- serviceName required String
- taskDefinition required String
CreateServiceResponse
- CreateServiceResponse
object
- service Service
DeleteAttributesRequest
- DeleteAttributesRequest
object
- attributes required Attributes
- cluster String
DeleteAttributesResponse
- DeleteAttributesResponse
object
- attributes Attributes
DeleteClusterRequest
- DeleteClusterRequest
object
- cluster required String
DeleteClusterResponse
- DeleteClusterResponse
object
- cluster Cluster
DeleteServiceRequest
DeleteServiceResponse
- DeleteServiceResponse
object
- service Service
Deployment
- Deployment
object
: The details of an Amazon ECS service deployment.
DeploymentConfiguration
- DeploymentConfiguration
object
: Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.- maximumPercent BoxedInteger
- minimumHealthyPercent BoxedInteger
Deployments
- Deployments
array
- items Deployment
DeregisterContainerInstanceRequest
- DeregisterContainerInstanceRequest
object
- cluster String
- containerInstance required String
- force BoxedBoolean
DeregisterContainerInstanceResponse
- DeregisterContainerInstanceResponse
object
- containerInstance ContainerInstance
DeregisterTaskDefinitionRequest
- DeregisterTaskDefinitionRequest
object
- taskDefinition required String
DeregisterTaskDefinitionResponse
- DeregisterTaskDefinitionResponse
object
- taskDefinition TaskDefinition
DescribeClustersRequest
- DescribeClustersRequest
object
- clusters StringList
- include ClusterFieldList
DescribeClustersResponse
DescribeContainerInstancesRequest
- DescribeContainerInstancesRequest
object
- cluster String
- containerInstances required StringList
DescribeContainerInstancesResponse
- DescribeContainerInstancesResponse
object
- containerInstances ContainerInstances
- failures Failures
DescribeServicesRequest
- DescribeServicesRequest
object
- cluster String
- services required StringList
DescribeServicesResponse
DescribeTaskDefinitionRequest
- DescribeTaskDefinitionRequest
object
- taskDefinition required String
DescribeTaskDefinitionResponse
- DescribeTaskDefinitionResponse
object
- taskDefinition TaskDefinition
DescribeTasksRequest
- DescribeTasksRequest
object
- cluster String
- tasks required StringList
DescribeTasksResponse
DesiredStatus
- DesiredStatus
string
(values: RUNNING, PENDING, STOPPED)
Device
- Device
object
: An object representing a container instance host device.- containerPath String
- hostPath required String
- permissions DeviceCgroupPermissions
DeviceCgroupPermission
- DeviceCgroupPermission
string
(values: read, write, mknod)
DeviceCgroupPermissions
- DeviceCgroupPermissions
array
- items DeviceCgroupPermission
DevicesList
- DevicesList
array
- items Device
DiscoverPollEndpointRequest
DiscoverPollEndpointResponse
DockerLabelsMap
Double
- Double
number
EnvironmentVariables
- EnvironmentVariables
array
- items KeyValuePair
Failure
Failures
- Failures
array
- items Failure
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.
HostEntryList
- HostEntryList
array
- items HostEntry
HostVolumeProperties
- HostVolumeProperties
object
: Details on a container instance host volume.- sourcePath String
Integer
- Integer
integer
InvalidParameterException
- InvalidParameterException
object
: The specified parameter is invalid. Review the available parameters for the API request.
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.- add StringList
- drop StringList
KeyValuePair
LaunchType
- LaunchType
string
(values: EC2, FARGATE)
LinuxParameters
- LinuxParameters
object
: Linux-specific options that are applied to the container, such as Linux KernelCapabilities.- capabilities KernelCapabilities
- devices DevicesList
- initProcessEnabled BoxedBoolean
ListAttributesRequest
- ListAttributesRequest
object
- attributeName String
- attributeValue String
- cluster String
- maxResults BoxedInteger
- nextToken String
- targetType required TargetType
ListAttributesResponse
- ListAttributesResponse
object
- attributes Attributes
- nextToken String
ListClustersRequest
- ListClustersRequest
object
- maxResults BoxedInteger
- nextToken String
ListClustersResponse
- ListClustersResponse
object
- clusterArns StringList
- nextToken String
ListContainerInstancesRequest
- ListContainerInstancesRequest
object
- cluster String
- filter String
- maxResults BoxedInteger
- nextToken String
- status ContainerInstanceStatus
ListContainerInstancesResponse
- ListContainerInstancesResponse
object
- containerInstanceArns StringList
- nextToken String
ListServicesRequest
- ListServicesRequest
object
- cluster String
- launchType LaunchType
- maxResults BoxedInteger
- nextToken String
ListServicesResponse
- ListServicesResponse
object
- nextToken String
- serviceArns StringList
ListTaskDefinitionFamiliesRequest
- ListTaskDefinitionFamiliesRequest
object
- familyPrefix String
- maxResults BoxedInteger
- nextToken String
- status TaskDefinitionFamilyStatus
ListTaskDefinitionFamiliesResponse
- ListTaskDefinitionFamiliesResponse
object
- families StringList
- nextToken String
ListTaskDefinitionsRequest
- ListTaskDefinitionsRequest
object
- familyPrefix String
- maxResults BoxedInteger
- nextToken String
- sort SortOrder
- status TaskDefinitionStatus
ListTaskDefinitionsResponse
- ListTaskDefinitionsResponse
object
- nextToken String
- taskDefinitionArns StringList
ListTasksRequest
- ListTasksRequest
object
- cluster String
- containerInstance String
- desiredStatus DesiredStatus
- family String
- launchType LaunchType
- maxResults BoxedInteger
- nextToken String
- serviceName String
- startedBy String
ListTasksResponse
- ListTasksResponse
object
- nextToken String
- taskArns StringList
LoadBalancer
- LoadBalancer
object
: Details on a load balancer that is used with a service.- containerName String
- containerPort BoxedInteger
- loadBalancerName String
- targetGroupArn String
LoadBalancers
- LoadBalancers
array
- items LoadBalancer
LogConfiguration
- LogConfiguration
object
: Log configuration options to send to a custom log driver for the container.- logDriver required LogDriver
- options LogConfigurationOptionsMap
LogConfigurationOptionsMap
LogDriver
- LogDriver
string
(values: json-file, syslog, journald, gelf, fluentd, awslogs, splunk)
Long
- Long
integer
MissingVersionException
- MissingVersionException
object
: Amazon ECS is unable to determine the current version of the Amazon ECS container agent on the container instance and does not have enough information to proceed with an update. This could be because the agent running on the container instance is an older or custom version that does not use our version information.
MountPoint
- MountPoint
object
: Details on a volume mount point that is used in a container definition.- containerPath String
- readOnly BoxedBoolean
- sourceVolume String
MountPointList
- MountPointList
array
- items MountPoint
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 String
- containerPort BoxedInteger
- hostPort BoxedInteger
- protocol TransportProtocol
NetworkBindings
- NetworkBindings
array
- items NetworkBinding
NetworkConfiguration
- NetworkConfiguration
object
: An object representing the network configuration for a task or service.- awsvpcConfiguration AwsVpcConfiguration
NetworkInterface
- NetworkInterface
object
: An object representing the Elastic Network Interface for tasks that use the awsvpc network mode.
NetworkInterfaces
- NetworkInterfaces
array
- items NetworkInterface
NetworkMode
- NetworkMode
string
(values: bridge, host, awsvpc, none)
NoUpdateAvailableException
- NoUpdateAvailableException
object
: There is no update available for this Amazon ECS container agent. This could be because the agent is already running the latest version, or it is so old that there is no update path to the current version.
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.- expression String
- type PlacementConstraintType
PlacementConstraintType
- PlacementConstraintType
string
(values: distinctInstance, memberOf)
PlacementConstraints
- PlacementConstraints
array
- items PlacementConstraint
PlacementStrategies
- PlacementStrategies
array
- items PlacementStrategy
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 String
- type PlacementStrategyType
PlacementStrategyType
- PlacementStrategyType
string
(values: random, spread, binpack)
PlatformTaskDefinitionIncompatibilityException
- PlatformTaskDefinitionIncompatibilityException
object
: The specified platform version does not satisfy the task definition’s required capabilities.
PlatformUnknownException
- PlatformUnknownException
object
: The specified platform version does not exist.
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 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 BoxedInteger
- hostPort BoxedInteger
- protocol TransportProtocol
PortMappingList
- PortMappingList
array
- items PortMapping
PutAttributesRequest
- PutAttributesRequest
object
- attributes required Attributes
- cluster String
PutAttributesResponse
- PutAttributesResponse
object
- attributes Attributes
RegisterContainerInstanceRequest
- RegisterContainerInstanceRequest
object
- attributes Attributes
- cluster String
- containerInstanceArn String
- instanceIdentityDocument String
- instanceIdentityDocumentSignature String
- totalResources Resources
- versionInfo VersionInfo
RegisterContainerInstanceResponse
- RegisterContainerInstanceResponse
object
- containerInstance ContainerInstance
RegisterTaskDefinitionRequest
- RegisterTaskDefinitionRequest
object
- containerDefinitions required ContainerDefinitions
- cpu String
- executionRoleArn String
- family required String
- memory String
- networkMode NetworkMode
- placementConstraints TaskDefinitionPlacementConstraints
- requiresCompatibilities CompatibilityList
- taskRoleArn String
- volumes VolumeList
RegisterTaskDefinitionResponse
- RegisterTaskDefinitionResponse
object
- taskDefinition TaskDefinition
RequiresAttributes
- RequiresAttributes
array
- items Attribute
Resource
- Resource
object
: Describes the resources available for a container instance.
Resources
- Resources
array
- items Resource
RunTaskRequest
- RunTaskRequest
object
- cluster String
- count BoxedInteger
- group String
- launchType LaunchType
- networkConfiguration NetworkConfiguration
- overrides TaskOverride
- placementConstraints PlacementConstraints
- placementStrategy PlacementStrategies
- platformVersion String
- startedBy String
- taskDefinition required String
RunTaskResponse
ServerException
- ServerException
object
: These errors are usually caused by a server issue.- message String
Service
- Service
object
: Details on a service within a cluster- clusterArn String
- createdAt Timestamp
- deploymentConfiguration DeploymentConfiguration
- deployments Deployments
- desiredCount Integer
- events ServiceEvents
- healthCheckGracePeriodSeconds BoxedInteger
- launchType LaunchType
- loadBalancers LoadBalancers
- networkConfiguration NetworkConfiguration
- pendingCount Integer
- placementConstraints PlacementConstraints
- placementStrategy PlacementStrategies
- platformVersion String
- roleArn String
- runningCount Integer
- serviceArn String
- serviceName String
- status String
- taskDefinition String
ServiceEvent
- ServiceEvent
object
: Details on an event associated with a service.
ServiceEvents
- ServiceEvents
array
- items ServiceEvent
ServiceNotActiveException
- ServiceNotActiveException
object
: The specified service is not active. You can't update a service that is inactive. If you have previously deleted a service, you can re-create it with CreateService.
ServiceNotFoundException
- ServiceNotFoundException
object
: The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and region-specific.
Services
- Services
array
- items Service
SortOrder
- SortOrder
string
(values: ASC, DESC)
StartTaskRequest
- StartTaskRequest
object
- cluster String
- containerInstances required StringList
- group String
- networkConfiguration NetworkConfiguration
- overrides TaskOverride
- startedBy String
- taskDefinition required String
StartTaskResponse
Statistics
- Statistics
array
- items KeyValuePair
StopTaskRequest
StopTaskResponse
- StopTaskResponse
object
- task Task
String
- String
string
StringList
- StringList
array
- items String
SubmitContainerStateChangeRequest
- SubmitContainerStateChangeRequest
object
- cluster String
- containerName String
- exitCode BoxedInteger
- networkBindings NetworkBindings
- reason String
- status String
- task String
SubmitContainerStateChangeResponse
- SubmitContainerStateChangeResponse
object
- acknowledgment String
SubmitTaskStateChangeRequest
- SubmitTaskStateChangeRequest
object
- attachments AttachmentStateChanges
- cluster String
- containers ContainerStateChanges
- executionStoppedAt Timestamp
- pullStartedAt Timestamp
- pullStoppedAt Timestamp
- reason String
- status String
- task String
SubmitTaskStateChangeResponse
- SubmitTaskStateChangeResponse
object
- acknowledgment String
TargetNotFoundException
- TargetNotFoundException
object
: The specified target could not be found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and region-specific.
TargetType
- TargetType
string
(values: container-instance)
Task
- Task
object
: Details on a task in a cluster.- attachments Attachments
- clusterArn String
- connectivity Connectivity
- connectivityAt Timestamp
- containerInstanceArn String
- containers Containers
- cpu String
- createdAt Timestamp
- desiredStatus String
- executionStoppedAt Timestamp
- group String
- lastStatus String
- launchType LaunchType
- memory String
- overrides TaskOverride
- platformVersion String
- pullStartedAt Timestamp
- pullStoppedAt Timestamp
- startedAt Timestamp
- startedBy String
- stoppedAt Timestamp
- stoppedReason String
- stoppingAt Timestamp
- taskArn String
- taskDefinitionArn String
- version Long
TaskDefinition
- TaskDefinition
object
: Details of a task definition.- compatibilities CompatibilityList
- containerDefinitions ContainerDefinitions
- cpu String
- executionRoleArn String
- family String
- memory String
- networkMode NetworkMode
- placementConstraints TaskDefinitionPlacementConstraints
- requiresAttributes RequiresAttributes
- requiresCompatibilities CompatibilityList
- revision Integer
- status TaskDefinitionStatus
- taskDefinitionArn String
- taskRoleArn String
- volumes VolumeList
TaskDefinitionFamilyStatus
- TaskDefinitionFamilyStatus
string
(values: ACTIVE, INACTIVE, ALL)
TaskDefinitionPlacementConstraint
- TaskDefinitionPlacementConstraint
object
: An object representing a constraint on task placement in the task definition. If you are using the Fargate launch type, task placement contraints are not supported. For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.- expression String
- type TaskDefinitionPlacementConstraintType
TaskDefinitionPlacementConstraintType
- TaskDefinitionPlacementConstraintType
string
(values: memberOf)
TaskDefinitionPlacementConstraints
- TaskDefinitionPlacementConstraints
array
TaskDefinitionStatus
- TaskDefinitionStatus
string
(values: ACTIVE, INACTIVE)
TaskOverride
- TaskOverride
object
: The overrides associated with a task.- containerOverrides ContainerOverrides
- executionRoleArn String
- taskRoleArn String
Tasks
- Tasks
array
- items Task
Timestamp
- Timestamp
string
TransportProtocol
- TransportProtocol
string
(values: tcp, udp)
Ulimit
- Ulimit
object
: The ulimit settings to pass to the container.- hardLimit required Integer
- name required UlimitName
- softLimit required Integer
UlimitList
- UlimitList
array
- items Ulimit
UlimitName
- UlimitName
string
(values: core, cpu, data, fsize, locks, memlock, msgqueue, nice, nofile, nproc, rss, rtprio, rttime, sigpending, stack)
UnsupportedFeatureException
- UnsupportedFeatureException
object
: The specified task is not supported in this region.
UpdateContainerAgentRequest
UpdateContainerAgentResponse
- UpdateContainerAgentResponse
object
- containerInstance ContainerInstance
UpdateContainerInstancesStateRequest
- UpdateContainerInstancesStateRequest
object
- cluster String
- containerInstances required StringList
- status required ContainerInstanceStatus
UpdateContainerInstancesStateResponse
- UpdateContainerInstancesStateResponse
object
- containerInstances ContainerInstances
- failures Failures
UpdateInProgressException
- UpdateInProgressException
object
: There is already a current Amazon ECS container agent update in progress on the specified container instance. If the container agent becomes disconnected while it is in a transitional stage, such as PENDING or STAGING, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.
UpdateServiceRequest
- UpdateServiceRequest
object
- cluster String
- deploymentConfiguration DeploymentConfiguration
- desiredCount BoxedInteger
- forceNewDeployment Boolean
- healthCheckGracePeriodSeconds BoxedInteger
- networkConfiguration NetworkConfiguration
- platformVersion String
- service required String
- taskDefinition String
UpdateServiceResponse
- UpdateServiceResponse
object
- service Service
VersionInfo
- VersionInfo
object
: The Docker and Amazon ECS container agent version information about a container instance.
Volume
- Volume
object
: A data volume used in a task definition.- host HostVolumeProperties
- name String
VolumeFrom
- VolumeFrom
object
: Details on a data volume from another container in the same task definition.- readOnly BoxedBoolean
- sourceContainer String
VolumeFromList
- VolumeFromList
array
- items VolumeFrom
VolumeList
- VolumeList
array
- items Volume