Aws.ecsDescribeTasks()

Describe a specified task or tasks.

Usage

Hover over inputs/exits for more info.

var Aws = require('machinepack-aws');


// Describe a specified task or tasks.

Aws.ecsDescribeTasks({

accessKeyId: 'akid',

secretAccessKey: 'secret',

tasks: [ '98950f3c-7347-4249-99cb-168832a1b8f2' ],

region: 'us-west-2',

apiVersion: '2014-11-13',

cluster: 'default',

}).exec({

// An unexpected error occurred.

error: function (err) {

 

},

// OK.

success: function (result) {

 

},

});

Inputs

accessKeyId required

AWS IAM user access key id.

'akid'
secretAccessKey required

AWS IAM user secret access key

'secret'
tasks required

Task UUIDs or full Amazon Resource Name (ARN) entries.

[ '98950f3c-7347-4249-99cb-168832a1b8f2' ]
region

Which region to use. Defaults to us-west-2

'us-west-2'
apiVersion

Which api version to use. Defaults to: latest

'2014-11-13'
cluster

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances you want to describe. Defaults to `default`.

'default'

Exits

error

An unexpected error occurred.

success

OK.

{ failures: [],
  tasks: 
   [ { clusterArn: 'arn:aws:ecs:us-west-2:575431834730:cluster/default',
       containerInstanceArn: 'arn:aws:ecs:us-west-2:575431834730:container-instance/98950f3c-7347-4249-99cb-168832a1b8f2',
       containers: 
        [ { containerArn: 'arn:aws:ecs:us-west-2:575431834730:container/7a335481-599e-4a97-8032-161f9e19b26f',
            lastStatus: 'RUNNING',
            name: 'preview',
            networkBindings: [ { bindIP: '0.0.0.0', containerPort: 1337, hostPort: 49157 } ],
            taskArn: 'arn:aws:ecs:us-west-2:575431834730:task/903ba554-510a-4565-99bc-f70c3b2edaed' } ],
       desiredStatus: 'RUNNING',
       lastStatus: 'RUNNING',
       overrides: { containerOverrides: [ { name: 'preview' } ] },
       taskArn: 'arn:aws:ecs:us-west-2:575431834730:task/903ba554-510a-4565-99bc-f70c3b2edaed',
       taskDefinitionArn: 'arn:aws:ecs:us-west-2:575431834730:task-definition/particlebanana-2Factor:1' } ] }