❤
npm
Sign UpSign In

@datafire/amazonaws_ecs

5.0.0 • Public • Published

@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

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

CreateCluster

amazonaws_ecs.CreateCluster({}, context)

Input

  • input object

Output

CreateService

amazonaws_ecs.CreateService({
  "serviceName": "",
  "taskDefinition": "",
  "desiredCount": 0
}, context)

Input

Output

DeleteAttributes

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

Input

Output

DeleteCluster

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

Input

  • input object

Output

DeleteService

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

Input

Output

DeregisterContainerInstance

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

Input

Output

DeregisterTaskDefinition

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

Input

  • input object
    • taskDefinition required String

Output

DescribeClusters

amazonaws_ecs.DescribeClusters({}, context)

Input

Output

DescribeContainerInstances

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

Input

Output

DescribeServices

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

Input

Output

DescribeTaskDefinition

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

Input

  • input object
    • taskDefinition required String

Output

DescribeTasks

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

Input

Output

DiscoverPollEndpoint

amazonaws_ecs.DiscoverPollEndpoint({}, context)

Input

Output

ListAttributes

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

Input

Output

ListClusters

amazonaws_ecs.ListClusters({}, context)

Input

  • input object

Output

ListContainerInstances

amazonaws_ecs.ListContainerInstances({}, context)

Input

Output

ListServices

amazonaws_ecs.ListServices({}, context)

Input

Output

ListTaskDefinitionFamilies

amazonaws_ecs.ListTaskDefinitionFamilies({}, context)

Input

Output

ListTaskDefinitions

amazonaws_ecs.ListTaskDefinitions({}, context)

Input

Output

ListTasks

amazonaws_ecs.ListTasks({}, context)

Input

Output

PutAttributes

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

Input

Output

RegisterContainerInstance

amazonaws_ecs.RegisterContainerInstance({}, context)

Input

Output

RegisterTaskDefinition

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

Input

Output

RunTask

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

Input

Output

StartTask

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

Input

Output

StopTask

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

Input

Output

SubmitContainerStateChange

amazonaws_ecs.SubmitContainerStateChange({}, context)

Input

Output

SubmitTaskStateChange

amazonaws_ecs.SubmitTaskStateChange({}, context)

Input

Output

UpdateContainerAgent

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

Input

  • input object

Output

UpdateContainerInstancesState

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

Input

Output

UpdateService

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

Input

Output

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

AttachmentDetails

AttachmentStateChange

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

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.

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

AwsVpcConfiguration

  • AwsVpcConfiguration object: An object representing the networking details for a task or service.

BlockedException

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.

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

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

Compatibility

  • Compatibility string (values: EC2, FARGATE)

CompatibilityList

Connectivity

  • Connectivity string (values: CONNECTED, DISCONNECTED)

Container

ContainerDefinition

ContainerDefinitions

ContainerInstance

ContainerInstanceStatus

  • ContainerInstanceStatus string (values: ACTIVE, DRAINING)

ContainerInstances

ContainerOverride

ContainerOverrides

ContainerStateChange

ContainerStateChanges

Containers

CreateClusterRequest

  • CreateClusterRequest object

CreateClusterResponse

  • CreateClusterResponse object

CreateServiceRequest

CreateServiceResponse

  • CreateServiceResponse object

DeleteAttributesRequest

DeleteAttributesResponse

  • DeleteAttributesResponse object

DeleteClusterRequest

  • DeleteClusterRequest object

DeleteClusterResponse

  • DeleteClusterResponse object

DeleteServiceRequest

  • DeleteServiceRequest object

DeleteServiceResponse

  • DeleteServiceResponse object

Deployment

DeploymentConfiguration

  • DeploymentConfiguration object: Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

Deployments

DeregisterContainerInstanceRequest

DeregisterContainerInstanceResponse

DeregisterTaskDefinitionRequest

  • DeregisterTaskDefinitionRequest object
    • taskDefinition required String

DeregisterTaskDefinitionResponse

  • DeregisterTaskDefinitionResponse object

DescribeClustersRequest

DescribeClustersResponse

DescribeContainerInstancesRequest

  • DescribeContainerInstancesRequest object

DescribeContainerInstancesResponse

DescribeServicesRequest

DescribeServicesResponse

DescribeTaskDefinitionRequest

  • DescribeTaskDefinitionRequest object
    • taskDefinition required String

DescribeTaskDefinitionResponse

DescribeTasksRequest

DescribeTasksResponse

DesiredStatus

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

Device

DeviceCgroupPermission

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

DeviceCgroupPermissions

DevicesList

  • DevicesList array

DiscoverPollEndpointRequest

  • DiscoverPollEndpointRequest object

DiscoverPollEndpointResponse

  • DiscoverPollEndpointResponse object

DockerLabelsMap

  • DockerLabelsMap array

Double

  • Double number

EnvironmentVariables

Failure

  • Failure object: A failed resource.

Failures

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

HostVolumeProperties

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

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.

KeyValuePair

  • KeyValuePair object: A key and value pair object.

LaunchType

  • LaunchType string (values: EC2, FARGATE)

LinuxParameters

ListAttributesRequest

ListAttributesResponse

ListClustersRequest

ListClustersResponse

ListContainerInstancesRequest

ListContainerInstancesResponse

  • ListContainerInstancesResponse object

ListServicesRequest

ListServicesResponse

ListTaskDefinitionFamiliesRequest

ListTaskDefinitionFamiliesResponse

  • ListTaskDefinitionFamiliesResponse object

ListTaskDefinitionsRequest

ListTaskDefinitionsResponse

  • ListTaskDefinitionsResponse object

ListTasksRequest

ListTasksResponse

LoadBalancer

  • LoadBalancer object: Details on a load balancer that is used with a service.

LoadBalancers

LogConfiguration

LogConfigurationOptionsMap

  • LogConfigurationOptionsMap array

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.

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.

NetworkBindings

NetworkConfiguration

  • NetworkConfiguration object: An object representing the network configuration for a task or service.

NetworkInterface

  • NetworkInterface object: An object representing the Elastic Network Interface for tasks that use the awsvpc network mode.

NetworkInterfaces

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

PlacementConstraintType

  • PlacementConstraintType string (values: distinctInstance, memberOf)

PlacementConstraints

PlacementStrategies

PlacementStrategy

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.

PortMappingList

PutAttributesRequest

PutAttributesResponse

  • PutAttributesResponse object

RegisterContainerInstanceRequest

RegisterContainerInstanceResponse

RegisterTaskDefinitionRequest

RegisterTaskDefinitionResponse

RequiresAttributes

Resource

Resources

RunTaskRequest

RunTaskResponse

ServerException

  • ServerException object: These errors are usually caused by a server issue.

Service

ServiceEvent

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

ServiceEvents

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

SortOrder

  • SortOrder string (values: ASC, DESC)

StartTaskRequest

StartTaskResponse

Statistics

StopTaskRequest

StopTaskResponse

  • StopTaskResponse object

String

  • String string

StringList

  • StringList array

SubmitContainerStateChangeRequest

SubmitContainerStateChangeResponse

  • SubmitContainerStateChangeResponse object

SubmitTaskStateChangeRequest

SubmitTaskStateChangeResponse

  • SubmitTaskStateChangeResponse object

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

TaskDefinition

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.

TaskDefinitionPlacementConstraintType

  • TaskDefinitionPlacementConstraintType string (values: memberOf)

TaskDefinitionPlacementConstraints

TaskDefinitionStatus

  • TaskDefinitionStatus string (values: ACTIVE, INACTIVE)

TaskOverride

Tasks

  • Tasks array

Timestamp

  • Timestamp string

TransportProtocol

  • TransportProtocol string (values: tcp, udp)

Ulimit

  • Ulimit object: The ulimit settings to pass to the container.

UlimitList

  • UlimitList array

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

  • UpdateContainerAgentRequest object

UpdateContainerAgentResponse

UpdateContainerInstancesStateRequest

UpdateContainerInstancesStateResponse

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

UpdateServiceResponse

  • UpdateServiceResponse object

VersionInfo

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

Volume

VolumeFrom

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

VolumeFromList

VolumeList

  • VolumeList array

Readme

Keywords

none

Package Sidebar

Install

npm i @datafire/amazonaws_ecs

Repository

github.com/DataFire/integrations

Homepage

github.com/DataFire/integrations#readme

Weekly Downloads

0

Version

5.0.0

License

MIT

Unpacked Size

350 kB

Total Files

5

Last publish

Collaborators

  • datafire
Try on RunKit
Report malware