Skip to content

query.setApiVersion()

Jump to bottom
SaltwaterC edited this page Jan 20, 2012 · 3 revisions

About

Helper for setting the API version of a specific query API client.

Reference

query.setApiVersion(apiVersion)
  • 'apiVersion' - query API version number. Must have valid syntax, otherwise the library throws an error.

Amazon uses this syntax: YYYY-MM-DD. For the moment, the syntax check is just basic. The API version may be changed per request by passing the Version query parameter to the query.request() method.

A valid API version must be supplied. The documentation archive should help you to determine the proper version string.

For example, at the time of writing this page, the latest EC2 API is 2011-07-15, therefore the usage would be:

var ec2 = require('aws2js').load('ec2');
ec2.setApiVersion('2011-07-15');

This method is chainable (aka it returns the client object).

Clone this wiki locally