diff --git a/doc-src/dynamodb.docs.js b/doc-src/dynamodb.docs.js index 81871ad36a..f239b201b6 100644 --- a/doc-src/dynamodb.docs.js +++ b/doc-src/dynamodb.docs.js @@ -24,8 +24,12 @@ AWS = {}; * === Sending a Request Using DynamoDB * * svc = new AWS.DynamoDB(); - * svc.client.OPERATION_NAME(params).always(function (resp) { - * console.log(resp.data, resp.error); + * svc.client.OPERATION_NAME(params, function (err, data) { + * if (err) { + * console.log(err); // an error occurred + * } else { + * console.log(data); // successful response + * } * }); * * @!method constructor(options) @@ -46,10 +50,10 @@ AWS.DynamoDB = inherit({}) * The low-level DynamoDB client class. This class provides one function * for each API operation on the service. * - * @!method batchGetItem(params, options) + * @!method batchGetItem(params, callback) * Retrieves the attributes for multiple items from multiple tables * using their primary keys. - * @param [Object] params + * @param params [Object] * * +RequestItems+ - (*required*, Object) * * +Keys+ - (*required*, Array) * * +HashKeyElement+ - (*required*, Object) A hash key @@ -92,66 +96,73 @@ AWS.DynamoDB = inherit({}) * binary attributes. * * +AttributesToGet+ - (Array) * * +ConsistentRead+ - (Boolean) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Responses+ - (Object) - * * +Items+ - (Array>) - * * +ConsumedCapacityUnits+ - (Float) - * * +UnprocessedKeys+ - (Object) Contains a map of - * tables and their respective keys that were not processed with - * the current response, possibly due to reaching a limit on the - * response size. The UnprocessedKeys value is in the same form as - * a RequestItems parameter (so the value can be provided directly - * to a subsequent BatchGetItem operation). For more information, - * see the above RequestItems parameter. - * * +Keys+ - (Array) - * * +HashKeyElement+ - (Object) A hash key - * element is treated as the primary key, and can be a string - * or a number. Single attribute primary keys have one index - * value. The value can be String, Number, StringSet, - * NumberSet. - * * +S+ - (String) Strings are Unicode with UTF-8 - * binary encoding. The maximum size is limited by the size - * of the primary key (1024 bytes as a range part of a key or - * 2048 bytes as a single part hash key) or the item size - * (64k). - * * +N+ - (String) Numbers are positive or negative - * exact-value decimals and integers. A number can have up to - * 38 digits precision and can be between 10^-128 to 10^+126. - * * +B+ - (Base64 Encoded Data) Binary attributes are - * sequences of unsigned bytes. - * * +SS+ - (Array) A set of strings. - * * +NS+ - (Array) A set of numbers. - * * +BS+ - (Array) A set of - * binary attributes. - * * +RangeKeyElement+ - (Object) A range key element is - * treated as a secondary key (used in conjunction with the - * primary key), and can be a string or a number, and is only - * used for hash-and-range primary keys. The value can be - * String, Number, StringSet, NumberSet. - * * +S+ - (String) Strings are Unicode with UTF-8 - * binary encoding. The maximum size is limited by the size - * of the primary key (1024 bytes as a range part of a key or - * 2048 bytes as a single part hash key) or the item size - * (64k). - * * +N+ - (String) Numbers are positive or negative - * exact-value decimals and integers. A number can have up to - * 38 digits precision and can be between 10^-128 to 10^+126. - * * +B+ - (Base64 Encoded Data) Binary attributes are - * sequences of unsigned bytes. - * * +SS+ - (Array) A set of strings. - * * +NS+ - (Array) A set of numbers. - * * +BS+ - (Array) A set of - * binary attributes. - * * +AttributesToGet+ - (Array) - * * +ConsistentRead+ - (Boolean) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Responses+ - (Object) + * * +Items+ - (Array>) + * * +ConsumedCapacityUnits+ - (Float) + * * +UnprocessedKeys+ - (Object) Contains a map of + * tables and their respective keys that were not processed with + * the current response, possibly due to reaching a limit on the + * response size. The UnprocessedKeys value is in the same form as + * a RequestItems parameter (so the value can be provided directly + * to a subsequent BatchGetItem operation). For more information, + * see the above RequestItems parameter. + * * +Keys+ - (Array) + * * +HashKeyElement+ - (Object) A hash key + * element is treated as the primary key, and can be a string + * or a number. Single attribute primary keys have one index + * value. The value can be String, Number, StringSet, + * NumberSet. + * * +S+ - (String) Strings are Unicode with UTF-8 + * binary encoding. The maximum size is limited by the size + * of the primary key (1024 bytes as a range part of a key or + * 2048 bytes as a single part hash key) or the item size + * (64k). + * * +N+ - (String) Numbers are positive or negative + * exact-value decimals and integers. A number can have up to + * 38 digits precision and can be between 10^-128 to 10^+126. + * * +B+ - (Base64 Encoded Data) Binary attributes are + * sequences of unsigned bytes. + * * +SS+ - (Array) A set of strings. + * * +NS+ - (Array) A set of numbers. + * * +BS+ - (Array) A set of + * binary attributes. + * * +RangeKeyElement+ - (Object) A range key element is + * treated as a secondary key (used in conjunction with the + * primary key), and can be a string or a number, and is only + * used for hash-and-range primary keys. The value can be + * String, Number, StringSet, NumberSet. + * * +S+ - (String) Strings are Unicode with UTF-8 + * binary encoding. The maximum size is limited by the size + * of the primary key (1024 bytes as a range part of a key or + * 2048 bytes as a single part hash key) or the item size + * (64k). + * * +N+ - (String) Numbers are positive or negative + * exact-value decimals and integers. A number can have up to + * 38 digits precision and can be between 10^-128 to 10^+126. + * * +B+ - (Base64 Encoded Data) Binary attributes are + * sequences of unsigned bytes. + * * +SS+ - (Array) A set of strings. + * * +NS+ - (Array) A set of numbers. + * * +BS+ - (Array) A set of + * binary attributes. + * * +AttributesToGet+ - (Array) + * * +ConsistentRead+ - (Boolean) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method batchWriteItem(params, options) + * @!method batchWriteItem(params, callback) * Allows to execute a batch of Put and/or Delete Requests for many * tables in a single call. A total of 25 requests are allowed. - * @param [Object] params + * @param params [Object] * * +RequestItems+ - (*required*, Object>) A * map of table name to list-of-write-requests. Used as input to * the BatchWriteItem API call @@ -215,81 +226,88 @@ AWS.DynamoDB = inherit({}) * * +NS+ - (Array) A set of numbers. * * +BS+ - (Array) A set of * binary attributes. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Responses+ - (Object) The response object as a - * result of BatchWriteItem call. This is essentially a map of - * table name to ConsumedCapacityUnits. - * * +ConsumedCapacityUnits+ - (Float) - * * +UnprocessedItems+ - (Object>) The Items - * which we could not successfully process in a BatchWriteItem call - * is returned as UnprocessedItems - * * +PutRequest+ - (Object) - * * +Item+ - (Object) The item to - * put - * * +S+ - (String) Strings are Unicode with UTF-8 - * binary encoding. The maximum size is limited by the size - * of the primary key (1024 bytes as a range part of a key or - * 2048 bytes as a single part hash key) or the item size - * (64k). - * * +N+ - (String) Numbers are positive or negative - * exact-value decimals and integers. A number can have up to - * 38 digits precision and can be between 10^-128 to 10^+126. - * * +B+ - (Base64 Encoded Data) Binary attributes are - * sequences of unsigned bytes. - * * +SS+ - (Array) A set of strings. - * * +NS+ - (Array) A set of numbers. - * * +BS+ - (Array) A set of - * binary attributes. - * * +DeleteRequest+ - (Object) - * * +Key+ - (Object) The item's key to be - * delete - * * +HashKeyElement+ - (Object) A hash - * key element is treated as the primary key, and can be a - * string or a number. Single attribute primary keys have one - * index value. The value can be String, Number, StringSet, - * NumberSet. - * * +S+ - (String) Strings are Unicode with UTF-8 - * binary encoding. The maximum size is limited by the size - * of the primary key (1024 bytes as a range part of a key - * or 2048 bytes as a single part hash key) or the item - * size (64k). - * * +N+ - (String) Numbers are positive or negative - * exact-value decimals and integers. A number can have up - * to 38 digits precision and can be between 10^-128 to - * 10^+126. - * * +B+ - (Base64 Encoded Data) Binary attributes - * are sequences of unsigned bytes. - * * +SS+ - (Array) A set of strings. - * * +NS+ - (Array) A set of numbers. - * * +BS+ - (Array) A set of - * binary attributes. - * * +RangeKeyElement+ - (Object) A range key element - * is treated as a secondary key (used in conjunction with - * the primary key), and can be a string or a number, and is - * only used for hash-and-range primary keys. The value can - * be String, Number, StringSet, NumberSet. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Responses+ - (Object) The response object as a + * result of BatchWriteItem call. This is essentially a map of + * table name to ConsumedCapacityUnits. + * * +ConsumedCapacityUnits+ - (Float) + * * +UnprocessedItems+ - (Object>) The Items + * which we could not successfully process in a BatchWriteItem call + * is returned as UnprocessedItems + * * +PutRequest+ - (Object) + * * +Item+ - (Object) The item to + * put * * +S+ - (String) Strings are Unicode with UTF-8 * binary encoding. The maximum size is limited by the size - * of the primary key (1024 bytes as a range part of a key - * or 2048 bytes as a single part hash key) or the item - * size (64k). + * of the primary key (1024 bytes as a range part of a key or + * 2048 bytes as a single part hash key) or the item size + * (64k). * * +N+ - (String) Numbers are positive or negative - * exact-value decimals and integers. A number can have up - * to 38 digits precision and can be between 10^-128 to - * 10^+126. - * * +B+ - (Base64 Encoded Data) Binary attributes - * are sequences of unsigned bytes. + * exact-value decimals and integers. A number can have up to + * 38 digits precision and can be between 10^-128 to 10^+126. + * * +B+ - (Base64 Encoded Data) Binary attributes are + * sequences of unsigned bytes. * * +SS+ - (Array) A set of strings. * * +NS+ - (Array) A set of numbers. * * +BS+ - (Array) A set of * binary attributes. + * * +DeleteRequest+ - (Object) + * * +Key+ - (Object) The item's key to be + * delete + * * +HashKeyElement+ - (Object) A hash + * key element is treated as the primary key, and can be a + * string or a number. Single attribute primary keys have one + * index value. The value can be String, Number, StringSet, + * NumberSet. + * * +S+ - (String) Strings are Unicode with UTF-8 + * binary encoding. The maximum size is limited by the size + * of the primary key (1024 bytes as a range part of a key + * or 2048 bytes as a single part hash key) or the item + * size (64k). + * * +N+ - (String) Numbers are positive or negative + * exact-value decimals and integers. A number can have up + * to 38 digits precision and can be between 10^-128 to + * 10^+126. + * * +B+ - (Base64 Encoded Data) Binary attributes + * are sequences of unsigned bytes. + * * +SS+ - (Array) A set of strings. + * * +NS+ - (Array) A set of numbers. + * * +BS+ - (Array) A set of + * binary attributes. + * * +RangeKeyElement+ - (Object) A range key element + * is treated as a secondary key (used in conjunction with + * the primary key), and can be a string or a number, and is + * only used for hash-and-range primary keys. The value can + * be String, Number, StringSet, NumberSet. + * * +S+ - (String) Strings are Unicode with UTF-8 + * binary encoding. The maximum size is limited by the size + * of the primary key (1024 bytes as a range part of a key + * or 2048 bytes as a single part hash key) or the item + * size (64k). + * * +N+ - (String) Numbers are positive or negative + * exact-value decimals and integers. A number can have up + * to 38 digits precision and can be between 10^-128 to + * 10^+126. + * * +B+ - (Base64 Encoded Data) Binary attributes + * are sequences of unsigned bytes. + * * +SS+ - (Array) A set of strings. + * * +NS+ - (Array) A set of numbers. + * * +BS+ - (Array) A set of + * binary attributes. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method createTable(params, options) + * @!method createTable(params, callback) * Adds a new table to your account. - * @param [Object] params + * @param params [Object] * * +TableName+ - (*required*, String) The name of the * table you want to create. Allowed characters are a-z, A-Z, 0-9, * _ (underscore), - (hyphen) and . (period). @@ -323,47 +341,54 @@ AWS.DynamoDB = inherit({}) * WriteCapacityUnits are in terms of strictly consistent reads, * assuming items of 1k. 2k items require twice the * WriteCapacityUnits. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +TableDescription+ - (Object) - * * +TableName+ - (String) The name of the table being - * described. - * * +KeySchema+ - (Object) - * * +HashKeyElement+ - (Object) A hash key - * element is treated as the primary key, and can be a string - * or a number. Single attribute primary keys have one index - * value. The value can be String, Number, StringSet, - * NumberSet. - * * +AttributeName+ - (String) The - * AttributeName of the KeySchemaElement. - * * +AttributeType+ - (String) The - * AttributeType of the KeySchemaElement which can be a - * String or a Number. - * * +RangeKeyElement+ - (Object) A range key element is - * treated as a secondary key (used in conjunction with the - * primary key), and can be a string or a number, and is only - * used for hash-and-range primary keys. The value can be - * String, Number, StringSet, NumberSet. - * * +AttributeName+ - (String) The - * AttributeName of the KeySchemaElement. - * * +AttributeType+ - (String) The - * AttributeType of the KeySchemaElement which can be a - * String or a Number. - * * +TableStatus+ - (String) - * * +CreationDateTime+ - (Date) - * * +ProvisionedThroughput+ - (Object) - * * +LastIncreaseDateTime+ - (Date) - * * +LastDecreaseDateTime+ - (Date) - * * +ReadCapacityUnits+ - (Integer) - * * +WriteCapacityUnits+ - (Integer) - * * +TableSizeBytes+ - (Integer) - * * +ItemCount+ - (Integer) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +TableDescription+ - (Object) + * * +TableName+ - (String) The name of the table being + * described. + * * +KeySchema+ - (Object) + * * +HashKeyElement+ - (Object) A hash key + * element is treated as the primary key, and can be a string + * or a number. Single attribute primary keys have one index + * value. The value can be String, Number, StringSet, + * NumberSet. + * * +AttributeName+ - (String) The + * AttributeName of the KeySchemaElement. + * * +AttributeType+ - (String) The + * AttributeType of the KeySchemaElement which can be a + * String or a Number. + * * +RangeKeyElement+ - (Object) A range key element is + * treated as a secondary key (used in conjunction with the + * primary key), and can be a string or a number, and is only + * used for hash-and-range primary keys. The value can be + * String, Number, StringSet, NumberSet. + * * +AttributeName+ - (String) The + * AttributeName of the KeySchemaElement. + * * +AttributeType+ - (String) The + * AttributeType of the KeySchemaElement which can be a + * String or a Number. + * * +TableStatus+ - (String) + * * +CreationDateTime+ - (Date) + * * +ProvisionedThroughput+ - (Object) + * * +LastIncreaseDateTime+ - (Date) + * * +LastDecreaseDateTime+ - (Date) + * * +ReadCapacityUnits+ - (Integer) + * * +WriteCapacityUnits+ - (Integer) + * * +TableSizeBytes+ - (Integer) + * * +ItemCount+ - (Integer) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method deleteItem(params, options) + * @!method deleteItem(params, callback) * Deletes a single item in a table by primary key. - * @param [Object] params + * @param params [Object] * * +TableName+ - (*required*, String) The name of the * table in which you want to delete an item. Allowed characters * are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period). @@ -423,122 +448,143 @@ AWS.DynamoDB = inherit({}) * * +Exists+ - (Boolean) Specify whether or not a value * already exists for the attribute name-value pair. * * +ReturnValues+ - (String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Attributes+ - (Object) If the ReturnValues - * parameter is provided as ALL_OLD in the request, Amazon DynamoDB - * returns an array of attribute name-value pairs (essentially, the - * deleted item). Otherwise, the response contains an empty set. - * * +S+ - (String) Strings are Unicode with UTF-8 binary - * encoding. The maximum size is limited by the size of the - * primary key (1024 bytes as a range part of a key or 2048 bytes - * as a single part hash key) or the item size (64k). - * * +N+ - (String) Numbers are positive or negative - * exact-value decimals and integers. A number can have up to 38 - * digits precision and can be between 10^-128 to 10^+126. - * * +B+ - (Base64 Encoded Data) Binary attributes are - * sequences of unsigned bytes. - * * +SS+ - (Array) A set of strings. - * * +NS+ - (Array) A set of numbers. - * * +BS+ - (Array) A set of binary - * attributes. - * * +ConsumedCapacityUnits+ - (Float) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Attributes+ - (Object) If the ReturnValues + * parameter is provided as ALL_OLD in the request, Amazon DynamoDB + * returns an array of attribute name-value pairs (essentially, the + * deleted item). Otherwise, the response contains an empty set. + * * +S+ - (String) Strings are Unicode with UTF-8 binary + * encoding. The maximum size is limited by the size of the + * primary key (1024 bytes as a range part of a key or 2048 bytes + * as a single part hash key) or the item size (64k). + * * +N+ - (String) Numbers are positive or negative + * exact-value decimals and integers. A number can have up to 38 + * digits precision and can be between 10^-128 to 10^+126. + * * +B+ - (Base64 Encoded Data) Binary attributes are + * sequences of unsigned bytes. + * * +SS+ - (Array) A set of strings. + * * +NS+ - (Array) A set of numbers. + * * +BS+ - (Array) A set of binary + * attributes. + * * +ConsumedCapacityUnits+ - (Float) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method deleteTable(params, options) + * @!method deleteTable(params, callback) * Deletes a table and all of its items. - * @param [Object] params + * @param params [Object] * * +TableName+ - (*required*, String) The name of the * table you want to delete. Allowed characters are a-z, A-Z, 0-9, * _ (underscore), - (hyphen) and . (period). - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +TableDescription+ - (Object) - * * +TableName+ - (String) The name of the table being - * described. - * * +KeySchema+ - (Object) - * * +HashKeyElement+ - (Object) A hash key - * element is treated as the primary key, and can be a string - * or a number. Single attribute primary keys have one index - * value. The value can be String, Number, StringSet, - * NumberSet. - * * +AttributeName+ - (String) The - * AttributeName of the KeySchemaElement. - * * +AttributeType+ - (String) The - * AttributeType of the KeySchemaElement which can be a - * String or a Number. - * * +RangeKeyElement+ - (Object) A range key element is - * treated as a secondary key (used in conjunction with the - * primary key), and can be a string or a number, and is only - * used for hash-and-range primary keys. The value can be - * String, Number, StringSet, NumberSet. - * * +AttributeName+ - (String) The - * AttributeName of the KeySchemaElement. - * * +AttributeType+ - (String) The - * AttributeType of the KeySchemaElement which can be a - * String or a Number. - * * +TableStatus+ - (String) - * * +CreationDateTime+ - (Date) - * * +ProvisionedThroughput+ - (Object) - * * +LastIncreaseDateTime+ - (Date) - * * +LastDecreaseDateTime+ - (Date) - * * +ReadCapacityUnits+ - (Integer) - * * +WriteCapacityUnits+ - (Integer) - * * +TableSizeBytes+ - (Integer) - * * +ItemCount+ - (Integer) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +TableDescription+ - (Object) + * * +TableName+ - (String) The name of the table being + * described. + * * +KeySchema+ - (Object) + * * +HashKeyElement+ - (Object) A hash key + * element is treated as the primary key, and can be a string + * or a number. Single attribute primary keys have one index + * value. The value can be String, Number, StringSet, + * NumberSet. + * * +AttributeName+ - (String) The + * AttributeName of the KeySchemaElement. + * * +AttributeType+ - (String) The + * AttributeType of the KeySchemaElement which can be a + * String or a Number. + * * +RangeKeyElement+ - (Object) A range key element is + * treated as a secondary key (used in conjunction with the + * primary key), and can be a string or a number, and is only + * used for hash-and-range primary keys. The value can be + * String, Number, StringSet, NumberSet. + * * +AttributeName+ - (String) The + * AttributeName of the KeySchemaElement. + * * +AttributeType+ - (String) The + * AttributeType of the KeySchemaElement which can be a + * String or a Number. + * * +TableStatus+ - (String) + * * +CreationDateTime+ - (Date) + * * +ProvisionedThroughput+ - (Object) + * * +LastIncreaseDateTime+ - (Date) + * * +LastDecreaseDateTime+ - (Date) + * * +ReadCapacityUnits+ - (Integer) + * * +WriteCapacityUnits+ - (Integer) + * * +TableSizeBytes+ - (Integer) + * * +ItemCount+ - (Integer) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method describeTable(params, options) + * @!method describeTable(params, callback) * Retrieves information about the table, including the current status * of the table, the primary key schema and when the table was created. - * @param [Object] params + * @param params [Object] * * +TableName+ - (*required*, String) The name of the * table you want to describe. Allowed characters are a-z, A-Z, * 0-9, _ (underscore), - (hyphen) and . (period). - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Table+ - (Object) - * * +TableName+ - (String) The name of the table being - * described. - * * +KeySchema+ - (Object) - * * +HashKeyElement+ - (Object) A hash key - * element is treated as the primary key, and can be a string - * or a number. Single attribute primary keys have one index - * value. The value can be String, Number, StringSet, - * NumberSet. - * * +AttributeName+ - (String) The - * AttributeName of the KeySchemaElement. - * * +AttributeType+ - (String) The - * AttributeType of the KeySchemaElement which can be a - * String or a Number. - * * +RangeKeyElement+ - (Object) A range key element is - * treated as a secondary key (used in conjunction with the - * primary key), and can be a string or a number, and is only - * used for hash-and-range primary keys. The value can be - * String, Number, StringSet, NumberSet. - * * +AttributeName+ - (String) The - * AttributeName of the KeySchemaElement. - * * +AttributeType+ - (String) The - * AttributeType of the KeySchemaElement which can be a - * String or a Number. - * * +TableStatus+ - (String) - * * +CreationDateTime+ - (Date) - * * +ProvisionedThroughput+ - (Object) - * * +LastIncreaseDateTime+ - (Date) - * * +LastDecreaseDateTime+ - (Date) - * * +ReadCapacityUnits+ - (Integer) - * * +WriteCapacityUnits+ - (Integer) - * * +TableSizeBytes+ - (Integer) - * * +ItemCount+ - (Integer) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Table+ - (Object) + * * +TableName+ - (String) The name of the table being + * described. + * * +KeySchema+ - (Object) + * * +HashKeyElement+ - (Object) A hash key + * element is treated as the primary key, and can be a string + * or a number. Single attribute primary keys have one index + * value. The value can be String, Number, StringSet, + * NumberSet. + * * +AttributeName+ - (String) The + * AttributeName of the KeySchemaElement. + * * +AttributeType+ - (String) The + * AttributeType of the KeySchemaElement which can be a + * String or a Number. + * * +RangeKeyElement+ - (Object) A range key element is + * treated as a secondary key (used in conjunction with the + * primary key), and can be a string or a number, and is only + * used for hash-and-range primary keys. The value can be + * String, Number, StringSet, NumberSet. + * * +AttributeName+ - (String) The + * AttributeName of the KeySchemaElement. + * * +AttributeType+ - (String) The + * AttributeType of the KeySchemaElement which can be a + * String or a Number. + * * +TableStatus+ - (String) + * * +CreationDateTime+ - (Date) + * * +ProvisionedThroughput+ - (Object) + * * +LastIncreaseDateTime+ - (Date) + * * +LastDecreaseDateTime+ - (Date) + * * +ReadCapacityUnits+ - (Integer) + * * +WriteCapacityUnits+ - (Integer) + * * +TableSizeBytes+ - (Integer) + * * +ItemCount+ - (Integer) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method getItem(params, options) + * @!method getItem(params, callback) * Retrieves a set of Attributes for an item that matches the primary * key. - * @param [Object] params + * @param params [Object] * * +TableName+ - (*required*, String) The name of the * table in which you want to get an item. Allowed characters are * a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period). @@ -580,51 +626,65 @@ AWS.DynamoDB = inherit({}) * attributes. * * +AttributesToGet+ - (Array) * * +ConsistentRead+ - (Boolean) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Item+ - (Object) Contains the requested - * attributes. - * * +S+ - (String) Strings are Unicode with UTF-8 binary - * encoding. The maximum size is limited by the size of the - * primary key (1024 bytes as a range part of a key or 2048 bytes - * as a single part hash key) or the item size (64k). - * * +N+ - (String) Numbers are positive or negative - * exact-value decimals and integers. A number can have up to 38 - * digits precision and can be between 10^-128 to 10^+126. - * * +B+ - (Base64 Encoded Data) Binary attributes are - * sequences of unsigned bytes. - * * +SS+ - (Array) A set of strings. - * * +NS+ - (Array) A set of numbers. - * * +BS+ - (Array) A set of binary + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Item+ - (Object) Contains the requested * attributes. - * * +ConsumedCapacityUnits+ - (Float) + * * +S+ - (String) Strings are Unicode with UTF-8 binary + * encoding. The maximum size is limited by the size of the + * primary key (1024 bytes as a range part of a key or 2048 bytes + * as a single part hash key) or the item size (64k). + * * +N+ - (String) Numbers are positive or negative + * exact-value decimals and integers. A number can have up to 38 + * digits precision and can be between 10^-128 to 10^+126. + * * +B+ - (Base64 Encoded Data) Binary attributes are + * sequences of unsigned bytes. + * * +SS+ - (Array) A set of strings. + * * +NS+ - (Array) A set of numbers. + * * +BS+ - (Array) A set of binary + * attributes. + * * +ConsumedCapacityUnits+ - (Float) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method listTables(params, options) + * @!method listTables(params, callback) * Retrieves a paginated list of table names created by the AWS Account * of the caller in the AWS Region (e.g. us-east-1). - * @param [Object] params + * @param params [Object] * * +ExclusiveStartTableName+ - (String) The name of the * table that starts the list. If you already ran a ListTables * operation and received a LastEvaluatedTableName value in the * response, use that value here to continue the list. * * +Limit+ - (Integer) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +TableNames+ - (Array) - * * +LastEvaluatedTableName+ - (String) The name of the - * last table in the current list. Use this value as the - * ExclusiveStartTableName in a new request to continue the list - * until all the table names are returned. If this value is null, - * all table names have been returned. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +TableNames+ - (Array) + * * +LastEvaluatedTableName+ - (String) The name of the + * last table in the current list. Use this value as the + * ExclusiveStartTableName in a new request to continue the list + * until all the table names are returned. If this value is null, + * all table names have been returned. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method putItem(params, options) + * @!method putItem(params, callback) * Creates a new item, or replaces an old item with a new item * (including all the attributes). - * @param [Object] params + * @param params [Object] * * +TableName+ - (*required*, String) The name of the * table in which you want to put an item. Allowed characters are * a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period). @@ -662,32 +722,39 @@ AWS.DynamoDB = inherit({}) * * +Exists+ - (Boolean) Specify whether or not a value * already exists for the attribute name-value pair. * * +ReturnValues+ - (String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Attributes+ - (Object) Attribute values before - * the put operation, but only if the ReturnValues parameter is - * specified as ALL_OLD in the request. - * * +S+ - (String) Strings are Unicode with UTF-8 binary - * encoding. The maximum size is limited by the size of the - * primary key (1024 bytes as a range part of a key or 2048 bytes - * as a single part hash key) or the item size (64k). - * * +N+ - (String) Numbers are positive or negative - * exact-value decimals and integers. A number can have up to 38 - * digits precision and can be between 10^-128 to 10^+126. - * * +B+ - (Base64 Encoded Data) Binary attributes are - * sequences of unsigned bytes. - * * +SS+ - (Array) A set of strings. - * * +NS+ - (Array) A set of numbers. - * * +BS+ - (Array) A set of binary - * attributes. - * * +ConsumedCapacityUnits+ - (Float) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Attributes+ - (Object) Attribute values before + * the put operation, but only if the ReturnValues parameter is + * specified as ALL_OLD in the request. + * * +S+ - (String) Strings are Unicode with UTF-8 binary + * encoding. The maximum size is limited by the size of the + * primary key (1024 bytes as a range part of a key or 2048 bytes + * as a single part hash key) or the item size (64k). + * * +N+ - (String) Numbers are positive or negative + * exact-value decimals and integers. A number can have up to 38 + * digits precision and can be between 10^-128 to 10^+126. + * * +B+ - (Base64 Encoded Data) Binary attributes are + * sequences of unsigned bytes. + * * +SS+ - (Array) A set of strings. + * * +NS+ - (Array) A set of numbers. + * * +BS+ - (Array) A set of binary + * attributes. + * * +ConsumedCapacityUnits+ - (Float) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method query(params, options) + * @!method query(params, callback) * Gets the values of one or more items and its attributes by primary * key (composite primary key, only). - * @param [Object] params + * @param params [Object] * * +TableName+ - (*required*, String) The name of the * table in which you want to query. Allowed characters are a-z, * A-Z, 0-9, _ (underscore), - (hyphen) and . (period). @@ -784,59 +851,66 @@ AWS.DynamoDB = inherit({}) * * +NS+ - (Array) A set of numbers. * * +BS+ - (Array) A set of binary * attributes. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Items+ - (Array>) - * * +Count+ - (Integer) Number of items in the response. - * * +LastEvaluatedKey+ - (Object) Primary key of the item - * where the query operation stopped, inclusive of the previous - * result set. Use this value to start a new operation excluding - * this value in the new request. The LastEvaluatedKey is null when - * the entire query result set is complete (i.e. the operation - * processed the "last page"). - * * +HashKeyElement+ - (Object) A hash key - * element is treated as the primary key, and can be a string or - * a number. Single attribute primary keys have one index value. - * The value can be String, Number, StringSet, NumberSet. - * * +S+ - (String) Strings are Unicode with UTF-8 - * binary encoding. The maximum size is limited by the size of - * the primary key (1024 bytes as a range part of a key or 2048 - * bytes as a single part hash key) or the item size (64k). - * * +N+ - (String) Numbers are positive or negative - * exact-value decimals and integers. A number can have up to - * 38 digits precision and can be between 10^-128 to 10^+126. - * * +B+ - (Base64 Encoded Data) Binary attributes are - * sequences of unsigned bytes. - * * +SS+ - (Array) A set of strings. - * * +NS+ - (Array) A set of numbers. - * * +BS+ - (Array) A set of binary - * attributes. - * * +RangeKeyElement+ - (Object) A range key element is - * treated as a secondary key (used in conjunction with the - * primary key), and can be a string or a number, and is only - * used for hash-and-range primary keys. The value can be String, - * Number, StringSet, NumberSet. - * * +S+ - (String) Strings are Unicode with UTF-8 - * binary encoding. The maximum size is limited by the size of - * the primary key (1024 bytes as a range part of a key or 2048 - * bytes as a single part hash key) or the item size (64k). - * * +N+ - (String) Numbers are positive or negative - * exact-value decimals and integers. A number can have up to - * 38 digits precision and can be between 10^-128 to 10^+126. - * * +B+ - (Base64 Encoded Data) Binary attributes are - * sequences of unsigned bytes. - * * +SS+ - (Array) A set of strings. - * * +NS+ - (Array) A set of numbers. - * * +BS+ - (Array) A set of binary - * attributes. - * * +ConsumedCapacityUnits+ - (Float) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Items+ - (Array>) + * * +Count+ - (Integer) Number of items in the response. + * * +LastEvaluatedKey+ - (Object) Primary key of the item + * where the query operation stopped, inclusive of the previous + * result set. Use this value to start a new operation excluding + * this value in the new request. The LastEvaluatedKey is null when + * the entire query result set is complete (i.e. the operation + * processed the "last page"). + * * +HashKeyElement+ - (Object) A hash key + * element is treated as the primary key, and can be a string or + * a number. Single attribute primary keys have one index value. + * The value can be String, Number, StringSet, NumberSet. + * * +S+ - (String) Strings are Unicode with UTF-8 + * binary encoding. The maximum size is limited by the size of + * the primary key (1024 bytes as a range part of a key or 2048 + * bytes as a single part hash key) or the item size (64k). + * * +N+ - (String) Numbers are positive or negative + * exact-value decimals and integers. A number can have up to + * 38 digits precision and can be between 10^-128 to 10^+126. + * * +B+ - (Base64 Encoded Data) Binary attributes are + * sequences of unsigned bytes. + * * +SS+ - (Array) A set of strings. + * * +NS+ - (Array) A set of numbers. + * * +BS+ - (Array) A set of binary + * attributes. + * * +RangeKeyElement+ - (Object) A range key element is + * treated as a secondary key (used in conjunction with the + * primary key), and can be a string or a number, and is only + * used for hash-and-range primary keys. The value can be String, + * Number, StringSet, NumberSet. + * * +S+ - (String) Strings are Unicode with UTF-8 + * binary encoding. The maximum size is limited by the size of + * the primary key (1024 bytes as a range part of a key or 2048 + * bytes as a single part hash key) or the item size (64k). + * * +N+ - (String) Numbers are positive or negative + * exact-value decimals and integers. A number can have up to + * 38 digits precision and can be between 10^-128 to 10^+126. + * * +B+ - (Base64 Encoded Data) Binary attributes are + * sequences of unsigned bytes. + * * +SS+ - (Array) A set of strings. + * * +NS+ - (Array) A set of numbers. + * * +BS+ - (Array) A set of binary + * attributes. + * * +ConsumedCapacityUnits+ - (Float) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method scan(params, options) + * @!method scan(params, callback) * Retrieves one or more items and its attributes by performing a full * scan of a table. - * @param [Object] params + * @param params [Object] * * +TableName+ - (*required*, String) The name of the * table in which you want to scan. Allowed characters are a-z, * A-Z, 0-9, _ (underscore), - (hyphen) and . (period). @@ -913,61 +987,68 @@ AWS.DynamoDB = inherit({}) * * +NS+ - (Array) A set of numbers. * * +BS+ - (Array) A set of binary * attributes. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Items+ - (Array>) - * * +Count+ - (Integer) Number of items in the response. - * * +ScannedCount+ - (Integer) Number of items in the - * complete scan before any filters are applied. A high - * ScannedCount value with few, or no, Count results indicates an - * inefficient Scan operation. - * * +LastEvaluatedKey+ - (Object) Primary key of the item - * where the scan operation stopped. Provide this value in a - * subsequent scan operation to continue the operation from that - * point. The LastEvaluatedKey is null when the entire scan result - * set is complete (i.e. the operation processed the "last page"). - * * +HashKeyElement+ - (Object) A hash key - * element is treated as the primary key, and can be a string or - * a number. Single attribute primary keys have one index value. - * The value can be String, Number, StringSet, NumberSet. - * * +S+ - (String) Strings are Unicode with UTF-8 - * binary encoding. The maximum size is limited by the size of - * the primary key (1024 bytes as a range part of a key or 2048 - * bytes as a single part hash key) or the item size (64k). - * * +N+ - (String) Numbers are positive or negative - * exact-value decimals and integers. A number can have up to - * 38 digits precision and can be between 10^-128 to 10^+126. - * * +B+ - (Base64 Encoded Data) Binary attributes are - * sequences of unsigned bytes. - * * +SS+ - (Array) A set of strings. - * * +NS+ - (Array) A set of numbers. - * * +BS+ - (Array) A set of binary - * attributes. - * * +RangeKeyElement+ - (Object) A range key element is - * treated as a secondary key (used in conjunction with the - * primary key), and can be a string or a number, and is only - * used for hash-and-range primary keys. The value can be String, - * Number, StringSet, NumberSet. - * * +S+ - (String) Strings are Unicode with UTF-8 - * binary encoding. The maximum size is limited by the size of - * the primary key (1024 bytes as a range part of a key or 2048 - * bytes as a single part hash key) or the item size (64k). - * * +N+ - (String) Numbers are positive or negative - * exact-value decimals and integers. A number can have up to - * 38 digits precision and can be between 10^-128 to 10^+126. - * * +B+ - (Base64 Encoded Data) Binary attributes are - * sequences of unsigned bytes. - * * +SS+ - (Array) A set of strings. - * * +NS+ - (Array) A set of numbers. - * * +BS+ - (Array) A set of binary - * attributes. - * * +ConsumedCapacityUnits+ - (Float) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Items+ - (Array>) + * * +Count+ - (Integer) Number of items in the response. + * * +ScannedCount+ - (Integer) Number of items in the + * complete scan before any filters are applied. A high + * ScannedCount value with few, or no, Count results indicates an + * inefficient Scan operation. + * * +LastEvaluatedKey+ - (Object) Primary key of the item + * where the scan operation stopped. Provide this value in a + * subsequent scan operation to continue the operation from that + * point. The LastEvaluatedKey is null when the entire scan result + * set is complete (i.e. the operation processed the "last page"). + * * +HashKeyElement+ - (Object) A hash key + * element is treated as the primary key, and can be a string or + * a number. Single attribute primary keys have one index value. + * The value can be String, Number, StringSet, NumberSet. + * * +S+ - (String) Strings are Unicode with UTF-8 + * binary encoding. The maximum size is limited by the size of + * the primary key (1024 bytes as a range part of a key or 2048 + * bytes as a single part hash key) or the item size (64k). + * * +N+ - (String) Numbers are positive or negative + * exact-value decimals and integers. A number can have up to + * 38 digits precision and can be between 10^-128 to 10^+126. + * * +B+ - (Base64 Encoded Data) Binary attributes are + * sequences of unsigned bytes. + * * +SS+ - (Array) A set of strings. + * * +NS+ - (Array) A set of numbers. + * * +BS+ - (Array) A set of binary + * attributes. + * * +RangeKeyElement+ - (Object) A range key element is + * treated as a secondary key (used in conjunction with the + * primary key), and can be a string or a number, and is only + * used for hash-and-range primary keys. The value can be String, + * Number, StringSet, NumberSet. + * * +S+ - (String) Strings are Unicode with UTF-8 + * binary encoding. The maximum size is limited by the size of + * the primary key (1024 bytes as a range part of a key or 2048 + * bytes as a single part hash key) or the item size (64k). + * * +N+ - (String) Numbers are positive or negative + * exact-value decimals and integers. A number can have up to + * 38 digits precision and can be between 10^-128 to 10^+126. + * * +B+ - (Base64 Encoded Data) Binary attributes are + * sequences of unsigned bytes. + * * +SS+ - (Array) A set of strings. + * * +NS+ - (Array) A set of numbers. + * * +BS+ - (Array) A set of binary + * attributes. + * * +ConsumedCapacityUnits+ - (Float) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method updateItem(params, options) + * @!method updateItem(params, callback) * Edits an existing item's attributes. - * @param [Object] params + * @param params [Object] * * +TableName+ - (*required*, String) The name of the * table in which you want to update an item. Allowed characters * are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period). @@ -1043,31 +1124,38 @@ AWS.DynamoDB = inherit({}) * * +Exists+ - (Boolean) Specify whether or not a value * already exists for the attribute name-value pair. * * +ReturnValues+ - (String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Attributes+ - (Object) A map of attribute - * name-value pairs, but only if the ReturnValues parameter is - * specified as something other than NONE in the request. - * * +S+ - (String) Strings are Unicode with UTF-8 binary - * encoding. The maximum size is limited by the size of the - * primary key (1024 bytes as a range part of a key or 2048 bytes - * as a single part hash key) or the item size (64k). - * * +N+ - (String) Numbers are positive or negative - * exact-value decimals and integers. A number can have up to 38 - * digits precision and can be between 10^-128 to 10^+126. - * * +B+ - (Base64 Encoded Data) Binary attributes are - * sequences of unsigned bytes. - * * +SS+ - (Array) A set of strings. - * * +NS+ - (Array) A set of numbers. - * * +BS+ - (Array) A set of binary - * attributes. - * * +ConsumedCapacityUnits+ - (Float) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Attributes+ - (Object) A map of attribute + * name-value pairs, but only if the ReturnValues parameter is + * specified as something other than NONE in the request. + * * +S+ - (String) Strings are Unicode with UTF-8 binary + * encoding. The maximum size is limited by the size of the + * primary key (1024 bytes as a range part of a key or 2048 bytes + * as a single part hash key) or the item size (64k). + * * +N+ - (String) Numbers are positive or negative + * exact-value decimals and integers. A number can have up to 38 + * digits precision and can be between 10^-128 to 10^+126. + * * +B+ - (Base64 Encoded Data) Binary attributes are + * sequences of unsigned bytes. + * * +SS+ - (Array) A set of strings. + * * +NS+ - (Array) A set of numbers. + * * +BS+ - (Array) A set of binary + * attributes. + * * +ConsumedCapacityUnits+ - (Float) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method updateTable(params, options) + * @!method updateTable(params, callback) * Updates the provisioned throughput for the given table. - * @param [Object] params + * @param params [Object] * * +TableName+ - (*required*, String) The name of the * table you want to update. Allowed characters are a-z, A-Z, 0-9, * _ (underscore), - (hyphen) and . (period). @@ -1081,43 +1169,50 @@ AWS.DynamoDB = inherit({}) * WriteCapacityUnits are in terms of strictly consistent reads, * assuming items of 1k. 2k items require twice the * WriteCapacityUnits. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +TableDescription+ - (Object) - * * +TableName+ - (String) The name of the table being - * described. - * * +KeySchema+ - (Object) - * * +HashKeyElement+ - (Object) A hash key - * element is treated as the primary key, and can be a string - * or a number. Single attribute primary keys have one index - * value. The value can be String, Number, StringSet, - * NumberSet. - * * +AttributeName+ - (String) The - * AttributeName of the KeySchemaElement. - * * +AttributeType+ - (String) The - * AttributeType of the KeySchemaElement which can be a - * String or a Number. - * * +RangeKeyElement+ - (Object) A range key element is - * treated as a secondary key (used in conjunction with the - * primary key), and can be a string or a number, and is only - * used for hash-and-range primary keys. The value can be - * String, Number, StringSet, NumberSet. - * * +AttributeName+ - (String) The - * AttributeName of the KeySchemaElement. - * * +AttributeType+ - (String) The - * AttributeType of the KeySchemaElement which can be a - * String or a Number. - * * +TableStatus+ - (String) - * * +CreationDateTime+ - (Date) - * * +ProvisionedThroughput+ - (Object) - * * +LastIncreaseDateTime+ - (Date) - * * +LastDecreaseDateTime+ - (Date) - * * +ReadCapacityUnits+ - (Integer) - * * +WriteCapacityUnits+ - (Integer) - * * +TableSizeBytes+ - (Integer) - * * +ItemCount+ - (Integer) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +TableDescription+ - (Object) + * * +TableName+ - (String) The name of the table being + * described. + * * +KeySchema+ - (Object) + * * +HashKeyElement+ - (Object) A hash key + * element is treated as the primary key, and can be a string + * or a number. Single attribute primary keys have one index + * value. The value can be String, Number, StringSet, + * NumberSet. + * * +AttributeName+ - (String) The + * AttributeName of the KeySchemaElement. + * * +AttributeType+ - (String) The + * AttributeType of the KeySchemaElement which can be a + * String or a Number. + * * +RangeKeyElement+ - (Object) A range key element is + * treated as a secondary key (used in conjunction with the + * primary key), and can be a string or a number, and is only + * used for hash-and-range primary keys. The value can be + * String, Number, StringSet, NumberSet. + * * +AttributeName+ - (String) The + * AttributeName of the KeySchemaElement. + * * +AttributeType+ - (String) The + * AttributeType of the KeySchemaElement which can be a + * String or a Number. + * * +TableStatus+ - (String) + * * +CreationDateTime+ - (Date) + * * +ProvisionedThroughput+ - (Object) + * * +LastIncreaseDateTime+ - (Date) + * * +LastDecreaseDateTime+ - (Date) + * * +ReadCapacityUnits+ - (Integer) + * * +WriteCapacityUnits+ - (Integer) + * * +TableSizeBytes+ - (Integer) + * * +ItemCount+ - (Integer) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * * * @!method constructor(options) diff --git a/doc-src/ec2.docs.js b/doc-src/ec2.docs.js index 6b6368acbd..4aecd0c05c 100644 --- a/doc-src/ec2.docs.js +++ b/doc-src/ec2.docs.js @@ -24,8 +24,12 @@ AWS = {}; * === Sending a Request Using EC2 * * svc = new AWS.EC2(); - * svc.client.OPERATION_NAME(params).always(function (resp) { - * console.log(resp.data, resp.error); + * svc.client.OPERATION_NAME(params, function (err, data) { + * if (err) { + * console.log(err); // an error occurred + * } else { + * console.log(data); // successful response + * } * }); * * @!method constructor(options) @@ -46,46 +50,69 @@ AWS.EC2 = inherit({}) * The low-level EC2 client class. This class provides one function * for each API operation on the service. * - * @!method activateLicense(params, options) + * @!method activateLicense(params, callback) * Activates a specific number of licenses for a 90-day period. * Activations can be done against a specific license ID. - * @param [Object] params + * @param params [Object] * * +licenseId+ - (*required*, String) Specifies the ID for * the specific license to activate against. * * +capacity+ - (*required*, Integer) Specifies the * additional number of licenses to activate. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method allocateAddress(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method allocateAddress(params, callback) * The AllocateAddress operation acquires an elastic IP address for use * with your account. - * @param [Object] params + * @param params [Object] * * +Domain+ - (String) Set to vpc to allocate the address * to your VPC. By default, will allocate to EC2. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +PublicIp+ - (String) IP address for use with your - * account. - * * +domain+ - (String) - * * +allocationId+ - (String) - * - * @!method assignPrivateIpAddresses(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +PublicIp+ - (String) IP address for use with your + * account. + * * +domain+ - (String) + * * +allocationId+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method assignPrivateIpAddresses(params, callback) * Calls the AssignPrivateIpAddresses API operation. - * @param [Object] params + * @param params [Object] * * +networkInterfaceId+ - (*required*, String) * * +privateIpAddresses+ - (Array) * * +secondaryPrivateIpAddressCount+ - (Integer) * * +allowReassignment+ - (Boolean) - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method associateAddress(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method associateAddress(params, callback) * The AssociateAddress operation associates an elastic IP address with * an instance. - * @param [Object] params + * @param params [Object] * * +InstanceId+ - (*required*, String) The instance to * associate with the IP address. * * +PublicIp+ - (*required*, String) IP address that you @@ -96,13 +123,20 @@ AWS.EC2 = inherit({}) * * +networkInterfaceId+ - (String) * * +privateIpAddress+ - (String) * * +allowReassociation+ - (Boolean) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +associationId+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +associationId+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method associateDhcpOptions(params, options) + * @!method associateDhcpOptions(params, callback) * Associates a set of DHCP options (that you've previously created) * with the specified VPC. Or, associates the default DHCP options with * the VPC. The default set consists of the standard EC2 host name, no @@ -112,58 +146,88 @@ AWS.EC2 = inherit({}) * use the options. For more information about the supported DHCP * options and using them with Amazon VPC, go to Using DHCP Options in * the Amazon Virtual Private Cloud Developer Guide. - * @param [Object] params + * @param params [Object] * * +DhcpOptionsId+ - (*required*, String) The ID of the * DHCP options to associate with the VPC. Specify "default" to * associate the default DHCP options with the VPC. * * +VpcId+ - (*required*, String) The ID of the VPC to * associate the DHCP options with. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method associateRouteTable(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method associateRouteTable(params, callback) * Associates a subnet with a route table. The subnet and route table * must be in the same VPC. This association causes traffic originating * from the subnet to be routed according to the routes in the route * table. The action returns an association ID, which you need if you * want to disassociate the route table from the subnet later. A route * table can be associated with multiple subnets. - * @param [Object] params + * @param params [Object] * * +subnetId+ - (*required*, String) The ID of the subnet. * * +routeTableId+ - (*required*, String) The ID of the * route table. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +associationId+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +associationId+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method attachInternetGateway(params, options) + * @!method attachInternetGateway(params, callback) * Attaches an Internet gateway to a VPC, enabling connectivity between * the Internet and the VPC. For more information about your VPC and * Internet gateway, go to the Amazon Virtual Private Cloud User Guide. - * @param [Object] params + * @param params [Object] * * +internetGatewayId+ - (*required*, String) The ID of * the Internet gateway to attach. * * +vpcId+ - (*required*, String) The ID of the VPC. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method attachNetworkInterface(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method attachNetworkInterface(params, callback) * Calls the AttachNetworkInterface API operation. - * @param [Object] params + * @param params [Object] * * +networkInterfaceId+ - (*required*, String) * * +instanceId+ - (*required*, String) * * +deviceIndex+ - (*required*, Integer) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +attachmentId+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +attachmentId+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method attachVolume(params, options) + * @!method attachVolume(params, callback) * Attach a previously created volume to a running instance. - * @param [Object] params + * @param params [Object] * * +VolumeId+ - (*required*, String) The ID of the Amazon * EBS volume. The volume and instance must be within the same * Availability Zone and the instance must be running. @@ -173,44 +237,58 @@ AWS.EC2 = inherit({}) * be running. * * +Device+ - (*required*, String) Specifies how the * device is exposed to the instance (e.g., /dev/sdh). - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Attachment+ - (Object) - * * +VolumeId+ - (String) - * * +InstanceId+ - (String) - * * +Device+ - (String) How the device is exposed to the - * instance (e.g., /dev/sdh). - * * +State+ - (String) - * * +AttachTime+ - (Date) Timestamp when this attachment - * initiated. - * * +deleteOnTermination+ - (Boolean) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Attachment+ - (Object) + * * +VolumeId+ - (String) + * * +InstanceId+ - (String) + * * +Device+ - (String) How the device is exposed to the + * instance (e.g., /dev/sdh). + * * +State+ - (String) + * * +AttachTime+ - (Date) Timestamp when this attachment + * initiated. + * * +deleteOnTermination+ - (Boolean) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method attachVpnGateway(params, options) + * @!method attachVpnGateway(params, callback) * Attaches a VPN gateway to a VPC. This is the last step required to * get your VPC fully connected to your data center before launching * instances in it. For more information, go to Process for Using * Amazon VPC in the Amazon Virtual Private Cloud Developer Guide. - * @param [Object] params + * @param params [Object] * * +VpnGatewayId+ - (*required*, String) The ID of the VPN * gateway to attach to the VPC. * * +VpcId+ - (*required*, String) The ID of the VPC to * attach to the VPN gateway. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +VpcAttachement+ - (Object) - * * +VpcId+ - (String) - * * +State+ - (String) - * - * @!method authorizeSecurityGroupEgress(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +VpcAttachement+ - (Object) + * * +VpcId+ - (String) + * * +State+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method authorizeSecurityGroupEgress(params, callback) * This action applies only to security groups in a VPC; it's not * supported for EC2 security groups. For information about Amazon * Virtual Private Cloud and VPC security groups, go to the Amazon * Virtual Private Cloud User Guide. - * @param [Object] params + * @param params [Object] * * +groupId+ - (*required*, String) ID of the VPC security * group to modify. * * +sourceSecurityGroupName+ - (String) Deprecated. @@ -245,13 +323,21 @@ AWS.EC2 = inherit({}) * * +IpRanges+ - (Array) The list of CIDR IP * ranges included in this permission. * * +CidrIp+ - (String) The list of CIDR IP ranges. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method authorizeSecurityGroupIngress(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method authorizeSecurityGroupIngress(params, callback) * The AuthorizeSecurityGroupIngress operation adds permissions to a * security group. - * @param [Object] params + * @param params [Object] * * +GroupName+ - (String) Name of the standard (EC2) * security group to modify. The group must belong to your account. * Can be used instead of GroupID for standard (EC2) security @@ -292,16 +378,24 @@ AWS.EC2 = inherit({}) * * +IpRanges+ - (Array) The list of CIDR IP * ranges included in this permission. * * +CidrIp+ - (String) The list of CIDR IP ranges. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method bundleInstance(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method bundleInstance(params, callback) * The BundleInstance operation request that an instance is bundled the * next time it boots. The bundling process creates a new image from a * running instance and stores the AMI data in S3. Once bundled, the * image must be registered in the normal way using the RegisterImage * API. - * @param [Object] params + * @param params [Object] * * +InstanceId+ - (*required*, String) The ID of the * instance to bundle. * * +Storage+ - (*required*, Object) @@ -319,158 +413,209 @@ AWS.EC2 = inherit({}) * items into Amazon S3 on the user's behalf. * * +UploadPolicySignature+ - (String) The signature of * the Base64 encoded JSON document. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +BundleTask+ - (Object) - * * +InstanceId+ - (String) Instance associated with this - * bundle task. - * * +BundleId+ - (String) Unique identifier for this - * task. - * * +State+ - (String) The state of this task. - * * +StartTime+ - (Date) The time this task started. - * * +UpdateTime+ - (Date) The time of the most recent - * update for the task. - * * +Storage+ - (Object) Amazon S3 storage locations. - * * +S3+ - (Object) The details of S3 storage for - * bundling a Windows instance. - * * +Bucket+ - (String) The bucket in which to store - * the AMI. You can specify a bucket that you already own or - * a new bucket that Amazon EC2 creates on your behalf. - * * +Prefix+ - (String) The prefix to use when - * storing the AMI in S3. - * * +AWSAccessKeyId+ - (String) The Access Key ID of - * the owner of the Amazon S3 bucket. - * * +UploadPolicy+ - (String) A Base64-encoded Amazon - * S3 upload policy that gives Amazon EC2 permission to - * upload items into Amazon S3 on the user's behalf. - * * +UploadPolicySignature+ - (String) The signature - * of the Base64 encoded JSON document. - * * +Progress+ - (String) The level of task completion, - * in percent (e.g., 20%). - * * +BundleTaskError+ - (Object) If the task fails, a - * description of the error. - * * +Code+ - (String) Error code. - * * +Message+ - (String) Error message. - * - * @!method cancelBundleTask(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +BundleTask+ - (Object) + * * +InstanceId+ - (String) Instance associated with this + * bundle task. + * * +BundleId+ - (String) Unique identifier for this + * task. + * * +State+ - (String) The state of this task. + * * +StartTime+ - (Date) The time this task started. + * * +UpdateTime+ - (Date) The time of the most recent + * update for the task. + * * +Storage+ - (Object) Amazon S3 storage locations. + * * +S3+ - (Object) The details of S3 storage for + * bundling a Windows instance. + * * +Bucket+ - (String) The bucket in which to store + * the AMI. You can specify a bucket that you already own or + * a new bucket that Amazon EC2 creates on your behalf. + * * +Prefix+ - (String) The prefix to use when + * storing the AMI in S3. + * * +AWSAccessKeyId+ - (String) The Access Key ID of + * the owner of the Amazon S3 bucket. + * * +UploadPolicy+ - (String) A Base64-encoded Amazon + * S3 upload policy that gives Amazon EC2 permission to + * upload items into Amazon S3 on the user's behalf. + * * +UploadPolicySignature+ - (String) The signature + * of the Base64 encoded JSON document. + * * +Progress+ - (String) The level of task completion, + * in percent (e.g., 20%). + * * +BundleTaskError+ - (Object) If the task fails, a + * description of the error. + * * +Code+ - (String) Error code. + * * +Message+ - (String) Error message. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method cancelBundleTask(params, callback) * CancelBundleTask operation cancels a pending or in-progress bundling * task. This is an asynchronous call and it make take a while for the * task to be canceled. If a task is canceled while it is storing * items, there may be parts of the incomplete AMI stored in S3. It is * up to the caller to clean up these parts from S3. - * @param [Object] params + * @param params [Object] * * +BundleId+ - (*required*, String) The ID of the bundle * task to cancel. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +BundleTask+ - (Object) The canceled bundle task. - * * +InstanceId+ - (String) Instance associated with this - * bundle task. - * * +BundleId+ - (String) Unique identifier for this - * task. - * * +State+ - (String) The state of this task. - * * +StartTime+ - (Date) The time this task started. - * * +UpdateTime+ - (Date) The time of the most recent - * update for the task. - * * +Storage+ - (Object) Amazon S3 storage locations. - * * +S3+ - (Object) The details of S3 storage for - * bundling a Windows instance. - * * +Bucket+ - (String) The bucket in which to store - * the AMI. You can specify a bucket that you already own or - * a new bucket that Amazon EC2 creates on your behalf. - * * +Prefix+ - (String) The prefix to use when - * storing the AMI in S3. - * * +AWSAccessKeyId+ - (String) The Access Key ID of - * the owner of the Amazon S3 bucket. - * * +UploadPolicy+ - (String) A Base64-encoded Amazon - * S3 upload policy that gives Amazon EC2 permission to - * upload items into Amazon S3 on the user's behalf. - * * +UploadPolicySignature+ - (String) The signature - * of the Base64 encoded JSON document. - * * +Progress+ - (String) The level of task completion, - * in percent (e.g., 20%). - * * +BundleTaskError+ - (Object) If the task fails, a - * description of the error. - * * +Code+ - (String) Error code. - * * +Message+ - (String) Error message. - * - * @!method cancelConversionTask(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +BundleTask+ - (Object) The canceled bundle task. + * * +InstanceId+ - (String) Instance associated with this + * bundle task. + * * +BundleId+ - (String) Unique identifier for this + * task. + * * +State+ - (String) The state of this task. + * * +StartTime+ - (Date) The time this task started. + * * +UpdateTime+ - (Date) The time of the most recent + * update for the task. + * * +Storage+ - (Object) Amazon S3 storage locations. + * * +S3+ - (Object) The details of S3 storage for + * bundling a Windows instance. + * * +Bucket+ - (String) The bucket in which to store + * the AMI. You can specify a bucket that you already own or + * a new bucket that Amazon EC2 creates on your behalf. + * * +Prefix+ - (String) The prefix to use when + * storing the AMI in S3. + * * +AWSAccessKeyId+ - (String) The Access Key ID of + * the owner of the Amazon S3 bucket. + * * +UploadPolicy+ - (String) A Base64-encoded Amazon + * S3 upload policy that gives Amazon EC2 permission to + * upload items into Amazon S3 on the user's behalf. + * * +UploadPolicySignature+ - (String) The signature + * of the Base64 encoded JSON document. + * * +Progress+ - (String) The level of task completion, + * in percent (e.g., 20%). + * * +BundleTaskError+ - (Object) If the task fails, a + * description of the error. + * * +Code+ - (String) Error code. + * * +Message+ - (String) Error message. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method cancelConversionTask(params, callback) * Calls the CancelConversionTask API operation. - * @param [Object] params + * @param params [Object] * * +conversionTaskId+ - (*required*, String) * * +reasonMessage+ - (String) - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method cancelExportTask(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method cancelExportTask(params, callback) * Calls the CancelExportTask API operation. - * @param [Object] params + * @param params [Object] * * +exportTaskId+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method cancelReservedInstancesListing(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method cancelReservedInstancesListing(params, callback) * Calls the CancelReservedInstancesListing API operation. - * @param [Object] params + * @param params [Object] * * +reservedInstancesListingId+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +reservedInstancesListings+ - (Array) - * * +reservedInstancesListingId+ - (String) - * * +reservedInstancesId+ - (String) - * * +createDate+ - (Date) - * * +updateDate+ - (Date) - * * +status+ - (String) - * * +statusMessage+ - (String) - * * +instanceCounts+ - (Array) - * * +state+ - (String) - * * +instanceCount+ - (Integer) - * * +priceSchedules+ - (Array) - * * +term+ - (Integer) - * * +price+ - (Float) - * * +currencyCode+ - (String) - * * +active+ - (Boolean) - * * +tags+ - (Array) - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. - * * +clientToken+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +reservedInstancesListings+ - (Array) + * * +reservedInstancesListingId+ - (String) + * * +reservedInstancesId+ - (String) + * * +createDate+ - (Date) + * * +updateDate+ - (Date) + * * +status+ - (String) + * * +statusMessage+ - (String) + * * +instanceCounts+ - (Array) + * * +state+ - (String) + * * +instanceCount+ - (Integer) + * * +priceSchedules+ - (Array) + * * +term+ - (Integer) + * * +price+ - (Float) + * * +currencyCode+ - (String) + * * +active+ - (Boolean) + * * +tags+ - (Array) + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * * +clientToken+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method cancelSpotInstanceRequests(params, options) + * @!method cancelSpotInstanceRequests(params, callback) * Cancels one or more Spot Instance requests. - * @param [Object] params + * @param params [Object] * * +spotInstanceRequestIds+ - (*required*, Array) * Specifies the ID of the Spot Instance request. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +cancelledSpotInstanceRequests+ - (Array) - * * +spotInstanceRequestId+ - (String) - * * +state+ - (String) - * - * @!method confirmProductInstance(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +cancelledSpotInstanceRequests+ - (Array) + * * +spotInstanceRequestId+ - (String) + * * +state+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method confirmProductInstance(params, callback) * The ConfirmProductInstance operation returns true if the specified * product code is attached to the specified instance. The operation * returns false if the product code is not attached to the instance. - * @param [Object] params + * @param params [Object] * * +ProductCode+ - (*required*, String) The product code * to confirm. * * +InstanceId+ - (*required*, String) The ID of the * instance to confirm. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +OwnerId+ - (String) The instance owner's account ID. - * Only present if the product code is attached to the instance. - * - * @!method createCustomerGateway(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +OwnerId+ - (String) The instance owner's account ID. + * Only present if the product code is attached to the instance. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method createCustomerGateway(params, callback) * Provides information to AWS about your customer gateway device. The * customer gateway is the appliance at your end of the VPN connection * (compared to the VPN gateway, which is the device at the AWS side of @@ -479,7 +624,7 @@ AWS.EC2 = inherit({}) * to use with the customer gateway). AWS might delete any customer * gateway that you create with this operation if you leave it inactive * for an extended period of time. - * @param [Object] params + * @param params [Object] * * +Type+ - (*required*, String) The type of VPN * connection this customer gateway supports. * * +PublicIp+ - (*required*, String) The Internet-routable @@ -487,67 +632,81 @@ AWS.EC2 = inherit({}) * address must be static * * +BgpAsn+ - (*required*, Integer) The customer gateway's * Border Gateway Protocol (BGP) Autonomous System Number (ASN). - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +CustomerGateway+ - (Object) Information about the - * customer gateway. - * * +CustomerGatewayId+ - (String) Specifies the ID of - * the customer gateway. - * * +State+ - (String) Describes the current state of the - * customer gateway. Valid values are pending, available, - * deleting, and deleted. - * * +Type+ - (String) Specifies the type of VPN - * connection the customer gateway supports. - * * +IpAddress+ - (String) Contains the Internet-routable - * IP address of the customer gateway's outside interface. - * * +BgpAsn+ - (String) Specifies the customer gateway's - * Border Gateway Protocol (BGP) Autonomous System Number (ASN). - * * +tags+ - (Array) A list of tags for the - * CustomerGateway. - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +CustomerGateway+ - (Object) Information about the + * customer gateway. + * * +CustomerGatewayId+ - (String) Specifies the ID of + * the customer gateway. + * * +State+ - (String) Describes the current state of the + * customer gateway. Valid values are pending, available, + * deleting, and deleted. + * * +Type+ - (String) Specifies the type of VPN + * connection the customer gateway supports. + * * +IpAddress+ - (String) Contains the Internet-routable + * IP address of the customer gateway's outside interface. + * * +BgpAsn+ - (String) Specifies the customer gateway's + * Border Gateway Protocol (BGP) Autonomous System Number (ASN). + * * +tags+ - (Array) A list of tags for the + * CustomerGateway. + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method createDhcpOptions(params, options) + * @!method createDhcpOptions(params, callback) * Creates a set of DHCP options that you can then associate with one * or more VPCs, causing all existing and new instances that you launch * in those VPCs to use the set of DHCP options. The following table * lists the individual DHCP options you can specify. For more * information about the options, go to * http://www.ietf.org/rfc/rfc2132.txt - * @param [Object] params + * @param params [Object] * * +DhcpConfigurations+ - (*required*, Array) A * set of one or more DHCP configurations. * * +Key+ - (String) Contains the name of a DHCP option. * * +Values+ - (Array) Contains a set of values * for a DHCP option. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +DhcpOptions+ - (Object) A set of one or more DHCP - * options. - * * +DhcpOptionsId+ - (String) Specifies the ID of the - * set of DHCP options. - * * +DhcpConfigurations+ - (Array) Contains - * information about the set of DHCP options. - * * +Key+ - (String) Contains the name of a DHCP - * option. - * * +Values+ - (Array) Contains a set of values - * for a DHCP option. - * * +tags+ - (Array) A list of tags for the - * DhcpOptions. - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +DhcpOptions+ - (Object) A set of one or more DHCP + * options. + * * +DhcpOptionsId+ - (String) Specifies the ID of the + * set of DHCP options. + * * +DhcpConfigurations+ - (Array) Contains + * information about the set of DHCP options. + * * +Key+ - (String) Contains the name of a DHCP + * option. + * * +Values+ - (Array) Contains a set of values + * for a DHCP option. + * * +tags+ - (Array) A list of tags for the + * DhcpOptions. + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method createImage(params, options) + * @!method createImage(params, callback) * Creates an Amazon EBS-backed AMI from a "running" or "stopped" * instance. AMIs that use an Amazon EBS root device boot faster than * AMIs that use instance stores. They can be up to 1 TiB in size, use * storage that persists on instance failure, and can be stopped and * started. - * @param [Object] params + * @param params [Object] * * +instanceId+ - (*required*, String) The ID of the * instance from which to create the new image. * * +name+ - (*required*, String) The name for the new AMI @@ -578,15 +737,22 @@ AWS.EC2 = inherit({}) * * +iops+ - (Integer) * * +noDevice+ - (String) Specifies the device name to * suppress during instance launch. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +imageId+ - (String) The ID of the new AMI. - * - * @!method createInstanceExportTask(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +imageId+ - (String) The ID of the new AMI. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method createInstanceExportTask(params, callback) * Calls the CreateInstanceExportTask API operation. - * @param [Object] params + * @param params [Object] * * +description+ - (String) * * +instanceId+ - (*required*, String) * * +targetEnvironment+ - (String) @@ -595,111 +761,139 @@ AWS.EC2 = inherit({}) * * +containerFormat+ - (String) * * +s3Bucket+ - (String) * * +s3Prefix+ - (String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +exportTask+ - (Object) - * * +exportTaskId+ - (String) - * * +description+ - (String) - * * +state+ - (String) - * * +statusMessage+ - (String) - * * +instanceExportDetails+ - (Object) - * * +instanceId+ - (String) - * * +targetEnvironment+ - (String) - * * +exportToS3Task+ - (Object) - * * +diskImageFormat+ - (String) - * * +containerFormat+ - (String) - * * +s3Bucket+ - (String) - * * +s3Key+ - (String) - * - * @!method createInternetGateway(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +exportTask+ - (Object) + * * +exportTaskId+ - (String) + * * +description+ - (String) + * * +state+ - (String) + * * +statusMessage+ - (String) + * * +instanceExportDetails+ - (Object) + * * +instanceId+ - (String) + * * +targetEnvironment+ - (String) + * * +exportToS3Task+ - (Object) + * * +diskImageFormat+ - (String) + * * +containerFormat+ - (String) + * * +s3Bucket+ - (String) + * * +s3Key+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method createInternetGateway(params, callback) * Creates a new Internet gateway in your AWS account. After creating * the Internet gateway, you then attach it to a VPC using * AttachInternetGateway. For more information about your VPC and * Internet gateway, go to Amazon Virtual Private Cloud User Guide. - * @param [Object] params - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +internetGateway+ - (Object) - * * +internetGatewayId+ - (String) - * * +attachments+ - (Array) - * * +vpcId+ - (String) - * * +state+ - (String) - * * +tags+ - (Array) - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. + * @param params [Object] + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +internetGateway+ - (Object) + * * +internetGatewayId+ - (String) + * * +attachments+ - (Array) + * * +vpcId+ - (String) + * * +state+ - (String) + * * +tags+ - (Array) + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method createKeyPair(params, options) + * @!method createKeyPair(params, callback) * The CreateKeyPair operation creates a new 2048 bit RSA key pair and * returns a unique ID that can be used to reference this key pair when * launching new instances. For more information, see RunInstances. - * @param [Object] params + * @param params [Object] * * +KeyName+ - (*required*, String) The unique name for * the new key pair. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +KeyPair+ - (Object) The newly created EC2 key pair. - * * +KeyName+ - (String) The name of the key pair. - * * +KeyFingerprint+ - (String) The SHA-1 digest of the - * DER encoded private key. - * * +KeyMaterial+ - (String) The unencrypted PEM encoded - * RSA private key. - * - * @!method createNetworkAcl(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +KeyPair+ - (Object) The newly created EC2 key pair. + * * +KeyName+ - (String) The name of the key pair. + * * +KeyFingerprint+ - (String) The SHA-1 digest of the + * DER encoded private key. + * * +KeyMaterial+ - (String) The unencrypted PEM encoded + * RSA private key. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method createNetworkAcl(params, callback) * Creates a new network ACL in a VPC. Network ACLs provide an optional * layer of security (on top of security groups) for the instances in * your VPC. For more information about network ACLs, go to Network * ACLs in the Amazon Virtual Private Cloud User Guide. - * @param [Object] params + * @param params [Object] * * +vpcId+ - (*required*, String) The ID of the VPC where * the network ACL will be created. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +networkAcl+ - (Object) - * * +networkAclId+ - (String) - * * +vpcId+ - (String) - * * +isDefault+ - (Boolean) - * * +entries+ - (Array) - * * +ruleNumber+ - (Integer) - * * +protocol+ - (String) - * * +ruleAction+ - (String) - * * +egress+ - (Boolean) - * * +cidrBlock+ - (String) - * * +icmpTypeCode+ - (Object) - * * +type+ - (Integer) For the ICMP protocol, the - * ICMP type. A value of -1 is a wildcard meaning all types. - * Required if specifying icmp for the protocol. - * * +code+ - (Integer) For the ICMP protocol, the - * ICMP code. A value of -1 is a wildcard meaning all codes. - * Required if specifying icmp for the protocol. - * * +portRange+ - (Object) - * * +from+ - (Integer) The first port in the range. - * Required if specifying tcp or udp for the protocol. - * * +to+ - (Integer) The last port in the range. - * Required if specifying tcp or udp for the protocol. - * * +associations+ - (Array) - * * +networkAclAssociationId+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +networkAcl+ - (Object) * * +networkAclId+ - (String) - * * +subnetId+ - (String) - * * +tags+ - (Array) - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. + * * +vpcId+ - (String) + * * +isDefault+ - (Boolean) + * * +entries+ - (Array) + * * +ruleNumber+ - (Integer) + * * +protocol+ - (String) + * * +ruleAction+ - (String) + * * +egress+ - (Boolean) + * * +cidrBlock+ - (String) + * * +icmpTypeCode+ - (Object) + * * +type+ - (Integer) For the ICMP protocol, the + * ICMP type. A value of -1 is a wildcard meaning all types. + * Required if specifying icmp for the protocol. + * * +code+ - (Integer) For the ICMP protocol, the + * ICMP code. A value of -1 is a wildcard meaning all codes. + * Required if specifying icmp for the protocol. + * * +portRange+ - (Object) + * * +from+ - (Integer) The first port in the range. + * Required if specifying tcp or udp for the protocol. + * * +to+ - (Integer) The last port in the range. + * Required if specifying tcp or udp for the protocol. + * * +associations+ - (Array) + * * +networkAclAssociationId+ - (String) + * * +networkAclId+ - (String) + * * +subnetId+ - (String) + * * +tags+ - (Array) + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method createNetworkAclEntry(params, options) + * @!method createNetworkAclEntry(params, callback) * Creates an entry (i.e., rule) in a network ACL with a rule number * you specify. Each network ACL has a set of numbered ingress rules * and a separate set of numbered egress rules. When determining * whether a packet should be allowed in or out of a subnet associated * with the ACL, Amazon VPC processes the entries in the ACL according * to the rule numbers, in ascending order. - * @param [Object] params + * @param params [Object] * * +networkAclId+ - (*required*, String) ID of the ACL * where the entry will be created. * * +ruleNumber+ - (*required*, Integer) Rule number to @@ -727,12 +921,20 @@ AWS.EC2 = inherit({}) * Required if specifying tcp or udp for the protocol. * * +to+ - (Integer) The last port in the range. Required * if specifying tcp or udp for the protocol. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method createNetworkInterface(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method createNetworkInterface(params, callback) * Calls the CreateNetworkInterface API operation. - * @param [Object] params + * @param params [Object] * * +subnetId+ - (*required*, String) * * +description+ - (String) * * +privateIpAddress+ - (String) @@ -741,67 +943,82 @@ AWS.EC2 = inherit({}) * * +privateIpAddress+ - (*required*, String) * * +primary+ - (Boolean) * * +secondaryPrivateIpAddressCount+ - (Integer) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +networkInterface+ - (Object) - * * +networkInterfaceId+ - (String) - * * +subnetId+ - (String) - * * +vpcId+ - (String) - * * +availabilityZone+ - (String) - * * +description+ - (String) - * * +ownerId+ - (String) - * * +requesterId+ - (String) - * * +requesterManaged+ - (Boolean) - * * +status+ - (String) - * * +macAddress+ - (String) - * * +privateIpAddress+ - (String) - * * +privateDnsName+ - (String) - * * +sourceDestCheck+ - (Boolean) - * * +groups+ - (Array) - * * +GroupName+ - (String) - * * +groupId+ - (String) - * * +attachment+ - (Object) - * * +attachmentId+ - (String) - * * +instanceId+ - (String) - * * +instanceOwnerId+ - (String) - * * +deviceIndex+ - (Integer) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +networkInterface+ - (Object) + * * +networkInterfaceId+ - (String) + * * +subnetId+ - (String) + * * +vpcId+ - (String) + * * +availabilityZone+ - (String) + * * +description+ - (String) + * * +ownerId+ - (String) + * * +requesterId+ - (String) + * * +requesterManaged+ - (Boolean) * * +status+ - (String) - * * +attachTime+ - (Date) - * * +deleteOnTermination+ - (Boolean) - * * +association+ - (Object) - * * +publicIp+ - (String) - * * +ipOwnerId+ - (String) - * * +allocationId+ - (String) - * * +associationId+ - (String) - * * +tagSet+ - (Array) - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. - * * +privateIpAddresses+ - (Array) + * * +macAddress+ - (String) * * +privateIpAddress+ - (String) - * * +primary+ - (Boolean) + * * +privateDnsName+ - (String) + * * +sourceDestCheck+ - (Boolean) + * * +groups+ - (Array) + * * +GroupName+ - (String) + * * +groupId+ - (String) + * * +attachment+ - (Object) + * * +attachmentId+ - (String) + * * +instanceId+ - (String) + * * +instanceOwnerId+ - (String) + * * +deviceIndex+ - (Integer) + * * +status+ - (String) + * * +attachTime+ - (Date) + * * +deleteOnTermination+ - (Boolean) * * +association+ - (Object) * * +publicIp+ - (String) * * +ipOwnerId+ - (String) * * +allocationId+ - (String) * * +associationId+ - (String) + * * +tagSet+ - (Array) + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * * +privateIpAddresses+ - (Array) + * * +privateIpAddress+ - (String) + * * +primary+ - (Boolean) + * * +association+ - (Object) + * * +publicIp+ - (String) + * * +ipOwnerId+ - (String) + * * +allocationId+ - (String) + * * +associationId+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method createPlacementGroup(params, options) + * @!method createPlacementGroup(params, callback) * Creates a PlacementGroup into which multiple Amazon EC2 instances * can be launched. Users must give the group a name unique within the * scope of the user account. - * @param [Object] params + * @param params [Object] * * +groupName+ - (*required*, String) The name of the * PlacementGroup. * * +strategy+ - (*required*, String) The PlacementGroup * strategy. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method createReservedInstancesListing(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method createReservedInstancesListing(params, callback) * Calls the CreateReservedInstancesListing API operation. - * @param [Object] params + * @param params [Object] * * +reservedInstancesId+ - (*required*, String) * * +instanceCount+ - (*required*, Integer) * * +priceSchedules+ - (*required*, Array) @@ -809,35 +1026,42 @@ AWS.EC2 = inherit({}) * * +price+ - (Float) * * +currencyCode+ - (String) * * +clientToken+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +reservedInstancesListings+ - (Array) - * * +reservedInstancesListingId+ - (String) - * * +reservedInstancesId+ - (String) - * * +createDate+ - (Date) - * * +updateDate+ - (Date) - * * +status+ - (String) - * * +statusMessage+ - (String) - * * +instanceCounts+ - (Array) - * * +state+ - (String) - * * +instanceCount+ - (Integer) - * * +priceSchedules+ - (Array) - * * +term+ - (Integer) - * * +price+ - (Float) - * * +currencyCode+ - (String) - * * +active+ - (Boolean) - * * +tags+ - (Array) - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. - * * +clientToken+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +reservedInstancesListings+ - (Array) + * * +reservedInstancesListingId+ - (String) + * * +reservedInstancesId+ - (String) + * * +createDate+ - (Date) + * * +updateDate+ - (Date) + * * +status+ - (String) + * * +statusMessage+ - (String) + * * +instanceCounts+ - (Array) + * * +state+ - (String) + * * +instanceCount+ - (Integer) + * * +priceSchedules+ - (Array) + * * +term+ - (Integer) + * * +price+ - (Float) + * * +currencyCode+ - (String) + * * +active+ - (Boolean) + * * +tags+ - (Array) + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * * +clientToken+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method createRoute(params, options) + * @!method createRoute(params, callback) * Creates a new route in a route table within a VPC. The route's * target can be either a gateway attached to the VPC or a NAT instance * in the VPC. - * @param [Object] params + * @param params [Object] * * +routeTableId+ - (*required*, String) The ID of the * route table where the route will be added. * * +destinationCidrBlock+ - (*required*, String) The CIDR @@ -851,124 +1075,160 @@ AWS.EC2 = inherit({}) * your VPC. You must provide either GatewayId or InstanceId, but * not both. * * +networkInterfaceId+ - (String) - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method createRouteTable(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method createRouteTable(params, callback) * Creates a new route table within a VPC. After you create a new route * table, you can add routes and associate the table with a subnet. For * more information about route tables, go to Route Tables in the * Amazon Virtual Private Cloud User Guide. - * @param [Object] params + * @param params [Object] * * +vpcId+ - (*required*, String) The ID of the VPC where * the route table will be created. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +routeTable+ - (Object) - * * +routeTableId+ - (String) - * * +vpcId+ - (String) - * * +routes+ - (Array) - * * +destinationCidrBlock+ - (String) - * * +gatewayId+ - (String) - * * +instanceId+ - (String) - * * +instanceOwnerId+ - (String) - * * +networkInterfaceId+ - (String) - * * +state+ - (String) - * * +associations+ - (Array) - * * +routeTableAssociationId+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +routeTable+ - (Object) * * +routeTableId+ - (String) - * * +subnetId+ - (String) - * * +main+ - (Boolean) - * * +tags+ - (Array) - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. - * * +propagatingVgws+ - (Array) - * * +gatewayId+ - (String) - * * +propagatedRoutes+ - (Array) - * * +destinationCidrBlock+ - (String) - * * +gatewayId+ - (String) - * * +status+ - (String) - * * +sourceId+ - (String) + * * +vpcId+ - (String) + * * +routes+ - (Array) + * * +destinationCidrBlock+ - (String) + * * +gatewayId+ - (String) + * * +instanceId+ - (String) + * * +instanceOwnerId+ - (String) + * * +networkInterfaceId+ - (String) + * * +state+ - (String) + * * +associations+ - (Array) + * * +routeTableAssociationId+ - (String) + * * +routeTableId+ - (String) + * * +subnetId+ - (String) + * * +main+ - (Boolean) + * * +tags+ - (Array) + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * * +propagatingVgws+ - (Array) + * * +gatewayId+ - (String) + * * +propagatedRoutes+ - (Array) + * * +destinationCidrBlock+ - (String) + * * +gatewayId+ - (String) + * * +status+ - (String) + * * +sourceId+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method createSecurityGroup(params, options) + * @!method createSecurityGroup(params, callback) * The CreateSecurityGroup operation creates a new security group. - * @param [Object] params + * @param params [Object] * * +GroupName+ - (*required*, String) Name of the security * group. * * +Description+ - (*required*, String) Description of the * group. This is informational only. * * +VpcId+ - (String) ID of the VPC. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +groupId+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +groupId+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method createSnapshot(params, options) + * @!method createSnapshot(params, callback) * Create a snapshot of the volume identified by volume ID. A volume * does not have to be detached at the time the snapshot is taken. - * @param [Object] params + * @param params [Object] * * +VolumeId+ - (*required*, String) The ID of the volume * from which to create the snapshot. * * +Description+ - (String) The description for the new * snapshot. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Snapshot+ - (Object) The new snapshot. - * * +SnapshotId+ - (String) The unique ID of this - * snapshot. - * * +VolumeId+ - (String) The ID of the volume from which - * this snapshot was created. - * * +State+ - (String) Snapshot state (e.g., pending, - * completed, or error). - * * +StartTime+ - (Date) Time stamp when the snapshot was - * initiated. - * * +Progress+ - (String) The progress of the snapshot, - * in percentage. - * * +OwnerId+ - (String) AWS Access Key ID of the user - * who owns the snapshot. - * * +Description+ - (String) Description of the snapshot. - * * +VolumeSize+ - (Integer) The size of the volume, in - * gigabytes. - * * +ownerAlias+ - (String) The AWS account alias (e.g., - * "amazon", "redhat", "self", etc.) or AWS account ID that owns - * the AMI. - * * +tags+ - (Array) A list of tags for the - * Snapshot. - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Snapshot+ - (Object) The new snapshot. + * * +SnapshotId+ - (String) The unique ID of this + * snapshot. + * * +VolumeId+ - (String) The ID of the volume from which + * this snapshot was created. + * * +State+ - (String) Snapshot state (e.g., pending, + * completed, or error). + * * +StartTime+ - (Date) Time stamp when the snapshot was + * initiated. + * * +Progress+ - (String) The progress of the snapshot, + * in percentage. + * * +OwnerId+ - (String) AWS Access Key ID of the user + * who owns the snapshot. + * * +Description+ - (String) Description of the snapshot. + * * +VolumeSize+ - (Integer) The size of the volume, in + * gigabytes. + * * +ownerAlias+ - (String) The AWS account alias (e.g., + * "amazon", "redhat", "self", etc.) or AWS account ID that owns + * the AMI. + * * +tags+ - (Array) A list of tags for the + * Snapshot. + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method createSpotDatafeedSubscription(params, options) + * @!method createSpotDatafeedSubscription(params, callback) * Creates the data feed for Spot Instances, enabling you to view Spot * Instance usage logs. You can create one data feed per account. - * @param [Object] params + * @param params [Object] * * +bucket+ - (*required*, String) The Amazon S3 bucket in * which to store the Spot Instance datafeed. * * +prefix+ - (String) The prefix that is prepended to * datafeed files. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +spotDatafeedSubscription+ - (Object) - * * +ownerId+ - (String) Specifies the AWS account ID of - * the account. - * * +bucket+ - (String) Specifies the Amazon S3 bucket - * where the Spot Instance data feed is located. - * * +prefix+ - (String) Contains the prefix that is - * prepended to data feed files. - * * +state+ - (String) Specifies the state of the Spot - * Instance request. - * * +fault+ - (Object) Specifies a fault code for the - * Spot Instance request, if present. - * * +code+ - (String) - * * +message+ - (String) - * - * @!method createSubnet(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +spotDatafeedSubscription+ - (Object) + * * +ownerId+ - (String) Specifies the AWS account ID of + * the account. + * * +bucket+ - (String) Specifies the Amazon S3 bucket + * where the Spot Instance data feed is located. + * * +prefix+ - (String) Contains the prefix that is + * prepended to data feed files. + * * +state+ - (String) Specifies the state of the Spot + * Instance request. + * * +fault+ - (Object) Specifies a fault code for the + * Spot Instance request, if present. + * * +code+ - (String) + * * +message+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method createSubnet(params, callback) * Creates a subnet in an existing VPC. You can create up to 20 subnets * in a VPC. If you add more than one subnet to a VPC, they're set up * in a star topology with a logical router in the middle. When you @@ -981,40 +1241,47 @@ AWS.EC2 = inherit({}) * subnet (and VPC) you can create uses a /28 netmask (16 IP * addresses), and the largest uses a /18 netmask (16,384 IP * addresses). - * @param [Object] params + * @param params [Object] * * +VpcId+ - (*required*, String) The ID of the VPC to * create the subnet in. * * +CidrBlock+ - (*required*, String) The CIDR block the * subnet is to cover. * * +AvailabilityZone+ - (String) The Availability Zone to * create the subnet in. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Subnet+ - (Object) - * * +SubnetId+ - (String) Specifies the ID of the subnet. - * * +State+ - (String) Describes the current state of the - * subnet. The state of the subnet may be either pending or - * available. - * * +VpcId+ - (String) Contains the ID of the VPC the - * subnet is in. - * * +CidrBlock+ - (String) Specifies the CIDR block - * assigned to the subnet. - * * +AvailableIpAddressCount+ - (Integer) Specifies the - * number of unused IP addresses in the subnet. - * * +AvailabilityZone+ - (String) Specifies the - * Availability Zone the subnet is in. - * * +tags+ - (Array) A list of tags for the - * Subnet. - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Subnet+ - (Object) + * * +SubnetId+ - (String) Specifies the ID of the subnet. + * * +State+ - (String) Describes the current state of the + * subnet. The state of the subnet may be either pending or + * available. + * * +VpcId+ - (String) Contains the ID of the VPC the + * subnet is in. + * * +CidrBlock+ - (String) Specifies the CIDR block + * assigned to the subnet. + * * +AvailableIpAddressCount+ - (Integer) Specifies the + * number of unused IP addresses in the subnet. + * * +AvailabilityZone+ - (String) Specifies the + * Availability Zone the subnet is in. + * * +tags+ - (Array) A list of tags for the + * Subnet. + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method createTags(params, options) + * @!method createTags(params, callback) * Adds or overwrites tags for the specified resources. Each resource * can have a maximum of 10 tags. Each tag consists of a key-value * pair. Tag keys must be unique per resource. - * @param [Object] params + * @param params [Object] * * +resources+ - (*required*, Array) One or more * IDs of resources to tag. This could be the ID of an AMI, an * instance, an EBS volume, or snapshot, etc. @@ -1023,12 +1290,20 @@ AWS.EC2 = inherit({}) * a key-value pair. * * +key+ - (String) The tag's key. * * +value+ - (String) The tag's value. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method createVolume(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method createVolume(params, callback) * Initializes an empty volume of a given size. - * @param [Object] params + * @param params [Object] * * +Size+ - (Integer) The size of the volume, in * gigabytes. Required if you are not creating a volume from a * snapshot. @@ -1038,75 +1313,89 @@ AWS.EC2 = inherit({}) * Availability Zone in which to create the new volume. * * +VolumeType+ - (String) * * +Iops+ - (Integer) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Volume+ - (Object) The newly created EBS volume. - * * +VolumeId+ - (String) The unique ID of this volume. - * * +Size+ - (Integer) The size of this volume, in - * gigabytes. - * * +SnapshotId+ - (String) Optional snapshot from which - * this volume was created. - * * +AvailabilityZone+ - (String) Availability zone in - * which this volume was created. - * * +State+ - (String) State of this volume (e.g., - * creating, available). - * * +CreateTime+ - (Date) Timestamp when volume creation - * was initiated. - * * +Attachments+ - (Array) Information on what - * this volume is attached to. - * * +VolumeId+ - (String) - * * +InstanceId+ - (String) - * * +Device+ - (String) How the device is exposed to - * the instance (e.g., /dev/sdh). - * * +State+ - (String) - * * +AttachTime+ - (Date) Timestamp when this - * attachment initiated. - * * +deleteOnTermination+ - (Boolean) - * * +tags+ - (Array) A list of tags for the - * Volume. - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. - * * +volumeType+ - (String) - * * +iops+ - (Integer) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Volume+ - (Object) The newly created EBS volume. + * * +VolumeId+ - (String) The unique ID of this volume. + * * +Size+ - (Integer) The size of this volume, in + * gigabytes. + * * +SnapshotId+ - (String) Optional snapshot from which + * this volume was created. + * * +AvailabilityZone+ - (String) Availability zone in + * which this volume was created. + * * +State+ - (String) State of this volume (e.g., + * creating, available). + * * +CreateTime+ - (Date) Timestamp when volume creation + * was initiated. + * * +Attachments+ - (Array) Information on what + * this volume is attached to. + * * +VolumeId+ - (String) + * * +InstanceId+ - (String) + * * +Device+ - (String) How the device is exposed to + * the instance (e.g., /dev/sdh). + * * +State+ - (String) + * * +AttachTime+ - (Date) Timestamp when this + * attachment initiated. + * * +deleteOnTermination+ - (Boolean) + * * +tags+ - (Array) A list of tags for the + * Volume. + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * * +volumeType+ - (String) + * * +iops+ - (Integer) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method createVpc(params, options) + * @!method createVpc(params, callback) * Creates a VPC with the CIDR block you specify. The smallest VPC you * can create uses a /28 netmask (16 IP addresses), and the largest * uses a /18 netmask (16,384 IP addresses). To help you decide how big * to make your VPC, go to the topic about creating VPCs in the Amazon * Virtual Private Cloud Developer Guide. - * @param [Object] params + * @param params [Object] * * +CidrBlock+ - (*required*, String) A valid CIDR block. * * +instanceTenancy+ - (String) The allowed tenancy of * instances launched into the VPC. A value of default means * instances can be launched with any tenancy; a value of dedicated * means instances must be launched with tenancy as dedicated. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Vpc+ - (Object) Information about the VPC. - * * +VpcId+ - (String) Specifies the ID of the VPC. - * * +State+ - (String) Describes the current state of the - * VPC. The state of the subnet may be either pending or - * available. - * * +CidrBlock+ - (String) Specifies the CIDR block the - * VPC covers. - * * +DhcpOptionsId+ - (String) Specifies the ID of the - * set of DHCP options associated with the VPC. Contains a value - * of default if the default options are associated with the VPC. - * * +tags+ - (Array) A list of tags for the VPC. - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. - * * +instanceTenancy+ - (String) The allowed tenancy of - * instances launched into the VPC. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Vpc+ - (Object) Information about the VPC. + * * +VpcId+ - (String) Specifies the ID of the VPC. + * * +State+ - (String) Describes the current state of the + * VPC. The state of the subnet may be either pending or + * available. + * * +CidrBlock+ - (String) Specifies the CIDR block the + * VPC covers. + * * +DhcpOptionsId+ - (String) Specifies the ID of the + * set of DHCP options associated with the VPC. Contains a value + * of default if the default options are associated with the VPC. + * * +tags+ - (Array) A list of tags for the VPC. + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * * +instanceTenancy+ - (String) The allowed tenancy of + * instances launched into the VPC. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method createVpnConnection(params, options) + * @!method createVpnConnection(params, callback) * Creates a new VPN connection between an existing VPN gateway and * customer gateway. The only supported connection type is ipsec.1. - * @param [Object] params + * @param params [Object] * * +Type+ - (*required*, String) The type of VPN * connection. * * +CustomerGatewayId+ - (*required*, String) The ID of @@ -1115,234 +1404,376 @@ AWS.EC2 = inherit({}) * gateway. * * +options+ - (Object) * * +staticRoutesOnly+ - (Boolean) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +VpnConnection+ - (Object) - * * +VpnConnectionId+ - (String) Specifies the ID of the - * VPN gateway at the VPC end of the VPN connection. - * * +State+ - (String) Describes the current state of the - * VPN connection. Valid values are pending, available, deleting, - * and deleted. - * * +CustomerGatewayConfiguration+ - (String) Contains - * configuration information in the native XML format for the VPN - * connection's customer gateway. - * * +Type+ - (String) Specifies the type of VPN - * connection. - * * +CustomerGatewayId+ - (String) Specifies ID of the - * customer gateway at the end of the VPN connection. - * * +VpnGatewayId+ - (String) Specfies the ID of the VPN - * gateway at the VPC end of the VPN connection. - * * +tags+ - (Array) A list of tags for the - * VpnConnection. - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. - * * +vgwTelemetry+ - (Array) - * * +outsideIpAddress+ - (String) - * * +status+ - (String) - * * +lastStatusChange+ - (Date) - * * +statusMessage+ - (String) - * * +acceptedRouteCount+ - (Integer) - * * +options+ - (Object) - * * +staticRoutesOnly+ - (Boolean) - * * +routes+ - (Array) - * * +destinationCidrBlock+ - (String) - * * +source+ - (String) - * * +state+ - (String) - * - * @!method createVpnConnectionRoute(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +VpnConnection+ - (Object) + * * +VpnConnectionId+ - (String) Specifies the ID of the + * VPN gateway at the VPC end of the VPN connection. + * * +State+ - (String) Describes the current state of the + * VPN connection. Valid values are pending, available, deleting, + * and deleted. + * * +CustomerGatewayConfiguration+ - (String) Contains + * configuration information in the native XML format for the VPN + * connection's customer gateway. + * * +Type+ - (String) Specifies the type of VPN + * connection. + * * +CustomerGatewayId+ - (String) Specifies ID of the + * customer gateway at the end of the VPN connection. + * * +VpnGatewayId+ - (String) Specfies the ID of the VPN + * gateway at the VPC end of the VPN connection. + * * +tags+ - (Array) A list of tags for the + * VpnConnection. + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * * +vgwTelemetry+ - (Array) + * * +outsideIpAddress+ - (String) + * * +status+ - (String) + * * +lastStatusChange+ - (Date) + * * +statusMessage+ - (String) + * * +acceptedRouteCount+ - (Integer) + * * +options+ - (Object) + * * +staticRoutesOnly+ - (Boolean) + * * +routes+ - (Array) + * * +destinationCidrBlock+ - (String) + * * +source+ - (String) + * * +state+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method createVpnConnectionRoute(params, callback) * Calls the CreateVpnConnectionRoute API operation. - * @param [Object] params + * @param params [Object] * * +VpnConnectionId+ - (*required*, String) * * +DestinationCidrBlock+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method createVpnGateway(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method createVpnGateway(params, callback) * Creates a new VPN gateway. A VPN gateway is the VPC-side endpoint * for your VPN connection. You can create a VPN gateway before * creating the VPC itself. - * @param [Object] params + * @param params [Object] * * +Type+ - (*required*, String) The type of VPN * connection this VPN gateway supports. * * +AvailabilityZone+ - (String) The Availability Zone in * which to create the VPN gateway. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +VpnGateway+ - (Object) - * * +VpnGatewayId+ - (String) Specifies the ID of the VPN - * gateway. - * * +State+ - (String) Describes the current state of the - * VPN gateway. Valid values are pending, available, deleting, - * and deleted. - * * +Type+ - (String) Specifies the type of VPN - * connection the VPN gateway supports. - * * +AvailabilityZone+ - (String) Specifies the - * Availability Zone where the VPN gateway was created. - * * +VpcAttachments+ - (Array) Contains - * information about the VPCs attached to the VPN gateway. - * * +VpcId+ - (String) - * * +State+ - (String) - * * +tags+ - (Array) A list of tags for the - * VpnGateway. - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +VpnGateway+ - (Object) + * * +VpnGatewayId+ - (String) Specifies the ID of the VPN + * gateway. + * * +State+ - (String) Describes the current state of the + * VPN gateway. Valid values are pending, available, deleting, + * and deleted. + * * +Type+ - (String) Specifies the type of VPN + * connection the VPN gateway supports. + * * +AvailabilityZone+ - (String) Specifies the + * Availability Zone where the VPN gateway was created. + * * +VpcAttachments+ - (Array) Contains + * information about the VPCs attached to the VPN gateway. + * * +VpcId+ - (String) + * * +State+ - (String) + * * +tags+ - (Array) A list of tags for the + * VpnGateway. + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method deactivateLicense(params, options) + * @!method deactivateLicense(params, callback) * Deactivates a specific number of licenses. Deactivations can be done * against a specific license ID after they have persisted for at least * a 90-day period. - * @param [Object] params + * @param params [Object] * * +licenseId+ - (*required*, String) Specifies the ID for * the specific license to deactivate against. * * +capacity+ - (*required*, Integer) Specifies the amount * of capacity to deactivate against the license. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method deleteCustomerGateway(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method deleteCustomerGateway(params, callback) * Deletes a customer gateway. You must delete the VPN connection * before deleting the customer gateway. - * @param [Object] params + * @param params [Object] * * +CustomerGatewayId+ - (*required*, String) The ID of * the customer gateway to delete. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method deleteDhcpOptions(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method deleteDhcpOptions(params, callback) * Deletes a set of DHCP options that you specify. Amazon VPC returns * an error if the set of options you specify is currently associated * with a VPC. You can disassociate the set of options by associating * either a new set of options or the default options with the VPC. - * @param [Object] params + * @param params [Object] * * +DhcpOptionsId+ - (*required*, String) The ID of the * DHCP options set to delete. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method deleteInternetGateway(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method deleteInternetGateway(params, callback) * Deletes an Internet gateway from your AWS account. The gateway must * not be attached to a VPC. For more information about your VPC and * Internet gateway, go to Amazon Virtual Private Cloud User Guide. - * @param [Object] params + * @param params [Object] * * +internetGatewayId+ - (*required*, String) The ID of * the Internet gateway to be deleted. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method deleteKeyPair(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method deleteKeyPair(params, callback) * The DeleteKeyPair operation deletes a key pair. - * @param [Object] params + * @param params [Object] * * +KeyName+ - (*required*, String) The name of the Amazon * EC2 key pair to delete. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method deleteNetworkAcl(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method deleteNetworkAcl(params, callback) * Deletes a network ACL from a VPC. The ACL must not have any subnets * associated with it. You can't delete the default network ACL. For * more information about network ACLs, go to Network ACLs in the * Amazon Virtual Private Cloud User Guide. - * @param [Object] params + * @param params [Object] * * +networkAclId+ - (*required*, String) The ID of the * network ACL to be deleted. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method deleteNetworkAclEntry(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method deleteNetworkAclEntry(params, callback) * Deletes an ingress or egress entry (i.e., rule) from a network ACL. * For more information about network ACLs, go to Network ACLs in the * Amazon Virtual Private Cloud User Guide. - * @param [Object] params + * @param params [Object] * * +networkAclId+ - (*required*, String) ID of the network * ACL. * * +ruleNumber+ - (*required*, Integer) Rule number for * the entry to delete. * * +egress+ - (*required*, Boolean) Whether the rule to * delete is an egress rule (true) or ingress rule (false). - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method deleteNetworkInterface(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method deleteNetworkInterface(params, callback) * Calls the DeleteNetworkInterface API operation. - * @param [Object] params + * @param params [Object] * * +networkInterfaceId+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method deletePlacementGroup(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method deletePlacementGroup(params, callback) * Deletes a PlacementGroup from a user's account. Terminate all Amazon * EC2 instances in the placement group before deletion. - * @param [Object] params + * @param params [Object] * * +groupName+ - (*required*, String) The name of the * PlacementGroup to delete. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method deleteRoute(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method deleteRoute(params, callback) * Deletes a route from a route table in a VPC. For more information * about route tables, go to Route Tables in the Amazon Virtual Private * Cloud User Guide. - * @param [Object] params + * @param params [Object] * * +routeTableId+ - (*required*, String) The ID of the * route table where the route will be deleted. * * +destinationCidrBlock+ - (*required*, String) The CIDR * range for the route you want to delete. The value you specify * must exactly match the CIDR for the route you want to delete. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method deleteRouteTable(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method deleteRouteTable(params, callback) * Deletes a route table from a VPC. The route table must not be * associated with a subnet. You can't delete the main route table. For * more information about route tables, go to Route Tables in the * Amazon Virtual Private Cloud User Guide. - * @param [Object] params + * @param params [Object] * * +routeTableId+ - (*required*, String) The ID of the * route table to be deleted. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method deleteSecurityGroup(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method deleteSecurityGroup(params, callback) * The DeleteSecurityGroup operation deletes a security group. - * @param [Object] params + * @param params [Object] * * +GroupName+ - (String) The name of the Amazon EC2 * security group to delete. * * +GroupId+ - (String) The ID of the Amazon EC2 security * group to delete. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method deleteSnapshot(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method deleteSnapshot(params, callback) * Deletes the snapshot identified by snapshotId. - * @param [Object] params + * @param params [Object] * * +SnapshotId+ - (*required*, String) The ID of the * snapshot to delete. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method deleteSpotDatafeedSubscription(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method deleteSpotDatafeedSubscription(params, callback) * Deletes the data feed for Spot Instances. - * @param [Object] params - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method deleteSubnet(params, options) + * @param params [Object] + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method deleteSubnet(params, callback) * Deletes a subnet from a VPC. You must terminate all running * instances in the subnet before deleting it, otherwise Amazon VPC * returns an error. - * @param [Object] params + * @param params [Object] * * +SubnetId+ - (*required*, String) The ID of the subnet * you want to delete. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method deleteTags(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method deleteTags(params, callback) * Deletes tags from the specified Amazon EC2 resources. - * @param [Object] params + * @param params [Object] * * +resources+ - (*required*, Array) A list of one * or more resource IDs. This could be the ID of an AMI, an * instance, an EBS volume, or snapshot, etc. @@ -1350,31 +1781,55 @@ AWS.EC2 = inherit({}) * specified resources. Each tag item consists of a key-value pair. * * +key+ - (String) The tag's key. * * +value+ - (String) The tag's value. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method deleteVolume(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method deleteVolume(params, callback) * Deletes a previously created volume. Once successfully deleted, a * new volume can be created with the same name. - * @param [Object] params + * @param params [Object] * * +VolumeId+ - (*required*, String) The ID of the EBS * volume to delete. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method deleteVpc(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method deleteVpc(params, callback) * Deletes a VPC. You must detach or delete all gateways or other * objects that are dependent on the VPC first. For example, you must * terminate all running instances, delete all VPC security groups * (except the default), delete all the route tables (except the * default), etc. - * @param [Object] params + * @param params [Object] * * +VpcId+ - (*required*, String) The ID of the VPC you * want to delete. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method deleteVpnConnection(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method deleteVpnConnection(params, callback) * Deletes a VPN connection. Use this if you want to delete a VPC and * all its associated components. Another reason to use this operation * is if you believe the tunnel credentials for your VPN connection @@ -1383,46 +1838,78 @@ AWS.EC2 = inherit({}) * to delete the VPC or VPN gateway. If you create a new VPN * connection, you must reconfigure the customer gateway using the new * configuration information returned with the new VPN connection ID. - * @param [Object] params + * @param params [Object] * * +VpnConnectionId+ - (*required*, String) The ID of the * VPN connection to delete - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method deleteVpnConnectionRoute(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method deleteVpnConnectionRoute(params, callback) * Calls the DeleteVpnConnectionRoute API operation. - * @param [Object] params + * @param params [Object] * * +VpnConnectionId+ - (*required*, String) * * +DestinationCidrBlock+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method deleteVpnGateway(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method deleteVpnGateway(params, callback) * Deletes a VPN gateway. Use this when you want to delete a VPC and * all its associated components because you no longer need them. We * recommend that before you delete a VPN gateway, you detach it from * the VPC and delete the VPN connection. Note that you don't need to * delete the VPN gateway if you just want to delete and re-create the * VPN connection between your VPC and data center. - * @param [Object] params + * @param params [Object] * * +VpnGatewayId+ - (*required*, String) The ID of the VPN * gateway to delete. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method deregisterImage(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method deregisterImage(params, callback) * The DeregisterImage operation deregisters an AMI. Once deregistered, * instances of the AMI can no longer be launched. - * @param [Object] params + * @param params [Object] * * +ImageId+ - (*required*, String) The ID of the AMI to * deregister. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method describeAddresses(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method describeAddresses(params, callback) * The DescribeAddresses operation lists elastic IP addresses assigned * to your account. - * @param [Object] params + * @param params [Object] * * +PublicIps+ - (Array) The optional list of * Elastic IP addresses to describe. * * +filters+ - (Array) A list of filters used to @@ -1433,24 +1920,31 @@ AWS.EC2 = inherit({}) * * +Values+ - (Array) Contains one or more * values for the filter. * * +allocationIds+ - (Array) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Addresses+ - (Array) The list of Elastic IPs. - * * +InstanceId+ - (String) - * * +PublicIp+ - (String) - * * +allocationId+ - (String) - * * +associationId+ - (String) - * * +domain+ - (String) - * * +networkInterfaceId+ - (String) - * * +networkInterfaceOwnerId+ - (String) - * * +privateIpAddress+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Addresses+ - (Array) The list of Elastic IPs. + * * +InstanceId+ - (String) + * * +PublicIp+ - (String) + * * +allocationId+ - (String) + * * +associationId+ - (String) + * * +domain+ - (String) + * * +networkInterfaceId+ - (String) + * * +networkInterfaceOwnerId+ - (String) + * * +privateIpAddress+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method describeAvailabilityZones(params, options) + * @!method describeAvailabilityZones(params, callback) * The DescribeAvailabilityZones operation describes availability zones * that are currently available to the account and their states. - * @param [Object] params + * @param params [Object] * * +ZoneNames+ - (Array) A list of the * availability zone names to describe. * * +filters+ - (Array) A list of filters used to @@ -1460,26 +1954,33 @@ AWS.EC2 = inherit({}) * * +Name+ - (String) Specifies the name of the filter. * * +Values+ - (Array) Contains one or more * values for the filter. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +AvailabilityZones+ - (Array) The list of - * described Amazon EC2 availability zones. - * * +zoneName+ - (String) Name of the Availability Zone. - * * +State+ - (String) State of the Availability Zone. - * * +regionName+ - (String) Name of the region in which - * this zone resides. - * * +messages+ - (Array) A list of messages about - * the Availability Zone. - * * +message+ - (String) - * - * @!method describeBundleTasks(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +AvailabilityZones+ - (Array) The list of + * described Amazon EC2 availability zones. + * * +zoneName+ - (String) Name of the Availability Zone. + * * +State+ - (String) State of the Availability Zone. + * * +regionName+ - (String) Name of the region in which + * this zone resides. + * * +messages+ - (Array) A list of messages about + * the Availability Zone. + * * +message+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method describeBundleTasks(params, callback) * The DescribeBundleTasks operation describes in-progress and recent * bundle tasks. Complete and failed tasks are removed from the list a * short time after completion. If no bundle ids are given, all bundle * tasks are returned. - * @param [Object] params + * @param params [Object] * * +BundleIds+ - (Array) The list of bundle task * IDs to describe. * * +filters+ - (Array) A list of filters used to @@ -1489,61 +1990,91 @@ AWS.EC2 = inherit({}) * * +Name+ - (String) Specifies the name of the filter. * * +Values+ - (Array) Contains one or more * values for the filter. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +BundleTasks+ - (Array) The list of described - * bundle tasks. - * * +InstanceId+ - (String) Instance associated with this - * bundle task. - * * +BundleId+ - (String) Unique identifier for this - * task. - * * +State+ - (String) The state of this task. - * * +StartTime+ - (Date) The time this task started. - * * +UpdateTime+ - (Date) The time of the most recent - * update for the task. - * * +Storage+ - (Object) Amazon S3 storage locations. - * * +S3+ - (Object) The details of S3 storage for - * bundling a Windows instance. - * * +Bucket+ - (String) The bucket in which to store - * the AMI. You can specify a bucket that you already own or - * a new bucket that Amazon EC2 creates on your behalf. - * * +Prefix+ - (String) The prefix to use when - * storing the AMI in S3. - * * +AWSAccessKeyId+ - (String) The Access Key ID of - * the owner of the Amazon S3 bucket. - * * +UploadPolicy+ - (String) A Base64-encoded Amazon - * S3 upload policy that gives Amazon EC2 permission to - * upload items into Amazon S3 on the user's behalf. - * * +UploadPolicySignature+ - (String) The signature - * of the Base64 encoded JSON document. - * * +Progress+ - (String) The level of task completion, - * in percent (e.g., 20%). - * * +BundleTaskError+ - (Object) If the task fails, a - * description of the error. - * * +Code+ - (String) Error code. - * * +Message+ - (String) Error message. - * - * @!method describeConversionTasks(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +BundleTasks+ - (Array) The list of described + * bundle tasks. + * * +InstanceId+ - (String) Instance associated with this + * bundle task. + * * +BundleId+ - (String) Unique identifier for this + * task. + * * +State+ - (String) The state of this task. + * * +StartTime+ - (Date) The time this task started. + * * +UpdateTime+ - (Date) The time of the most recent + * update for the task. + * * +Storage+ - (Object) Amazon S3 storage locations. + * * +S3+ - (Object) The details of S3 storage for + * bundling a Windows instance. + * * +Bucket+ - (String) The bucket in which to store + * the AMI. You can specify a bucket that you already own or + * a new bucket that Amazon EC2 creates on your behalf. + * * +Prefix+ - (String) The prefix to use when + * storing the AMI in S3. + * * +AWSAccessKeyId+ - (String) The Access Key ID of + * the owner of the Amazon S3 bucket. + * * +UploadPolicy+ - (String) A Base64-encoded Amazon + * S3 upload policy that gives Amazon EC2 permission to + * upload items into Amazon S3 on the user's behalf. + * * +UploadPolicySignature+ - (String) The signature + * of the Base64 encoded JSON document. + * * +Progress+ - (String) The level of task completion, + * in percent (e.g., 20%). + * * +BundleTaskError+ - (Object) If the task fails, a + * description of the error. + * * +Code+ - (String) Error code. + * * +Message+ - (String) Error message. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method describeConversionTasks(params, callback) * Calls the DescribeConversionTasks API operation. - * @param [Object] params + * @param params [Object] * * +filters+ - (Array) * * +Name+ - (String) Specifies the name of the filter. * * +Values+ - (Array) Contains one or more * values for the filter. * * +conversionTaskIds+ - (Array) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +conversionTasks+ - (Array) - * * +conversionTaskId+ - (String) - * * +expirationTime+ - (String) - * * +importInstance+ - (Object) - * * +volumes+ - (Array) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +conversionTasks+ - (Array) + * * +conversionTaskId+ - (String) + * * +expirationTime+ - (String) + * * +importInstance+ - (Object) + * * +volumes+ - (Array) + * * +bytesConverted+ - (Integer) + * * +availabilityZone+ - (String) + * * +image+ - (Object) + * * +format+ - (String) + * * +size+ - (Integer) + * * +importManifestUrl+ - (String) + * * +checksum+ - (String) + * * +volume+ - (Object) + * * +size+ - (Integer) + * * +id+ - (String) + * * +status+ - (String) + * * +statusMessage+ - (String) + * * +description+ - (String) + * * +instanceId+ - (String) + * * +platform+ - (String) + * * +description+ - (String) + * * +importVolume+ - (Object) * * +bytesConverted+ - (Integer) * * +availabilityZone+ - (String) + * * +description+ - (String) * * +image+ - (Object) * * +format+ - (String) * * +size+ - (Integer) @@ -1552,31 +2083,15 @@ AWS.EC2 = inherit({}) * * +volume+ - (Object) * * +size+ - (Integer) * * +id+ - (String) - * * +status+ - (String) - * * +statusMessage+ - (String) - * * +description+ - (String) - * * +instanceId+ - (String) - * * +platform+ - (String) - * * +description+ - (String) - * * +importVolume+ - (Object) - * * +bytesConverted+ - (Integer) - * * +availabilityZone+ - (String) - * * +description+ - (String) - * * +image+ - (Object) - * * +format+ - (String) - * * +size+ - (Integer) - * * +importManifestUrl+ - (String) - * * +checksum+ - (String) - * * +volume+ - (Object) - * * +size+ - (Integer) - * * +id+ - (String) - * * +state+ - (String) - * * +statusMessage+ - (String) - * * +tags+ - (Array) - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. + * * +state+ - (String) + * * +statusMessage+ - (String) + * * +tags+ - (Array) + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method describeCustomerGateways(params, options) + * @!method describeCustomerGateways(params, callback) * Gives you information about your customer gateways. You can filter * the results to return information only about customer gateways that * match criteria you specify. For example, you could ask to get @@ -1589,7 +2104,7 @@ AWS.EC2 = inherit({}) * filters. If there's no match, no special message is returned; the * response is simply empty. The following table shows the available * filters. - * @param [Object] params + * @param params [Object] * * +CustomerGatewayIds+ - (Array) A set of one or * more customer gateway IDs. * * +Filters+ - (Array) A list of filters used to @@ -1599,33 +2114,40 @@ AWS.EC2 = inherit({}) * * +Name+ - (String) Specifies the name of the filter. * * +Values+ - (Array) Contains one or more * values for the filter. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +CustomerGateways+ - (Array) - * * +CustomerGatewayId+ - (String) Specifies the ID of - * the customer gateway. - * * +State+ - (String) Describes the current state of the - * customer gateway. Valid values are pending, available, - * deleting, and deleted. - * * +Type+ - (String) Specifies the type of VPN - * connection the customer gateway supports. - * * +IpAddress+ - (String) Contains the Internet-routable - * IP address of the customer gateway's outside interface. - * * +BgpAsn+ - (String) Specifies the customer gateway's - * Border Gateway Protocol (BGP) Autonomous System Number (ASN). - * * +tags+ - (Array) A list of tags for the - * CustomerGateway. - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +CustomerGateways+ - (Array) + * * +CustomerGatewayId+ - (String) Specifies the ID of + * the customer gateway. + * * +State+ - (String) Describes the current state of the + * customer gateway. Valid values are pending, available, + * deleting, and deleted. + * * +Type+ - (String) Specifies the type of VPN + * connection the customer gateway supports. + * * +IpAddress+ - (String) Contains the Internet-routable + * IP address of the customer gateway's outside interface. + * * +BgpAsn+ - (String) Specifies the customer gateway's + * Border Gateway Protocol (BGP) Autonomous System Number (ASN). + * * +tags+ - (Array) A list of tags for the + * CustomerGateway. + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method describeDhcpOptions(params, options) + * @!method describeDhcpOptions(params, callback) * Gives you information about one or more sets of DHCP options. You * can specify one or more DHCP options set IDs, or no IDs (to describe * all your sets of DHCP options). The returned information consists * of: - * @param [Object] params + * @param params [Object] * * +DhcpOptionsIds+ - (Array) * * +filters+ - (Array) A list of filters used to * match properties for DhcpOptions. For a complete reference to @@ -1634,103 +2156,124 @@ AWS.EC2 = inherit({}) * * +Name+ - (String) Specifies the name of the filter. * * +Values+ - (Array) Contains one or more * values for the filter. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +DhcpOptions+ - (Array) - * * +DhcpOptionsId+ - (String) Specifies the ID of the - * set of DHCP options. - * * +DhcpConfigurations+ - (Array) Contains - * information about the set of DHCP options. - * * +Key+ - (String) Contains the name of a DHCP - * option. - * * +Values+ - (Array) Contains a set of values - * for a DHCP option. - * * +tags+ - (Array) A list of tags for the - * DhcpOptions. - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +DhcpOptions+ - (Array) + * * +DhcpOptionsId+ - (String) Specifies the ID of the + * set of DHCP options. + * * +DhcpConfigurations+ - (Array) Contains + * information about the set of DHCP options. + * * +Key+ - (String) Contains the name of a DHCP + * option. + * * +Values+ - (Array) Contains a set of values + * for a DHCP option. + * * +tags+ - (Array) A list of tags for the + * DhcpOptions. + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method describeExportTasks(params, options) + * @!method describeExportTasks(params, callback) * Calls the DescribeExportTasks API operation. - * @param [Object] params + * @param params [Object] * * +exportTaskIds+ - (Array) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +exportTasks+ - (Array) - * * +exportTaskId+ - (String) - * * +description+ - (String) - * * +state+ - (String) - * * +statusMessage+ - (String) - * * +instanceExportDetails+ - (Object) - * * +instanceId+ - (String) - * * +targetEnvironment+ - (String) - * * +exportToS3Task+ - (Object) - * * +diskImageFormat+ - (String) - * * +containerFormat+ - (String) - * * +s3Bucket+ - (String) - * * +s3Key+ - (String) - * - * @!method describeImageAttribute(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +exportTasks+ - (Array) + * * +exportTaskId+ - (String) + * * +description+ - (String) + * * +state+ - (String) + * * +statusMessage+ - (String) + * * +instanceExportDetails+ - (Object) + * * +instanceId+ - (String) + * * +targetEnvironment+ - (String) + * * +exportToS3Task+ - (Object) + * * +diskImageFormat+ - (String) + * * +containerFormat+ - (String) + * * +s3Bucket+ - (String) + * * +s3Key+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method describeImageAttribute(params, callback) * The DescribeImageAttribute operation returns information about an * attribute of an AMI. Only one attribute can be specified per call. - * @param [Object] params + * @param params [Object] * * +ImageId+ - (*required*, String) The ID of the AMI * whose attribute is to be described. * * +Attribute+ - (*required*, String) The name of the * attribute to describe. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +ImageAttribute+ - (Object) The described image - * attribute of the associated AMI. - * * +ImageId+ - (String) The ID of the associated AMI. - * * +LaunchPermissions+ - (Array) Launch - * permissions for the associated AMI. - * * +UserId+ - (String) The AWS user ID of the user - * involved in this launch permission. - * * +Group+ - (String) The AWS group of the user - * involved in this launch permission. - * * +ProductCodes+ - (Array) Product codes for - * the associated AMI. - * * +ProductCodeId+ - (String) The unique ID of an AWS - * DevPay product code. - * * +ProductCodeType+ - (String) - * * +kernelId+ - (Object) Kernel ID of the associated - * AMI. - * * +value+ - (String) - * * +ramdiskId+ - (Object) Ramdisk ID of the associated - * AMI. - * * +value+ - (String) - * * +description+ - (Object) User-created description of - * the associated AMI. - * * +value+ - (String) - * * +BlockDeviceMappings+ - (Array) Block device - * mappings for the associated AMI. - * * +VirtualName+ - (String) Specifies the virtual - * device name. - * * +DeviceName+ - (String) Specifies the device name - * (e.g., /dev/sdh). - * * +ebs+ - (Object) Specifies parameters used to - * automatically setup Amazon EBS volumes when the instance is - * launched. - * * +snapshotId+ - (String) The ID of the snapshot - * from which the volume will be created. - * * +volumeSize+ - (Integer) The size of the volume, - * in gigabytes. - * * +deleteOnTermination+ - (Boolean) Specifies - * whether the Amazon EBS volume is deleted on instance - * termination. - * * +volumeType+ - (String) - * * +iops+ - (Integer) - * * +noDevice+ - (String) Specifies the device name to - * suppress during instance launch. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +ImageAttribute+ - (Object) The described image + * attribute of the associated AMI. + * * +ImageId+ - (String) The ID of the associated AMI. + * * +LaunchPermissions+ - (Array) Launch + * permissions for the associated AMI. + * * +UserId+ - (String) The AWS user ID of the user + * involved in this launch permission. + * * +Group+ - (String) The AWS group of the user + * involved in this launch permission. + * * +ProductCodes+ - (Array) Product codes for + * the associated AMI. + * * +ProductCodeId+ - (String) The unique ID of an AWS + * DevPay product code. + * * +ProductCodeType+ - (String) + * * +kernelId+ - (Object) Kernel ID of the associated + * AMI. + * * +value+ - (String) + * * +ramdiskId+ - (Object) Ramdisk ID of the associated + * AMI. + * * +value+ - (String) + * * +description+ - (Object) User-created description of + * the associated AMI. + * * +value+ - (String) + * * +BlockDeviceMappings+ - (Array) Block device + * mappings for the associated AMI. + * * +VirtualName+ - (String) Specifies the virtual + * device name. + * * +DeviceName+ - (String) Specifies the device name + * (e.g., /dev/sdh). + * * +ebs+ - (Object) Specifies parameters used to + * automatically setup Amazon EBS volumes when the instance is + * launched. + * * +snapshotId+ - (String) The ID of the snapshot + * from which the volume will be created. + * * +volumeSize+ - (Integer) The size of the volume, + * in gigabytes. + * * +deleteOnTermination+ - (Boolean) Specifies + * whether the Amazon EBS volume is deleted on instance + * termination. + * * +volumeType+ - (String) + * * +iops+ - (Integer) + * * +noDevice+ - (String) Specifies the device name to + * suppress during instance launch. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method describeImages(params, options) + * @!method describeImages(params, callback) * The DescribeImages operation returns information about AMIs, AKIs, * and ARIs available to the user. Information returned includes image * type, product codes, architecture, and kernel and RAM disk IDs. @@ -1738,7 +2281,7 @@ AWS.EC2 = inherit({}) * user to launch, private images owned by the user making the request, * and private images owned by other users for which the user has * explicit launch permissions. - * @param [Object] params + * @param params [Object] * * +ImageIds+ - (Array) An optional list of the * AMI IDs to describe. If not specified, all AMIs will be * described. @@ -1760,148 +2303,162 @@ AWS.EC2 = inherit({}) * * +Name+ - (String) Specifies the name of the filter. * * +Values+ - (Array) Contains one or more * values for the filter. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Images+ - (Array) The list of the described - * AMIs. - * * +ImageId+ - (String) The unique ID of the AMI. - * * +ImageLocation+ - (String) The location of the AMI. - * * +State+ - (String) Current state of the AMI. If the - * operation returns available, the image is successfully - * registered and available for launching. If the operation - * returns deregistered, the image is deregistered and no longer - * available for launching. - * * +OwnerId+ - (String) AWS Access Key ID of the image - * owner. - * * +Public+ - (Boolean) True if this image has public - * launch permissions. False if it only has implicit and explicit - * launch permissions. - * * +ProductCodes+ - (Array) Product codes of the - * AMI. - * * +ProductCodeId+ - (String) The unique ID of an AWS - * DevPay product code. - * * +ProductCodeType+ - (String) - * * +Architecture+ - (String) The architecture of the - * image. - * * +ImageType+ - (String) The type of image (machine, - * kernel, or ramdisk). - * * +KernelId+ - (String) The kernel associated with the - * image, if any. Only applicable for machine images. - * * +RamdiskId+ - (String) The RAM disk associated with - * the image, if any. Only applicable for machine images. - * * +Platform+ - (String) The operating platform of the - * AMI. - * * +stateReason+ - (Object) The reason for the state - * change. - * * +code+ - (String) Reason code for the state change. - * * +message+ - (String) Descriptive message for the - * state change. - * * +imageOwnerAlias+ - (String) The AWS account alias - * (e.g., "amazon", "redhat", "self", etc.) or AWS account ID - * that owns the AMI. - * * +name+ - (String) The name of the AMI that was - * provided during image creation. - * * +description+ - (String) The description of the AMI - * that was provided during image creation. - * * +rootDeviceType+ - (String) The root device type used - * by the AMI. The AMI can use an Amazon EBS or instance store - * root device. - * * +rootDeviceName+ - (String) The root device name - * (e.g., /dev/sda1). - * * +blockDeviceMappings+ - (Array) Specifies how - * block devices are exposed to the instance. - * * +VirtualName+ - (String) Specifies the virtual - * device name. - * * +DeviceName+ - (String) Specifies the device name - * (e.g., /dev/sdh). - * * +ebs+ - (Object) Specifies parameters used to - * automatically setup Amazon EBS volumes when the instance is - * launched. - * * +snapshotId+ - (String) The ID of the snapshot - * from which the volume will be created. - * * +volumeSize+ - (Integer) The size of the volume, - * in gigabytes. - * * +deleteOnTermination+ - (Boolean) Specifies - * whether the Amazon EBS volume is deleted on instance - * termination. - * * +volumeType+ - (String) - * * +iops+ - (Integer) - * * +noDevice+ - (String) Specifies the device name to - * suppress during instance launch. - * * +virtualizationType+ - (String) - * * +tags+ - (Array) A list of tags for the - * Image. - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. - * * +hypervisor+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Images+ - (Array) The list of the described + * AMIs. + * * +ImageId+ - (String) The unique ID of the AMI. + * * +ImageLocation+ - (String) The location of the AMI. + * * +State+ - (String) Current state of the AMI. If the + * operation returns available, the image is successfully + * registered and available for launching. If the operation + * returns deregistered, the image is deregistered and no longer + * available for launching. + * * +OwnerId+ - (String) AWS Access Key ID of the image + * owner. + * * +Public+ - (Boolean) True if this image has public + * launch permissions. False if it only has implicit and explicit + * launch permissions. + * * +ProductCodes+ - (Array) Product codes of the + * AMI. + * * +ProductCodeId+ - (String) The unique ID of an AWS + * DevPay product code. + * * +ProductCodeType+ - (String) + * * +Architecture+ - (String) The architecture of the + * image. + * * +ImageType+ - (String) The type of image (machine, + * kernel, or ramdisk). + * * +KernelId+ - (String) The kernel associated with the + * image, if any. Only applicable for machine images. + * * +RamdiskId+ - (String) The RAM disk associated with + * the image, if any. Only applicable for machine images. + * * +Platform+ - (String) The operating platform of the + * AMI. + * * +stateReason+ - (Object) The reason for the state + * change. + * * +code+ - (String) Reason code for the state change. + * * +message+ - (String) Descriptive message for the + * state change. + * * +imageOwnerAlias+ - (String) The AWS account alias + * (e.g., "amazon", "redhat", "self", etc.) or AWS account ID + * that owns the AMI. + * * +name+ - (String) The name of the AMI that was + * provided during image creation. + * * +description+ - (String) The description of the AMI + * that was provided during image creation. + * * +rootDeviceType+ - (String) The root device type used + * by the AMI. The AMI can use an Amazon EBS or instance store + * root device. + * * +rootDeviceName+ - (String) The root device name + * (e.g., /dev/sda1). + * * +blockDeviceMappings+ - (Array) Specifies how + * block devices are exposed to the instance. + * * +VirtualName+ - (String) Specifies the virtual + * device name. + * * +DeviceName+ - (String) Specifies the device name + * (e.g., /dev/sdh). + * * +ebs+ - (Object) Specifies parameters used to + * automatically setup Amazon EBS volumes when the instance is + * launched. + * * +snapshotId+ - (String) The ID of the snapshot + * from which the volume will be created. + * * +volumeSize+ - (Integer) The size of the volume, + * in gigabytes. + * * +deleteOnTermination+ - (Boolean) Specifies + * whether the Amazon EBS volume is deleted on instance + * termination. + * * +volumeType+ - (String) + * * +iops+ - (Integer) + * * +noDevice+ - (String) Specifies the device name to + * suppress during instance launch. + * * +virtualizationType+ - (String) + * * +tags+ - (Array) A list of tags for the + * Image. + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * * +hypervisor+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method describeInstanceAttribute(params, options) + * @!method describeInstanceAttribute(params, callback) * Returns information about an attribute of an instance. Only one * attribute can be specified per call. - * @param [Object] params + * @param params [Object] * * +instanceId+ - (*required*, String) The ID of the * instance whose instance attribute is being described. * * +attribute+ - (*required*, String) The name of the * attribute to describe. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +InstanceAttribute+ - (Object) The described instance - * attribute. - * * +instanceId+ - (String) The ID of the associated - * instance. - * * +instanceType+ - (Object) The instance type (e.g., - * m1.small, c1.medium, m2.2xlarge, and so on). - * * +value+ - (String) - * * +kernelId+ - (Object) The kernel ID of the associated - * instance. - * * +value+ - (String) - * * +ramdiskId+ - (Object) The ramdisk ID of the - * associated instance. - * * +value+ - (String) - * * +userData+ - (Object) MIME, Base64-encoded user data. - * * +value+ - (String) - * * +disableApiTermination+ - (Object) Whether this - * instance can be terminated. You must modify this attribute - * before you can terminate any "locked" instances. - * * +value+ - (Boolean) - * * +instanceInitiatedShutdownBehavior+ - (Object) - * Whether this instance's Amazon EBS volumes are deleted when - * the instance is shut down. - * * +value+ - (String) - * * +rootDeviceName+ - (Object) The root device name - * (e.g., /dev/sda1). - * * +value+ - (String) - * * +blockDeviceMappings+ - (Array) How block - * devices are exposed to this instance. Each mapping is made up - * of a virtualName and a deviceName. - * * +deviceName+ - (String) The device name (e.g., - * /dev/sdh) at which the block device is exposed on the + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +InstanceAttribute+ - (Object) The described instance + * attribute. + * * +instanceId+ - (String) The ID of the associated * instance. - * * +ebs+ - (Object) The optional EBS device mapped to - * the specified device name. - * * +volumeId+ - (String) The ID of the EBS volume. - * * +status+ - (String) The status of the EBS volume. - * * +attachTime+ - (Date) The time at which the EBS - * volume was attached to the associated instance. - * * +deleteOnTermination+ - (Boolean) Specifies - * whether the Amazon EBS volume is deleted on instance - * termination. - * * +productCodes+ - (Array) - * * +ProductCodeId+ - (String) The unique ID of an AWS - * DevPay product code. - * * +ProductCodeType+ - (String) - * * +ebsOptimized+ - (Object) - * * +value+ - (Boolean) + * * +instanceType+ - (Object) The instance type (e.g., + * m1.small, c1.medium, m2.2xlarge, and so on). + * * +value+ - (String) + * * +kernelId+ - (Object) The kernel ID of the associated + * instance. + * * +value+ - (String) + * * +ramdiskId+ - (Object) The ramdisk ID of the + * associated instance. + * * +value+ - (String) + * * +userData+ - (Object) MIME, Base64-encoded user data. + * * +value+ - (String) + * * +disableApiTermination+ - (Object) Whether this + * instance can be terminated. You must modify this attribute + * before you can terminate any "locked" instances. + * * +value+ - (Boolean) + * * +instanceInitiatedShutdownBehavior+ - (Object) + * Whether this instance's Amazon EBS volumes are deleted when + * the instance is shut down. + * * +value+ - (String) + * * +rootDeviceName+ - (Object) The root device name + * (e.g., /dev/sda1). + * * +value+ - (String) + * * +blockDeviceMappings+ - (Array) How block + * devices are exposed to this instance. Each mapping is made up + * of a virtualName and a deviceName. + * * +deviceName+ - (String) The device name (e.g., + * /dev/sdh) at which the block device is exposed on the + * instance. + * * +ebs+ - (Object) The optional EBS device mapped to + * the specified device name. + * * +volumeId+ - (String) The ID of the EBS volume. + * * +status+ - (String) The status of the EBS volume. + * * +attachTime+ - (Date) The time at which the EBS + * volume was attached to the associated instance. + * * +deleteOnTermination+ - (Boolean) Specifies + * whether the Amazon EBS volume is deleted on instance + * termination. + * * +productCodes+ - (Array) + * * +ProductCodeId+ - (String) The unique ID of an AWS + * DevPay product code. + * * +ProductCodeType+ - (String) + * * +ebsOptimized+ - (Object) + * * +value+ - (Boolean) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method describeInstanceStatus(params, options) + * @!method describeInstanceStatus(params, callback) * Describes the status of an Amazon Elastic Compute Cloud (Amazon EC2) * instance. Instance status provides information about two types of * scheduled events for an instance that may require your attention: - * @param [Object] params + * @param params [Object] * * +InstanceIds+ - (Array) * * +filters+ - (Array) * * +Name+ - (String) Specifies the name of the filter. @@ -1910,42 +2467,49 @@ AWS.EC2 = inherit({}) * * +NextToken+ - (String) * * +MaxResults+ - (Integer) * * +includeAllInstances+ - (Boolean) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +instanceStatuses+ - (Array) - * * +instanceId+ - (String) - * * +availabilityZone+ - (String) - * * +events+ - (Array) - * * +code+ - (String) - * * +description+ - (String) - * * +notBefore+ - (Date) - * * +notAfter+ - (Date) - * * +instanceState+ - (Object) - * * +Code+ - (Integer) A 16-bit unsigned integer. The - * high byte is an opaque internal value and should be ignored. - * The low byte is set based on the state represented. - * * +Name+ - (String) The current state of the - * instance. - * * +systemStatus+ - (Object) - * * +status+ - (String) - * * +details+ - (Array) - * * +name+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +instanceStatuses+ - (Array) + * * +instanceId+ - (String) + * * +availabilityZone+ - (String) + * * +events+ - (Array) + * * +code+ - (String) + * * +description+ - (String) + * * +notBefore+ - (Date) + * * +notAfter+ - (Date) + * * +instanceState+ - (Object) + * * +Code+ - (Integer) A 16-bit unsigned integer. The + * high byte is an opaque internal value and should be ignored. + * The low byte is set based on the state represented. + * * +Name+ - (String) The current state of the + * instance. + * * +systemStatus+ - (Object) * * +status+ - (String) - * * +impairedSince+ - (Date) - * * +instanceStatus+ - (Object) - * * +status+ - (String) - * * +details+ - (Array) - * * +name+ - (String) + * * +details+ - (Array) + * * +name+ - (String) + * * +status+ - (String) + * * +impairedSince+ - (Date) + * * +instanceStatus+ - (Object) * * +status+ - (String) - * * +impairedSince+ - (Date) - * * +nextToken+ - (String) + * * +details+ - (Array) + * * +name+ - (String) + * * +status+ - (String) + * * +impairedSince+ - (Date) + * * +nextToken+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method describeInstances(params, options) + * @!method describeInstances(params, callback) * The DescribeInstances operation returns information about instances * that you own. - * @param [Object] params + * @param params [Object] * * +InstanceIds+ - (Array) An optional list of the * instances to describe. * * +filters+ - (Array) A list of filters used to @@ -1955,174 +2519,181 @@ AWS.EC2 = inherit({}) * * +Name+ - (String) Specifies the name of the filter. * * +Values+ - (Array) Contains one or more * values for the filter. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Reservations+ - (Array) The list of - * reservations containing the describes instances. - * * +ReservationId+ - (String) The unique ID of this - * reservation. - * * +OwnerId+ - (String) The AWS Access Key ID of the - * user who owns the reservation. - * * +RequesterId+ - (String) The unique ID of the user - * who requested the instances in this reservation. - * * +Groups+ - (Array) The list of security - * groups requested for the instances in this reservation. - * * +GroupName+ - (String) - * * +groupId+ - (String) - * * +Instances+ - (Array) The list of Amazon EC2 - * instances included in this reservation. - * * +InstanceId+ - (String) Unique ID of the instance - * launched. - * * +ImageId+ - (String) Image ID of the AMI used to - * launch the instance. - * * +State+ - (Object) The current state of the - * instance. - * * +Code+ - (Integer) A 16-bit unsigned integer. The - * high byte is an opaque internal value and should be - * ignored. The low byte is set based on the state - * represented. - * * +Name+ - (String) The current state of the + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Reservations+ - (Array) The list of + * reservations containing the describes instances. + * * +ReservationId+ - (String) The unique ID of this + * reservation. + * * +OwnerId+ - (String) The AWS Access Key ID of the + * user who owns the reservation. + * * +RequesterId+ - (String) The unique ID of the user + * who requested the instances in this reservation. + * * +Groups+ - (Array) The list of security + * groups requested for the instances in this reservation. + * * +GroupName+ - (String) + * * +groupId+ - (String) + * * +Instances+ - (Array) The list of Amazon EC2 + * instances included in this reservation. + * * +InstanceId+ - (String) Unique ID of the instance + * launched. + * * +ImageId+ - (String) Image ID of the AMI used to + * launch the instance. + * * +State+ - (Object) The current state of the * instance. - * * +PrivateDnsName+ - (String) The private DNS name - * assigned to the instance. This DNS name can only be used - * inside the Amazon EC2 network. This element remains empty - * until the instance enters a running state. - * * +PublicDnsName+ - (String) The public DNS name - * assigned to the instance. This DNS name is contactable from - * outside the Amazon EC2 network. This element remains empty - * until the instance enters a running state. - * * +StateTransitionReason+ - (String) Reason for the - * most recent state transition. This might be an empty string. - * * +KeyName+ - (String) If this instance was launched - * with an associated key pair, this displays the key pair - * name. - * * +AmiLaunchIndex+ - (Integer) The AMI launch index, - * which can be used to find this instance within the launch - * group. - * * +ProductCodes+ - (Array) Product codes - * attached to this instance. - * * +ProductCodeId+ - (String) The unique ID of an - * AWS DevPay product code. - * * +ProductCodeType+ - (String) - * * +InstanceType+ - (String) The instance type. For - * more information on instance types, please see the Amazon - * Elastic Compute Cloud Developer Guide. - * * +LaunchTime+ - (Date) The time this instance - * launched. - * * +Placement+ - (Object) The location where this - * instance launched. - * * +AvailabilityZone+ - (String) The availability - * zone in which an Amazon EC2 instance runs. - * * +groupName+ - (String) The name of the - * PlacementGroup in which an Amazon EC2 instance runs. - * Placement groups are primarily used for launching High - * Performance Computing instances in the same group to - * ensure fast connection speeds. - * * +tenancy+ - (String) The allowed tenancy of - * instances launched into the VPC. A value of default means - * instances can be launched with any tenancy; a value of - * dedicated means all instances launched into the VPC will - * be launched as dedicated tenancy regardless of the tenancy - * assigned to the instance at launch. - * * +KernelId+ - (String) Kernel associated with this - * instance. - * * +RamdiskId+ - (String) RAM disk associated with - * this instance. - * * +Platform+ - (String) Platform of the instance - * (e.g., Windows). - * * +Monitoring+ - (Object) Monitoring status for this - * instance. - * * +State+ - (String) The state of monitoring on an - * Amazon EC2 instance (ex: enabled, disabled). - * * +SubnetId+ - (String) Specifies the Amazon VPC - * subnet ID in which the instance is running. - * * +VpcId+ - (String) Specifies the Amazon VPC in - * which the instance is running. - * * +PrivateIpAddress+ - (String) Specifies the private - * IP address that is assigned to the instance (Amazon VPC). - * * +PublicIpAddress+ - (String) Specifies the IP - * address of the instance. - * * +stateReason+ - (Object) The reason for the state - * change. - * * +code+ - (String) Reason code for the state + * * +Code+ - (Integer) A 16-bit unsigned integer. The + * high byte is an opaque internal value and should be + * ignored. The low byte is set based on the state + * represented. + * * +Name+ - (String) The current state of the + * instance. + * * +PrivateDnsName+ - (String) The private DNS name + * assigned to the instance. This DNS name can only be used + * inside the Amazon EC2 network. This element remains empty + * until the instance enters a running state. + * * +PublicDnsName+ - (String) The public DNS name + * assigned to the instance. This DNS name is contactable from + * outside the Amazon EC2 network. This element remains empty + * until the instance enters a running state. + * * +StateTransitionReason+ - (String) Reason for the + * most recent state transition. This might be an empty string. + * * +KeyName+ - (String) If this instance was launched + * with an associated key pair, this displays the key pair + * name. + * * +AmiLaunchIndex+ - (Integer) The AMI launch index, + * which can be used to find this instance within the launch + * group. + * * +ProductCodes+ - (Array) Product codes + * attached to this instance. + * * +ProductCodeId+ - (String) The unique ID of an + * AWS DevPay product code. + * * +ProductCodeType+ - (String) + * * +InstanceType+ - (String) The instance type. For + * more information on instance types, please see the Amazon + * Elastic Compute Cloud Developer Guide. + * * +LaunchTime+ - (Date) The time this instance + * launched. + * * +Placement+ - (Object) The location where this + * instance launched. + * * +AvailabilityZone+ - (String) The availability + * zone in which an Amazon EC2 instance runs. + * * +groupName+ - (String) The name of the + * PlacementGroup in which an Amazon EC2 instance runs. + * Placement groups are primarily used for launching High + * Performance Computing instances in the same group to + * ensure fast connection speeds. + * * +tenancy+ - (String) The allowed tenancy of + * instances launched into the VPC. A value of default means + * instances can be launched with any tenancy; a value of + * dedicated means all instances launched into the VPC will + * be launched as dedicated tenancy regardless of the tenancy + * assigned to the instance at launch. + * * +KernelId+ - (String) Kernel associated with this + * instance. + * * +RamdiskId+ - (String) RAM disk associated with + * this instance. + * * +Platform+ - (String) Platform of the instance + * (e.g., Windows). + * * +Monitoring+ - (Object) Monitoring status for this + * instance. + * * +State+ - (String) The state of monitoring on an + * Amazon EC2 instance (ex: enabled, disabled). + * * +SubnetId+ - (String) Specifies the Amazon VPC + * subnet ID in which the instance is running. + * * +VpcId+ - (String) Specifies the Amazon VPC in + * which the instance is running. + * * +PrivateIpAddress+ - (String) Specifies the private + * IP address that is assigned to the instance (Amazon VPC). + * * +PublicIpAddress+ - (String) Specifies the IP + * address of the instance. + * * +stateReason+ - (Object) The reason for the state * change. - * * +message+ - (String) Descriptive message for the - * state change. - * * +architecture+ - (String) The architecture of this - * instance. - * * +rootDeviceType+ - (String) The root device type - * used by the AMI. The AMI can use an Amazon EBS or instance - * store root device. - * * +rootDeviceName+ - (String) The root device name - * (e.g., /dev/sda1). - * * +blockDeviceMappings+ - (Array) Block - * device mapping set. - * * +deviceName+ - (String) The device name (e.g., - * /dev/sdh) at which the block device is exposed on the + * * +code+ - (String) Reason code for the state + * change. + * * +message+ - (String) Descriptive message for the + * state change. + * * +architecture+ - (String) The architecture of this * instance. - * * +ebs+ - (Object) The optional EBS device mapped - * to the specified device name. - * * +volumeId+ - (String) The ID of the EBS volume. - * * +status+ - (String) The status of the EBS - * volume. - * * +attachTime+ - (Date) The time at which the EBS - * volume was attached to the associated instance. - * * +deleteOnTermination+ - (Boolean) Specifies - * whether the Amazon EBS volume is deleted on instance - * termination. - * * +virtualizationType+ - (String) - * * +instanceLifecycle+ - (String) - * * +spotInstanceRequestId+ - (String) - * * +license+ - (Object) - * * +pool+ - (String) The license pool from which - * this license was used (ex: 'windows'). - * * +clientToken+ - (String) - * * +tags+ - (Array) A list of tags for the - * Instance. - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. - * * +securityGroups+ - (Array) - * * +GroupName+ - (String) - * * +groupId+ - (String) - * * +sourceDestCheck+ - (Boolean) - * * +hypervisor+ - (String) - * * +networkInterfaces+ - (Array) - * * +networkInterfaceId+ - (String) - * * +subnetId+ - (String) - * * +vpcId+ - (String) - * * +description+ - (String) - * * +ownerId+ - (String) - * * +status+ - (String) - * * +privateIpAddress+ - (String) - * * +privateDnsName+ - (String) - * * +sourceDestCheck+ - (Boolean) - * * +groups+ - (Array) + * * +rootDeviceType+ - (String) The root device type + * used by the AMI. The AMI can use an Amazon EBS or instance + * store root device. + * * +rootDeviceName+ - (String) The root device name + * (e.g., /dev/sda1). + * * +blockDeviceMappings+ - (Array) Block + * device mapping set. + * * +deviceName+ - (String) The device name (e.g., + * /dev/sdh) at which the block device is exposed on the + * instance. + * * +ebs+ - (Object) The optional EBS device mapped + * to the specified device name. + * * +volumeId+ - (String) The ID of the EBS volume. + * * +status+ - (String) The status of the EBS + * volume. + * * +attachTime+ - (Date) The time at which the EBS + * volume was attached to the associated instance. + * * +deleteOnTermination+ - (Boolean) Specifies + * whether the Amazon EBS volume is deleted on instance + * termination. + * * +virtualizationType+ - (String) + * * +instanceLifecycle+ - (String) + * * +spotInstanceRequestId+ - (String) + * * +license+ - (Object) + * * +pool+ - (String) The license pool from which + * this license was used (ex: 'windows'). + * * +clientToken+ - (String) + * * +tags+ - (Array) A list of tags for the + * Instance. + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * * +securityGroups+ - (Array) * * +GroupName+ - (String) * * +groupId+ - (String) - * * +attachment+ - (Object) - * * +attachmentId+ - (String) - * * +deviceIndex+ - (Integer) + * * +sourceDestCheck+ - (Boolean) + * * +hypervisor+ - (String) + * * +networkInterfaces+ - (Array) + * * +networkInterfaceId+ - (String) + * * +subnetId+ - (String) + * * +vpcId+ - (String) + * * +description+ - (String) + * * +ownerId+ - (String) * * +status+ - (String) - * * +attachTime+ - (Date) - * * +deleteOnTermination+ - (Boolean) - * * +association+ - (Object) - * * +publicIp+ - (String) - * * +ipOwnerId+ - (String) - * * +iamInstanceProfile+ - (Object) - * * +arn+ - (String) - * * +id+ - (String) - * * +ebsOptimized+ - (Boolean) + * * +privateIpAddress+ - (String) + * * +privateDnsName+ - (String) + * * +sourceDestCheck+ - (Boolean) + * * +groups+ - (Array) + * * +GroupName+ - (String) + * * +groupId+ - (String) + * * +attachment+ - (Object) + * * +attachmentId+ - (String) + * * +deviceIndex+ - (Integer) + * * +status+ - (String) + * * +attachTime+ - (Date) + * * +deleteOnTermination+ - (Boolean) + * * +association+ - (Object) + * * +publicIp+ - (String) + * * +ipOwnerId+ - (String) + * * +iamInstanceProfile+ - (Object) + * * +arn+ - (String) + * * +id+ - (String) + * * +ebsOptimized+ - (Boolean) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method describeInternetGateways(params, options) + * @!method describeInternetGateways(params, callback) * Gives you information about your Internet gateways. You can filter * the results to return information only about Internet gateways that * match criteria you specify. For example, you could get information * only about gateways with particular tags. The Internet gateway must * match at least one of the specified values for it to be included in * the results. - * @param [Object] params + * @param params [Object] * * +internetGatewayIds+ - (Array) One or more * Internet gateway IDs. * * +filters+ - (Array) A list of filters used to @@ -2132,25 +2703,32 @@ AWS.EC2 = inherit({}) * * +Name+ - (String) Specifies the name of the filter. * * +Values+ - (Array) Contains one or more * values for the filter. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +internetGateways+ - (Array) - * * +internetGatewayId+ - (String) - * * +attachments+ - (Array) - * * +vpcId+ - (String) - * * +state+ - (String) - * * +tags+ - (Array) - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +internetGateways+ - (Array) + * * +internetGatewayId+ - (String) + * * +attachments+ - (Array) + * * +vpcId+ - (String) + * * +state+ - (String) + * * +tags+ - (Array) + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method describeKeyPairs(params, options) + * @!method describeKeyPairs(params, callback) * The DescribeKeyPairs operation returns information about key pairs * available to you. If you specify key pairs, information about those * key pairs is returned. Otherwise, information for all registered key * pairs is returned. - * @param [Object] params + * @param params [Object] * * +KeyNames+ - (Array) The optional list of key * pair names to describe. * * +filters+ - (Array) A list of filters used to @@ -2160,21 +2738,28 @@ AWS.EC2 = inherit({}) * * +Name+ - (String) Specifies the name of the filter. * * +Values+ - (Array) Contains one or more * values for the filter. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +KeyPairs+ - (Array) The list of described key - * pairs. - * * +KeyName+ - (String) The name of the key pair. - * * +KeyFingerprint+ - (String) The SHA-1 digest of the - * DER encoded private key. - * - * @!method describeLicenses(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +KeyPairs+ - (Array) The list of described key + * pairs. + * * +KeyName+ - (String) The name of the key pair. + * * +KeyFingerprint+ - (String) The SHA-1 digest of the + * DER encoded private key. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method describeLicenses(params, callback) * Provides details of a user's registered licenses. Zero or more IDs * may be specified on the call. When one or more license IDs are * specified, only data for the specified IDs are returned. - * @param [Object] params + * @param params [Object] * * +licenseIds+ - (Array) Specifies the license * registration for which details are to be returned. * * +filters+ - (Array) A list of filters used to @@ -2184,47 +2769,54 @@ AWS.EC2 = inherit({}) * * +Name+ - (String) Specifies the name of the filter. * * +Values+ - (Array) Contains one or more * values for the filter. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +licenses+ - (Array) Specifies active licenses - * in use and attached to an Amazon EC2 instance. - * * +licenseId+ - (String) The unique ID identifying the - * license. - * * +type+ - (String) The license type (ex. - * "Microsoft/Windows/Standard"). - * * +pool+ - (String) The name of the pool in which the - * license is kept. - * * +capacities+ - (Array) The capacities - * available for this license, indicating how many licenses are - * in use, how many are available, how many Amazon EC2 instances - * can be supported, etc. - * * +capacity+ - (Integer) The number of licenses - * available. - * * +instanceCapacity+ - (Integer) The number of Amazon - * EC2 instances that can be supported with the license's - * capacity. - * * +state+ - (String) The state of this license - * capacity, indicating whether the license is actively being - * used or not. - * * +earliestAllowedDeactivationTime+ - (Date) The - * earliest allowed time at which a license can be deactivated. - * Some licenses have time restrictions on when they can be - * activated and reactivated. - * * +tags+ - (Array) A list of tags for the - * License. - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +licenses+ - (Array) Specifies active licenses + * in use and attached to an Amazon EC2 instance. + * * +licenseId+ - (String) The unique ID identifying the + * license. + * * +type+ - (String) The license type (ex. + * "Microsoft/Windows/Standard"). + * * +pool+ - (String) The name of the pool in which the + * license is kept. + * * +capacities+ - (Array) The capacities + * available for this license, indicating how many licenses are + * in use, how many are available, how many Amazon EC2 instances + * can be supported, etc. + * * +capacity+ - (Integer) The number of licenses + * available. + * * +instanceCapacity+ - (Integer) The number of Amazon + * EC2 instances that can be supported with the license's + * capacity. + * * +state+ - (String) The state of this license + * capacity, indicating whether the license is actively being + * used or not. + * * +earliestAllowedDeactivationTime+ - (Date) The + * earliest allowed time at which a license can be deactivated. + * Some licenses have time restrictions on when they can be + * activated and reactivated. + * * +tags+ - (Array) A list of tags for the + * License. + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method describeNetworkAcls(params, options) + * @!method describeNetworkAcls(params, callback) * Gives you information about the network ACLs in your VPC. You can * filter the results to return information only about ACLs that match * criteria you specify. For example, you could get information only * the ACL associated with a particular subnet. The ACL must match at * least one of the specified values for it to be included in the * results. - * @param [Object] params + * @param params [Object] * * +networkAclIds+ - (Array) One or more network * ACL IDs. * * +filters+ - (Array) A list of filters used to @@ -2234,95 +2826,69 @@ AWS.EC2 = inherit({}) * * +Name+ - (String) Specifies the name of the filter. * * +Values+ - (Array) Contains one or more * values for the filter. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +networkAcls+ - (Array) - * * +networkAclId+ - (String) - * * +vpcId+ - (String) - * * +isDefault+ - (Boolean) - * * +entries+ - (Array) - * * +ruleNumber+ - (Integer) - * * +protocol+ - (String) - * * +ruleAction+ - (String) - * * +egress+ - (Boolean) - * * +cidrBlock+ - (String) - * * +icmpTypeCode+ - (Object) - * * +type+ - (Integer) For the ICMP protocol, the - * ICMP type. A value of -1 is a wildcard meaning all types. - * Required if specifying icmp for the protocol. - * * +code+ - (Integer) For the ICMP protocol, the - * ICMP code. A value of -1 is a wildcard meaning all codes. - * Required if specifying icmp for the protocol. - * * +portRange+ - (Object) - * * +from+ - (Integer) The first port in the range. - * Required if specifying tcp or udp for the protocol. - * * +to+ - (Integer) The last port in the range. - * Required if specifying tcp or udp for the protocol. - * * +associations+ - (Array) - * * +networkAclAssociationId+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +networkAcls+ - (Array) * * +networkAclId+ - (String) - * * +subnetId+ - (String) - * * +tags+ - (Array) - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. + * * +vpcId+ - (String) + * * +isDefault+ - (Boolean) + * * +entries+ - (Array) + * * +ruleNumber+ - (Integer) + * * +protocol+ - (String) + * * +ruleAction+ - (String) + * * +egress+ - (Boolean) + * * +cidrBlock+ - (String) + * * +icmpTypeCode+ - (Object) + * * +type+ - (Integer) For the ICMP protocol, the + * ICMP type. A value of -1 is a wildcard meaning all types. + * Required if specifying icmp for the protocol. + * * +code+ - (Integer) For the ICMP protocol, the + * ICMP code. A value of -1 is a wildcard meaning all codes. + * Required if specifying icmp for the protocol. + * * +portRange+ - (Object) + * * +from+ - (Integer) The first port in the range. + * Required if specifying tcp or udp for the protocol. + * * +to+ - (Integer) The last port in the range. + * Required if specifying tcp or udp for the protocol. + * * +associations+ - (Array) + * * +networkAclAssociationId+ - (String) + * * +networkAclId+ - (String) + * * +subnetId+ - (String) + * * +tags+ - (Array) + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method describeNetworkInterfaceAttribute(params, options) + * @!method describeNetworkInterfaceAttribute(params, callback) * Calls the DescribeNetworkInterfaceAttribute API operation. - * @param [Object] params + * @param params [Object] * * +networkInterfaceId+ - (*required*, String) * * +description+ - (String) * * +sourceDestCheck+ - (String) * * +groups+ - (String) * * +attachment+ - (String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +networkInterfaceId+ - (String) - * * +description+ - (Object) - * * +value+ - (String) - * * +sourceDestCheck+ - (Object) - * * +value+ - (Boolean) - * * +groups+ - (Array) - * * +GroupName+ - (String) - * * +groupId+ - (String) - * * +attachment+ - (Object) - * * +attachmentId+ - (String) - * * +instanceId+ - (String) - * * +instanceOwnerId+ - (String) - * * +deviceIndex+ - (Integer) - * * +status+ - (String) - * * +attachTime+ - (Date) - * * +deleteOnTermination+ - (Boolean) - * - * @!method describeNetworkInterfaces(params, options) - * Calls the DescribeNetworkInterfaces API operation. - * @param [Object] params - * * +networkInterfaceIds+ - (Array) - * * +filters+ - (Array) - * * +Name+ - (String) Specifies the name of the filter. - * * +Values+ - (Array) Contains one or more - * values for the filter. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +networkInterfaces+ - (Array) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: * * +networkInterfaceId+ - (String) - * * +subnetId+ - (String) - * * +vpcId+ - (String) - * * +availabilityZone+ - (String) - * * +description+ - (String) - * * +ownerId+ - (String) - * * +requesterId+ - (String) - * * +requesterManaged+ - (Boolean) - * * +status+ - (String) - * * +macAddress+ - (String) - * * +privateIpAddress+ - (String) - * * +privateDnsName+ - (String) - * * +sourceDestCheck+ - (Boolean) + * * +description+ - (Object) + * * +value+ - (String) + * * +sourceDestCheck+ - (Object) + * * +value+ - (Boolean) * * +groups+ - (Array) * * +GroupName+ - (String) * * +groupId+ - (String) @@ -2334,27 +2900,74 @@ AWS.EC2 = inherit({}) * * +status+ - (String) * * +attachTime+ - (Date) * * +deleteOnTermination+ - (Boolean) - * * +association+ - (Object) - * * +publicIp+ - (String) - * * +ipOwnerId+ - (String) - * * +allocationId+ - (String) - * * +associationId+ - (String) - * * +tagSet+ - (Array) - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. - * * +privateIpAddresses+ - (Array) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method describeNetworkInterfaces(params, callback) + * Calls the DescribeNetworkInterfaces API operation. + * @param params [Object] + * * +networkInterfaceIds+ - (Array) + * * +filters+ - (Array) + * * +Name+ - (String) Specifies the name of the filter. + * * +Values+ - (Array) Contains one or more + * values for the filter. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +networkInterfaces+ - (Array) + * * +networkInterfaceId+ - (String) + * * +subnetId+ - (String) + * * +vpcId+ - (String) + * * +availabilityZone+ - (String) + * * +description+ - (String) + * * +ownerId+ - (String) + * * +requesterId+ - (String) + * * +requesterManaged+ - (Boolean) + * * +status+ - (String) + * * +macAddress+ - (String) * * +privateIpAddress+ - (String) - * * +primary+ - (Boolean) + * * +privateDnsName+ - (String) + * * +sourceDestCheck+ - (Boolean) + * * +groups+ - (Array) + * * +GroupName+ - (String) + * * +groupId+ - (String) + * * +attachment+ - (Object) + * * +attachmentId+ - (String) + * * +instanceId+ - (String) + * * +instanceOwnerId+ - (String) + * * +deviceIndex+ - (Integer) + * * +status+ - (String) + * * +attachTime+ - (Date) + * * +deleteOnTermination+ - (Boolean) * * +association+ - (Object) * * +publicIp+ - (String) * * +ipOwnerId+ - (String) * * +allocationId+ - (String) * * +associationId+ - (String) + * * +tagSet+ - (Array) + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * * +privateIpAddresses+ - (Array) + * * +privateIpAddress+ - (String) + * * +primary+ - (Boolean) + * * +association+ - (Object) + * * +publicIp+ - (String) + * * +ipOwnerId+ - (String) + * * +allocationId+ - (String) + * * +associationId+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method describePlacementGroups(params, options) + * @!method describePlacementGroups(params, callback) * Returns information about one or more PlacementGroup instances in a * user's account. - * @param [Object] params + * @param params [Object] * * +groupNames+ - (Array) The name of the * PlacementGroup. * * +filters+ - (Array) A list of filters used to @@ -2364,22 +2977,29 @@ AWS.EC2 = inherit({}) * * +Name+ - (String) Specifies the name of the filter. * * +Values+ - (Array) Contains one or more * values for the filter. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +placementGroups+ - (Array) Contains - * information about the specified PlacementGroups. - * * +groupName+ - (String) The name of this - * PlacementGroup. - * * +strategy+ - (String) The strategy to use when - * allocating Amazon EC2 instances for the PlacementGroup. - * * +state+ - (String) The state of this PlacementGroup. - * - * @!method describeRegions(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +placementGroups+ - (Array) Contains + * information about the specified PlacementGroups. + * * +groupName+ - (String) The name of this + * PlacementGroup. + * * +strategy+ - (String) The strategy to use when + * allocating Amazon EC2 instances for the PlacementGroup. + * * +state+ - (String) The state of this PlacementGroup. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method describeRegions(params, callback) * The DescribeRegions operation describes regions zones that are * currently available to the account. - * @param [Object] params + * @param params [Object] * * +RegionNames+ - (Array) The optional list of * regions to describe. * * +filters+ - (Array) A list of filters used to @@ -2389,19 +3009,26 @@ AWS.EC2 = inherit({}) * * +Name+ - (String) Specifies the name of the filter. * * +Values+ - (Array) Contains one or more * values for the filter. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Regions+ - (Array) The list of described - * Amazon EC2 regions. - * * +RegionName+ - (String) Name of the region. - * * +Endpoint+ - (String) Region service endpoint. - * - * @!method describeReservedInstances(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Regions+ - (Array) The list of described + * Amazon EC2 regions. + * * +RegionName+ - (String) Name of the region. + * * +Endpoint+ - (String) Region service endpoint. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method describeReservedInstances(params, callback) * The DescribeReservedInstances operation describes Reserved Instances * that were purchased for use with your account. - * @param [Object] params + * @param params [Object] * * +ReservedInstancesIds+ - (Array) The optional * list of Reserved Instance IDs to describe. * * +filters+ - (Array) A list of filters used to @@ -2412,87 +3039,101 @@ AWS.EC2 = inherit({}) * * +Values+ - (Array) Contains one or more * values for the filter. * * +offeringType+ - (String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +ReservedInstances+ - (Array) The list of - * described Reserved Instances. - * * +ReservedInstancesId+ - (String) The unique ID of the - * Reserved Instances purchase. - * * +InstanceType+ - (String) The instance type on which - * the Reserved Instances can be used. - * * +AvailabilityZone+ - (String) The Availability Zone - * in which the Reserved Instances can be used. - * * +Start+ - (Date) The date and time the Reserved - * Instances started. - * * +Duration+ - (Integer) The duration of the Reserved - * Instances, in seconds. - * * +UsagePrice+ - (Float) The usage price of the - * Reserved Instances, per hour. - * * +FixedPrice+ - (Float) The purchase price of the - * Reserved Instances. - * * +InstanceCount+ - (Integer) The number of Reserved - * Instances purchased. - * * +ProductDescription+ - (String) The Reserved - * Instances product description (ex: Windows or Unix/Linux). - * * +State+ - (String) The state of the Reserved - * Instances purchase. - * * +tags+ - (Array) A list of tags for the - * ReservedInstances. - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. - * * +instanceTenancy+ - (String) The tenancy of the - * reserved instance (ex: default or dedicated). - * * +currencyCode+ - (String) The currency of the - * reserved instance. Specified using ISO 4217 standard (e.g., - * USD, JPY). - * * +offeringType+ - (String) - * * +recurringCharges+ - (Array) - * * +frequency+ - (String) - * * +amount+ - (Float) - * - * @!method describeReservedInstancesListings(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +ReservedInstances+ - (Array) The list of + * described Reserved Instances. + * * +ReservedInstancesId+ - (String) The unique ID of the + * Reserved Instances purchase. + * * +InstanceType+ - (String) The instance type on which + * the Reserved Instances can be used. + * * +AvailabilityZone+ - (String) The Availability Zone + * in which the Reserved Instances can be used. + * * +Start+ - (Date) The date and time the Reserved + * Instances started. + * * +Duration+ - (Integer) The duration of the Reserved + * Instances, in seconds. + * * +UsagePrice+ - (Float) The usage price of the + * Reserved Instances, per hour. + * * +FixedPrice+ - (Float) The purchase price of the + * Reserved Instances. + * * +InstanceCount+ - (Integer) The number of Reserved + * Instances purchased. + * * +ProductDescription+ - (String) The Reserved + * Instances product description (ex: Windows or Unix/Linux). + * * +State+ - (String) The state of the Reserved + * Instances purchase. + * * +tags+ - (Array) A list of tags for the + * ReservedInstances. + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * * +instanceTenancy+ - (String) The tenancy of the + * reserved instance (ex: default or dedicated). + * * +currencyCode+ - (String) The currency of the + * reserved instance. Specified using ISO 4217 standard (e.g., + * USD, JPY). + * * +offeringType+ - (String) + * * +recurringCharges+ - (Array) + * * +frequency+ - (String) + * * +amount+ - (Float) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method describeReservedInstancesListings(params, callback) * Calls the DescribeReservedInstancesListings API operation. - * @param [Object] params + * @param params [Object] * * +reservedInstancesId+ - (String) * * +reservedInstancesListingId+ - (String) * * +filters+ - (Array) * * +Name+ - (String) Specifies the name of the filter. * * +Values+ - (Array) Contains one or more * values for the filter. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +reservedInstancesListings+ - (Array) - * * +reservedInstancesListingId+ - (String) - * * +reservedInstancesId+ - (String) - * * +createDate+ - (Date) - * * +updateDate+ - (Date) - * * +status+ - (String) - * * +statusMessage+ - (String) - * * +instanceCounts+ - (Array) - * * +state+ - (String) - * * +instanceCount+ - (Integer) - * * +priceSchedules+ - (Array) - * * +term+ - (Integer) - * * +price+ - (Float) - * * +currencyCode+ - (String) - * * +active+ - (Boolean) - * * +tags+ - (Array) - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. - * * +clientToken+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +reservedInstancesListings+ - (Array) + * * +reservedInstancesListingId+ - (String) + * * +reservedInstancesId+ - (String) + * * +createDate+ - (Date) + * * +updateDate+ - (Date) + * * +status+ - (String) + * * +statusMessage+ - (String) + * * +instanceCounts+ - (Array) + * * +state+ - (String) + * * +instanceCount+ - (Integer) + * * +priceSchedules+ - (Array) + * * +term+ - (Integer) + * * +price+ - (Float) + * * +currencyCode+ - (String) + * * +active+ - (Boolean) + * * +tags+ - (Array) + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * * +clientToken+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method describeReservedInstancesOfferings(params, options) + * @!method describeReservedInstancesOfferings(params, callback) * The DescribeReservedInstancesOfferings operation describes Reserved * Instance offerings that are available for purchase. With Amazon EC2 * Reserved Instances, you purchase the right to launch Amazon EC2 * instances for a period of time (without getting insufficient * capacity errors) and pay a lower usage rate for the actual time * used. - * @param [Object] params + * @param params [Object] * * +ReservedInstancesOfferingIds+ - (Array) An * optional list of the unique IDs of the Reserved Instance * offerings to describe. @@ -2514,49 +3155,56 @@ AWS.EC2 = inherit({}) * dedicated will run on single-tenant hardware and can only be * launched within a VPC. * * +offeringType+ - (String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +ReservedInstancesOfferings+ - (Array) The list - * of described Reserved Instance offerings. - * * +ReservedInstancesOfferingId+ - (String) The unique - * ID of this Reserved Instances offering. - * * +InstanceType+ - (String) The instance type on which - * the Reserved Instances can be used. - * * +AvailabilityZone+ - (String) The Availability Zone - * in which the Reserved Instances can be used. - * * +Duration+ - (Integer) The duration of the Reserved - * Instance, in seconds. - * * +UsagePrice+ - (Float) The usage price of the - * Reserved Instance, per hour. - * * +FixedPrice+ - (Float) The purchase price of the - * Reserved Instance. - * * +ProductDescription+ - (String) The Reserved - * Instances description (ex: Windows or Unix/Linux). - * * +instanceTenancy+ - (String) The tenancy of the - * reserved instance (ex: default or dedicated). - * * +currencyCode+ - (String) The currency of the - * reserved instance. Specified using ISO 4217 standard (e.g., - * USD, JPY). - * * +offeringType+ - (String) - * * +recurringCharges+ - (Array) - * * +frequency+ - (String) - * * +amount+ - (Float) - * * +marketplace+ - (Boolean) - * * +pricingDetails+ - (Array) - * * +price+ - (Float) - * * +count+ - (Integer) - * * +nextToken+ - (String) - * - * @!method describeRouteTables(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +ReservedInstancesOfferings+ - (Array) The list + * of described Reserved Instance offerings. + * * +ReservedInstancesOfferingId+ - (String) The unique + * ID of this Reserved Instances offering. + * * +InstanceType+ - (String) The instance type on which + * the Reserved Instances can be used. + * * +AvailabilityZone+ - (String) The Availability Zone + * in which the Reserved Instances can be used. + * * +Duration+ - (Integer) The duration of the Reserved + * Instance, in seconds. + * * +UsagePrice+ - (Float) The usage price of the + * Reserved Instance, per hour. + * * +FixedPrice+ - (Float) The purchase price of the + * Reserved Instance. + * * +ProductDescription+ - (String) The Reserved + * Instances description (ex: Windows or Unix/Linux). + * * +instanceTenancy+ - (String) The tenancy of the + * reserved instance (ex: default or dedicated). + * * +currencyCode+ - (String) The currency of the + * reserved instance. Specified using ISO 4217 standard (e.g., + * USD, JPY). + * * +offeringType+ - (String) + * * +recurringCharges+ - (Array) + * * +frequency+ - (String) + * * +amount+ - (Float) + * * +marketplace+ - (Boolean) + * * +pricingDetails+ - (Array) + * * +price+ - (Float) + * * +count+ - (Integer) + * * +nextToken+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method describeRouteTables(params, callback) * Gives you information about your route tables. You can filter the * results to return information only about tables that match criteria * you specify. For example, you could get information only about a * table associated with a particular subnet. You can specify multiple * values for the filter. The table must match at least one of the * specified values for it to be included in the results. - * @param [Object] params + * @param params [Object] * * +routeTableIds+ - (Array) One or more route * table IDs. * * +filters+ - (Array) A list of filters used to @@ -2566,40 +3214,47 @@ AWS.EC2 = inherit({}) * * +Name+ - (String) Specifies the name of the filter. * * +Values+ - (Array) Contains one or more * values for the filter. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +routeTables+ - (Array) - * * +routeTableId+ - (String) - * * +vpcId+ - (String) - * * +routes+ - (Array) - * * +destinationCidrBlock+ - (String) - * * +gatewayId+ - (String) - * * +instanceId+ - (String) - * * +instanceOwnerId+ - (String) - * * +networkInterfaceId+ - (String) - * * +state+ - (String) - * * +associations+ - (Array) - * * +routeTableAssociationId+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +routeTables+ - (Array) * * +routeTableId+ - (String) - * * +subnetId+ - (String) - * * +main+ - (Boolean) - * * +tags+ - (Array) - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. - * * +propagatingVgws+ - (Array) - * * +gatewayId+ - (String) - * * +propagatedRoutes+ - (Array) - * * +destinationCidrBlock+ - (String) - * * +gatewayId+ - (String) - * * +status+ - (String) - * * +sourceId+ - (String) + * * +vpcId+ - (String) + * * +routes+ - (Array) + * * +destinationCidrBlock+ - (String) + * * +gatewayId+ - (String) + * * +instanceId+ - (String) + * * +instanceOwnerId+ - (String) + * * +networkInterfaceId+ - (String) + * * +state+ - (String) + * * +associations+ - (Array) + * * +routeTableAssociationId+ - (String) + * * +routeTableId+ - (String) + * * +subnetId+ - (String) + * * +main+ - (Boolean) + * * +tags+ - (Array) + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * * +propagatingVgws+ - (Array) + * * +gatewayId+ - (String) + * * +propagatedRoutes+ - (Array) + * * +destinationCidrBlock+ - (String) + * * +gatewayId+ - (String) + * * +status+ - (String) + * * +sourceId+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method describeSecurityGroups(params, options) + * @!method describeSecurityGroups(params, callback) * The DescribeSecurityGroups operation returns information about * security groups that you own. - * @param [Object] params + * @param params [Object] * * +GroupNames+ - (Array) The optional list of * Amazon EC2 security groups to describe. * * +GroupIds+ - (Array) @@ -2610,104 +3265,118 @@ AWS.EC2 = inherit({}) * * +Name+ - (String) Specifies the name of the filter. * * +Values+ - (Array) Contains one or more * values for the filter. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +SecurityGroups+ - (Array) The list of - * described Amazon EC2 security groups. - * * +OwnerId+ - (String) The AWS Access Key ID of the - * owner of the security group. - * * +GroupName+ - (String) The name of this security - * group. - * * +groupId+ - (String) - * * +Description+ - (String) The description of this - * security group. - * * +IpPermissions+ - (Array) The permissions - * enabled for this security group. - * * +IpProtocol+ - (String) The IP protocol of this - * permission. - * * +FromPort+ - (Integer) Start of port range for the - * TCP and UDP protocols, or an ICMP type number. An ICMP type - * number of -1 indicates a wildcard (i.e., any ICMP type - * number). - * * +ToPort+ - (Integer) End of port range for the TCP - * and UDP protocols, or an ICMP code. An ICMP code of -1 - * indicates a wildcard (i.e., any ICMP code). - * * +UserIdGroupPairs+ - (Array) The list of - * AWS user IDs and groups included in this permission. - * * +UserId+ - (String) The AWS user ID of an - * account. - * * +GroupName+ - (String) Name of the security group - * in the specified AWS account. Cannot be used when - * specifying a CIDR IP address range. - * * +GroupId+ - (String) ID of the security group in - * the specified AWS account. Cannot be used when specifying - * a CIDR IP address range. - * * +IpRanges+ - (Array) The list of CIDR IP - * ranges included in this permission. - * * +CidrIp+ - (String) The list of CIDR IP ranges. - * * +ipPermissionsEgress+ - (Array) - * * +IpProtocol+ - (String) The IP protocol of this - * permission. - * * +FromPort+ - (Integer) Start of port range for the - * TCP and UDP protocols, or an ICMP type number. An ICMP type - * number of -1 indicates a wildcard (i.e., any ICMP type - * number). - * * +ToPort+ - (Integer) End of port range for the TCP - * and UDP protocols, or an ICMP code. An ICMP code of -1 - * indicates a wildcard (i.e., any ICMP code). - * * +UserIdGroupPairs+ - (Array) The list of - * AWS user IDs and groups included in this permission. - * * +UserId+ - (String) The AWS user ID of an - * account. - * * +GroupName+ - (String) Name of the security group - * in the specified AWS account. Cannot be used when - * specifying a CIDR IP address range. - * * +GroupId+ - (String) ID of the security group in - * the specified AWS account. Cannot be used when specifying - * a CIDR IP address range. - * * +IpRanges+ - (Array) The list of CIDR IP - * ranges included in this permission. - * * +CidrIp+ - (String) The list of CIDR IP ranges. - * * +vpcId+ - (String) - * * +tags+ - (Array) - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +SecurityGroups+ - (Array) The list of + * described Amazon EC2 security groups. + * * +OwnerId+ - (String) The AWS Access Key ID of the + * owner of the security group. + * * +GroupName+ - (String) The name of this security + * group. + * * +groupId+ - (String) + * * +Description+ - (String) The description of this + * security group. + * * +IpPermissions+ - (Array) The permissions + * enabled for this security group. + * * +IpProtocol+ - (String) The IP protocol of this + * permission. + * * +FromPort+ - (Integer) Start of port range for the + * TCP and UDP protocols, or an ICMP type number. An ICMP type + * number of -1 indicates a wildcard (i.e., any ICMP type + * number). + * * +ToPort+ - (Integer) End of port range for the TCP + * and UDP protocols, or an ICMP code. An ICMP code of -1 + * indicates a wildcard (i.e., any ICMP code). + * * +UserIdGroupPairs+ - (Array) The list of + * AWS user IDs and groups included in this permission. + * * +UserId+ - (String) The AWS user ID of an + * account. + * * +GroupName+ - (String) Name of the security group + * in the specified AWS account. Cannot be used when + * specifying a CIDR IP address range. + * * +GroupId+ - (String) ID of the security group in + * the specified AWS account. Cannot be used when specifying + * a CIDR IP address range. + * * +IpRanges+ - (Array) The list of CIDR IP + * ranges included in this permission. + * * +CidrIp+ - (String) The list of CIDR IP ranges. + * * +ipPermissionsEgress+ - (Array) + * * +IpProtocol+ - (String) The IP protocol of this + * permission. + * * +FromPort+ - (Integer) Start of port range for the + * TCP and UDP protocols, or an ICMP type number. An ICMP type + * number of -1 indicates a wildcard (i.e., any ICMP type + * number). + * * +ToPort+ - (Integer) End of port range for the TCP + * and UDP protocols, or an ICMP code. An ICMP code of -1 + * indicates a wildcard (i.e., any ICMP code). + * * +UserIdGroupPairs+ - (Array) The list of + * AWS user IDs and groups included in this permission. + * * +UserId+ - (String) The AWS user ID of an + * account. + * * +GroupName+ - (String) Name of the security group + * in the specified AWS account. Cannot be used when + * specifying a CIDR IP address range. + * * +GroupId+ - (String) ID of the security group in + * the specified AWS account. Cannot be used when specifying + * a CIDR IP address range. + * * +IpRanges+ - (Array) The list of CIDR IP + * ranges included in this permission. + * * +CidrIp+ - (String) The list of CIDR IP ranges. + * * +vpcId+ - (String) + * * +tags+ - (Array) + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method describeSnapshotAttribute(params, options) + * @!method describeSnapshotAttribute(params, callback) * Returns information about an attribute of a snapshot. Only one * attribute can be specified per call. - * @param [Object] params + * @param params [Object] * * +SnapshotId+ - (*required*, String) The ID of the EBS * snapshot whose attribute is being described. * * +Attribute+ - (*required*, String) The name of the EBS * attribute to describe. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +snapshotId+ - (String) The ID of the snapshot whose - * attribute is being described. - * * +CreateVolumePermissions+ - (Array) The list of - * permissions describing who can create a volume from the - * associated EBS snapshot. - * * +UserId+ - (String) The user ID of the user that can - * create volumes from the snapshot. - * * +Group+ - (String) The group that is allowed to - * create volumes from the snapshot (currently supports "all"). - * * +productCodes+ - (Array) - * * +ProductCodeId+ - (String) The unique ID of an AWS - * DevPay product code. - * * +ProductCodeType+ - (String) - * - * @!method describeSnapshots(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +snapshotId+ - (String) The ID of the snapshot whose + * attribute is being described. + * * +CreateVolumePermissions+ - (Array) The list of + * permissions describing who can create a volume from the + * associated EBS snapshot. + * * +UserId+ - (String) The user ID of the user that can + * create volumes from the snapshot. + * * +Group+ - (String) The group that is allowed to + * create volumes from the snapshot (currently supports "all"). + * * +productCodes+ - (Array) + * * +ProductCodeId+ - (String) The unique ID of an AWS + * DevPay product code. + * * +ProductCodeType+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method describeSnapshots(params, callback) * Returns information about the Amazon EBS snapshots available to you. * Snapshots available to you include public snapshots available for * any AWS account to launch, private snapshots you own, and private * snapshots owned by another AWS account but for which you've been * given explicit create volume permissions. - * @param [Object] params + * @param params [Object] * * +SnapshotIds+ - (Array) The optional list of * EBS snapshot IDs to describe. * * +OwnerIds+ - (Array) The optional list of EBS @@ -2722,58 +3391,72 @@ AWS.EC2 = inherit({}) * * +Name+ - (String) Specifies the name of the filter. * * +Values+ - (Array) Contains one or more * values for the filter. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Snapshots+ - (Array) The list of described EBS - * snapshots. - * * +SnapshotId+ - (String) The unique ID of this - * snapshot. - * * +VolumeId+ - (String) The ID of the volume from which - * this snapshot was created. - * * +State+ - (String) Snapshot state (e.g., pending, - * completed, or error). - * * +StartTime+ - (Date) Time stamp when the snapshot was - * initiated. - * * +Progress+ - (String) The progress of the snapshot, - * in percentage. - * * +OwnerId+ - (String) AWS Access Key ID of the user - * who owns the snapshot. - * * +Description+ - (String) Description of the snapshot. - * * +VolumeSize+ - (Integer) The size of the volume, in - * gigabytes. - * * +ownerAlias+ - (String) The AWS account alias (e.g., - * "amazon", "redhat", "self", etc.) or AWS account ID that owns - * the AMI. - * * +tags+ - (Array) A list of tags for the - * Snapshot. - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Snapshots+ - (Array) The list of described EBS + * snapshots. + * * +SnapshotId+ - (String) The unique ID of this + * snapshot. + * * +VolumeId+ - (String) The ID of the volume from which + * this snapshot was created. + * * +State+ - (String) Snapshot state (e.g., pending, + * completed, or error). + * * +StartTime+ - (Date) Time stamp when the snapshot was + * initiated. + * * +Progress+ - (String) The progress of the snapshot, + * in percentage. + * * +OwnerId+ - (String) AWS Access Key ID of the user + * who owns the snapshot. + * * +Description+ - (String) Description of the snapshot. + * * +VolumeSize+ - (Integer) The size of the volume, in + * gigabytes. + * * +ownerAlias+ - (String) The AWS account alias (e.g., + * "amazon", "redhat", "self", etc.) or AWS account ID that owns + * the AMI. + * * +tags+ - (Array) A list of tags for the + * Snapshot. + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method describeSpotDatafeedSubscription(params, options) + * @!method describeSpotDatafeedSubscription(params, callback) * Describes the data feed for Spot Instances. - * @param [Object] params - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +spotDatafeedSubscription+ - (Object) The Spot Instance - * datafeed subscription. - * * +ownerId+ - (String) Specifies the AWS account ID of - * the account. - * * +bucket+ - (String) Specifies the Amazon S3 bucket - * where the Spot Instance data feed is located. - * * +prefix+ - (String) Contains the prefix that is - * prepended to data feed files. - * * +state+ - (String) Specifies the state of the Spot - * Instance request. - * * +fault+ - (Object) Specifies a fault code for the - * Spot Instance request, if present. - * * +code+ - (String) - * * +message+ - (String) - * - * @!method describeSpotInstanceRequests(params, options) + * @param params [Object] + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +spotDatafeedSubscription+ - (Object) The Spot Instance + * datafeed subscription. + * * +ownerId+ - (String) Specifies the AWS account ID of + * the account. + * * +bucket+ - (String) Specifies the Amazon S3 bucket + * where the Spot Instance data feed is located. + * * +prefix+ - (String) Contains the prefix that is + * prepended to data feed files. + * * +state+ - (String) Specifies the state of the Spot + * Instance request. + * * +fault+ - (Object) Specifies a fault code for the + * Spot Instance request, if present. + * * +code+ - (String) + * * +message+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method describeSpotInstanceRequests(params, callback) * Describes Spot Instance requests. Spot Instances are instances that * Amazon EC2 starts on your behalf when the maximum price that you * specify exceeds the current Spot Price. Amazon EC2 periodically sets @@ -2781,7 +3464,7 @@ AWS.EC2 = inherit({}) * spot instance requests. For conceptual information about Spot * Instances, refer to the Amazon Elastic Compute Cloud Developer Guide * or Amazon Elastic Compute Cloud User Guide. - * @param [Object] params + * @param params [Object] * * +spotInstanceRequestIds+ - (Array) The ID of * the request. * * +filters+ - (Array) A list of filters used to @@ -2791,106 +3474,113 @@ AWS.EC2 = inherit({}) * * +Name+ - (String) Specifies the name of the filter. * * +Values+ - (Array) Contains one or more * values for the filter. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +spotInstanceRequests+ - (Array) - * * +spotInstanceRequestId+ - (String) - * * +spotPrice+ - (String) - * * +type+ - (String) - * * +state+ - (String) - * * +fault+ - (Object) - * * +code+ - (String) - * * +message+ - (String) - * * +validFrom+ - (Date) - * * +validUntil+ - (Date) - * * +launchGroup+ - (String) - * * +availabilityZoneGroup+ - (String) - * * +launchSpecification+ - (Object) - * * +imageId+ - (String) The AMI ID. - * * +keyName+ - (String) The name of the key pair. - * * +SecurityGroups+ - (Array) - * * +GroupName+ - (String) - * * +groupId+ - (String) - * * +userData+ - (String) Optional data, specific to a - * user's application, to provide in the launch request. All - * instances that collectively comprise the launch request have - * access to this data. User data is never returned through API - * responses. - * * +addressingType+ - (String) Deprecated. - * * +instanceType+ - (String) Specifies the instance - * type. - * * +placement+ - (Object) Defines a placement item. - * * +availabilityZone+ - (String) The availability - * zone in which an Amazon EC2 instance runs. - * * +groupName+ - (String) The name of the - * PlacementGroup in which an Amazon EC2 instance runs. - * Placement groups are primarily used for launching High - * Performance Computing instances in the same group to - * ensure fast connection speeds. - * * +kernelId+ - (String) Specifies the ID of the - * kernel to select. - * * +ramdiskId+ - (String) Specifies the ID of the RAM - * disk to select. Some kernels require additional drivers at - * launch. Check the kernel requirements for information on - * whether or not you need to specify a RAM disk and search for - * the kernel ID. - * * +blockDeviceMappings+ - (Array) Specifies - * how block devices are exposed to the instance. Each mapping - * is made up of a virtualName and a deviceName. - * * +VirtualName+ - (String) Specifies the virtual - * device name. - * * +DeviceName+ - (String) Specifies the device name - * (e.g., /dev/sdh). - * * +ebs+ - (Object) Specifies parameters used to - * automatically setup Amazon EBS volumes when the instance - * is launched. - * * +snapshotId+ - (String) The ID of the snapshot - * from which the volume will be created. - * * +volumeSize+ - (Integer) The size of the - * volume, in gigabytes. - * * +deleteOnTermination+ - (Boolean) Specifies - * whether the Amazon EBS volume is deleted on instance - * termination. - * * +volumeType+ - (String) - * * +iops+ - (Integer) - * * +noDevice+ - (String) Specifies the device name - * to suppress during instance launch. - * * +monitoringEnabled+ - (Boolean) Enables monitoring - * for the instance. - * * +subnetId+ - (String) Specifies the Amazon VPC - * subnet ID within which to launch the instance(s) for Amazon - * Virtual Private Cloud. - * * +networkInterfaces+ - (Array) - * * +networkInterfaceId+ - (String) - * * +deviceIndex+ - (Integer) - * * +subnetId+ - (String) - * * +description+ - (String) - * * +privateIpAddress+ - (String) - * * +groups+ - (Array) - * * +deleteOnTermination+ - (Boolean) - * * +privateIpAddresses+ - (Array) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +spotInstanceRequests+ - (Array) + * * +spotInstanceRequestId+ - (String) + * * +spotPrice+ - (String) + * * +type+ - (String) + * * +state+ - (String) + * * +fault+ - (Object) + * * +code+ - (String) + * * +message+ - (String) + * * +validFrom+ - (Date) + * * +validUntil+ - (Date) + * * +launchGroup+ - (String) + * * +availabilityZoneGroup+ - (String) + * * +launchSpecification+ - (Object) + * * +imageId+ - (String) The AMI ID. + * * +keyName+ - (String) The name of the key pair. + * * +SecurityGroups+ - (Array) + * * +GroupName+ - (String) + * * +groupId+ - (String) + * * +userData+ - (String) Optional data, specific to a + * user's application, to provide in the launch request. All + * instances that collectively comprise the launch request have + * access to this data. User data is never returned through API + * responses. + * * +addressingType+ - (String) Deprecated. + * * +instanceType+ - (String) Specifies the instance + * type. + * * +placement+ - (Object) Defines a placement item. + * * +availabilityZone+ - (String) The availability + * zone in which an Amazon EC2 instance runs. + * * +groupName+ - (String) The name of the + * PlacementGroup in which an Amazon EC2 instance runs. + * Placement groups are primarily used for launching High + * Performance Computing instances in the same group to + * ensure fast connection speeds. + * * +kernelId+ - (String) Specifies the ID of the + * kernel to select. + * * +ramdiskId+ - (String) Specifies the ID of the RAM + * disk to select. Some kernels require additional drivers at + * launch. Check the kernel requirements for information on + * whether or not you need to specify a RAM disk and search for + * the kernel ID. + * * +blockDeviceMappings+ - (Array) Specifies + * how block devices are exposed to the instance. Each mapping + * is made up of a virtualName and a deviceName. + * * +VirtualName+ - (String) Specifies the virtual + * device name. + * * +DeviceName+ - (String) Specifies the device name + * (e.g., /dev/sdh). + * * +ebs+ - (Object) Specifies parameters used to + * automatically setup Amazon EBS volumes when the instance + * is launched. + * * +snapshotId+ - (String) The ID of the snapshot + * from which the volume will be created. + * * +volumeSize+ - (Integer) The size of the + * volume, in gigabytes. + * * +deleteOnTermination+ - (Boolean) Specifies + * whether the Amazon EBS volume is deleted on instance + * termination. + * * +volumeType+ - (String) + * * +iops+ - (Integer) + * * +noDevice+ - (String) Specifies the device name + * to suppress during instance launch. + * * +monitoringEnabled+ - (Boolean) Enables monitoring + * for the instance. + * * +subnetId+ - (String) Specifies the Amazon VPC + * subnet ID within which to launch the instance(s) for Amazon + * Virtual Private Cloud. + * * +networkInterfaces+ - (Array) + * * +networkInterfaceId+ - (String) + * * +deviceIndex+ - (Integer) + * * +subnetId+ - (String) + * * +description+ - (String) * * +privateIpAddress+ - (String) - * * +primary+ - (Boolean) - * * +secondaryPrivateIpAddressCount+ - (Integer) - * * +iamInstanceProfile+ - (Object) - * * +arn+ - (String) - * * +name+ - (String) - * * +ebsOptimized+ - (Boolean) - * * +instanceId+ - (String) - * * +createTime+ - (Date) - * * +productDescription+ - (String) - * * +tags+ - (Array) A list of tags for this spot - * instance request. - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. - * * +launchedAvailabilityZone+ - (String) The - * Availability Zone in which the bid is launched. + * * +groups+ - (Array) + * * +deleteOnTermination+ - (Boolean) + * * +privateIpAddresses+ - (Array) + * * +privateIpAddress+ - (String) + * * +primary+ - (Boolean) + * * +secondaryPrivateIpAddressCount+ - (Integer) + * * +iamInstanceProfile+ - (Object) + * * +arn+ - (String) + * * +name+ - (String) + * * +ebsOptimized+ - (Boolean) + * * +instanceId+ - (String) + * * +createTime+ - (Date) + * * +productDescription+ - (String) + * * +tags+ - (Array) A list of tags for this spot + * instance request. + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * * +launchedAvailabilityZone+ - (String) The + * Availability Zone in which the bid is launched. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method describeSpotPriceHistory(params, options) + * @!method describeSpotPriceHistory(params, callback) * Describes the Spot Price history. - * @param [Object] params + * @param params [Object] * * +startTime+ - (Date) The start date and time of the * Spot Instance price history data. * * +endTime+ - (Date) The end date and time of the Spot @@ -2912,25 +3602,32 @@ AWS.EC2 = inherit({}) * to return. * * +nextToken+ - (String) Specifies the next set of rows * to return. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +spotPriceHistory+ - (Array) - * * +instanceType+ - (String) - * * +productDescription+ - (String) - * * +spotPrice+ - (String) - * * +timestamp+ - (Date) - * * +availabilityZone+ - (String) - * * +nextToken+ - (String) The string marking the next set - * of results returned. Displays empty if there are no more results - * to be returned. - * - * @!method describeSubnets(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +spotPriceHistory+ - (Array) + * * +instanceType+ - (String) + * * +productDescription+ - (String) + * * +spotPrice+ - (String) + * * +timestamp+ - (Date) + * * +availabilityZone+ - (String) + * * +nextToken+ - (String) The string marking the next set + * of results returned. Displays empty if there are no more results + * to be returned. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method describeSubnets(params, callback) * Gives you information about your subnets. You can filter the results * to return information only about subnets that match criteria you * specify. - * @param [Object] params + * @param params [Object] * * +SubnetIds+ - (Array) A set of one or more * subnet IDs. * * +Filters+ - (Array) A list of filters used to @@ -2940,70 +3637,91 @@ AWS.EC2 = inherit({}) * * +Name+ - (String) Specifies the name of the filter. * * +Values+ - (Array) Contains one or more * values for the filter. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Subnets+ - (Array) Contains a set of one or - * more Subnet instances. - * * +SubnetId+ - (String) Specifies the ID of the subnet. - * * +State+ - (String) Describes the current state of the - * subnet. The state of the subnet may be either pending or - * available. - * * +VpcId+ - (String) Contains the ID of the VPC the - * subnet is in. - * * +CidrBlock+ - (String) Specifies the CIDR block - * assigned to the subnet. - * * +AvailableIpAddressCount+ - (Integer) Specifies the - * number of unused IP addresses in the subnet. - * * +AvailabilityZone+ - (String) Specifies the - * Availability Zone the subnet is in. - * * +tags+ - (Array) A list of tags for the - * Subnet. - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Subnets+ - (Array) Contains a set of one or + * more Subnet instances. + * * +SubnetId+ - (String) Specifies the ID of the subnet. + * * +State+ - (String) Describes the current state of the + * subnet. The state of the subnet may be either pending or + * available. + * * +VpcId+ - (String) Contains the ID of the VPC the + * subnet is in. + * * +CidrBlock+ - (String) Specifies the CIDR block + * assigned to the subnet. + * * +AvailableIpAddressCount+ - (Integer) Specifies the + * number of unused IP addresses in the subnet. + * * +AvailabilityZone+ - (String) Specifies the + * Availability Zone the subnet is in. + * * +tags+ - (Array) A list of tags for the + * Subnet. + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method describeTags(params, options) + * @!method describeTags(params, callback) * Describes the tags for the specified resources. - * @param [Object] params + * @param params [Object] * * +filters+ - (Array) A list of filters used to * match properties for tags. * * +Name+ - (String) Specifies the name of the filter. * * +Values+ - (Array) Contains one or more * values for the filter. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +tags+ - (Array) A list of the tags for the - * specified resources. - * * +resourceId+ - (String) The resource ID for the tag. - * * +resourceType+ - (String) The type of resource - * identified by the associated resource ID (ex: instance, AMI, - * EBS volume, etc). - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +tags+ - (Array) A list of the tags for the + * specified resources. + * * +resourceId+ - (String) The resource ID for the tag. + * * +resourceType+ - (String) The type of resource + * identified by the associated resource ID (ex: instance, AMI, + * EBS volume, etc). + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method describeVolumeAttribute(params, options) + * @!method describeVolumeAttribute(params, callback) * Calls the DescribeVolumeAttribute API operation. - * @param [Object] params + * @param params [Object] * * +VolumeId+ - (*required*, String) * * +Attribute+ - (String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +volumeId+ - (String) - * * +autoEnableIO+ - (Object) - * * +value+ - (Boolean) - * * +productCodes+ - (Array) - * * +ProductCodeId+ - (String) The unique ID of an AWS - * DevPay product code. - * * +ProductCodeType+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +volumeId+ - (String) + * * +autoEnableIO+ - (Object) + * * +value+ - (Boolean) + * * +productCodes+ - (Array) + * * +ProductCodeId+ - (String) The unique ID of an AWS + * DevPay product code. + * * +ProductCodeType+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method describeVolumeStatus(params, options) + * @!method describeVolumeStatus(params, callback) * Describes the status of a volume. - * @param [Object] params + * @param params [Object] * * +VolumeIds+ - (Array) * * +filters+ - (Array) * * +Name+ - (String) Specifies the name of the filter. @@ -3011,36 +3729,43 @@ AWS.EC2 = inherit({}) * values for the filter. * * +NextToken+ - (String) * * +MaxResults+ - (Integer) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +volumeStatuses+ - (Array) - * * +volumeId+ - (String) - * * +availabilityZone+ - (String) - * * +volumeStatus+ - (Object) - * * +status+ - (String) - * * +details+ - (Array) - * * +name+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +volumeStatuses+ - (Array) + * * +volumeId+ - (String) + * * +availabilityZone+ - (String) + * * +volumeStatus+ - (Object) * * +status+ - (String) - * * +events+ - (Array) - * * +eventType+ - (String) - * * +description+ - (String) - * * +notBefore+ - (Date) - * * +notAfter+ - (Date) - * * +eventId+ - (String) - * * +actions+ - (Array) - * * +code+ - (String) - * * +description+ - (String) - * * +eventType+ - (String) - * * +eventId+ - (String) - * * +nextToken+ - (String) + * * +details+ - (Array) + * * +name+ - (String) + * * +status+ - (String) + * * +events+ - (Array) + * * +eventType+ - (String) + * * +description+ - (String) + * * +notBefore+ - (Date) + * * +notAfter+ - (Date) + * * +eventId+ - (String) + * * +actions+ - (Array) + * * +code+ - (String) + * * +description+ - (String) + * * +eventType+ - (String) + * * +eventId+ - (String) + * * +nextToken+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method describeVolumes(params, options) + * @!method describeVolumes(params, callback) * Describes the status of the indicated volume or, in lieu of any * specified, all volumes belonging to the caller. Volumes that have * been deleted are not described. - * @param [Object] params + * @param params [Object] * * +VolumeIds+ - (Array) The optional list of EBS * volumes to describe. * * +filters+ - (Array) A list of filters used to @@ -3050,44 +3775,51 @@ AWS.EC2 = inherit({}) * * +Name+ - (String) Specifies the name of the filter. * * +Values+ - (Array) Contains one or more * values for the filter. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Volumes+ - (Array) The list of described EBS - * volumes. - * * +VolumeId+ - (String) The unique ID of this volume. - * * +Size+ - (Integer) The size of this volume, in - * gigabytes. - * * +SnapshotId+ - (String) Optional snapshot from which - * this volume was created. - * * +AvailabilityZone+ - (String) Availability zone in - * which this volume was created. - * * +State+ - (String) State of this volume (e.g., - * creating, available). - * * +CreateTime+ - (Date) Timestamp when volume creation - * was initiated. - * * +Attachments+ - (Array) Information on what - * this volume is attached to. - * * +VolumeId+ - (String) - * * +InstanceId+ - (String) - * * +Device+ - (String) How the device is exposed to - * the instance (e.g., /dev/sdh). - * * +State+ - (String) - * * +AttachTime+ - (Date) Timestamp when this - * attachment initiated. - * * +deleteOnTermination+ - (Boolean) - * * +tags+ - (Array) A list of tags for the - * Volume. - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. - * * +volumeType+ - (String) - * * +iops+ - (Integer) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Volumes+ - (Array) The list of described EBS + * volumes. + * * +VolumeId+ - (String) The unique ID of this volume. + * * +Size+ - (Integer) The size of this volume, in + * gigabytes. + * * +SnapshotId+ - (String) Optional snapshot from which + * this volume was created. + * * +AvailabilityZone+ - (String) Availability zone in + * which this volume was created. + * * +State+ - (String) State of this volume (e.g., + * creating, available). + * * +CreateTime+ - (Date) Timestamp when volume creation + * was initiated. + * * +Attachments+ - (Array) Information on what + * this volume is attached to. + * * +VolumeId+ - (String) + * * +InstanceId+ - (String) + * * +Device+ - (String) How the device is exposed to + * the instance (e.g., /dev/sdh). + * * +State+ - (String) + * * +AttachTime+ - (Date) Timestamp when this + * attachment initiated. + * * +deleteOnTermination+ - (Boolean) + * * +tags+ - (Array) A list of tags for the + * Volume. + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * * +volumeType+ - (String) + * * +iops+ - (Integer) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method describeVpcs(params, options) + * @!method describeVpcs(params, callback) * Gives you information about your VPCs. You can filter the results to * return information only about VPCs that match criteria you specify. - * @param [Object] params + * @param params [Object] * * +VpcIds+ - (Array) The ID of a VPC you want * information about. * * +Filters+ - (Array) A list of filters used to @@ -3097,29 +3829,36 @@ AWS.EC2 = inherit({}) * * +Name+ - (String) Specifies the name of the filter. * * +Values+ - (Array) Contains one or more * values for the filter. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Vpcs+ - (Array) - * * +VpcId+ - (String) Specifies the ID of the VPC. - * * +State+ - (String) Describes the current state of the - * VPC. The state of the subnet may be either pending or - * available. - * * +CidrBlock+ - (String) Specifies the CIDR block the - * VPC covers. - * * +DhcpOptionsId+ - (String) Specifies the ID of the - * set of DHCP options associated with the VPC. Contains a value - * of default if the default options are associated with the VPC. - * * +tags+ - (Array) A list of tags for the VPC. - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. - * * +instanceTenancy+ - (String) The allowed tenancy of - * instances launched into the VPC. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Vpcs+ - (Array) + * * +VpcId+ - (String) Specifies the ID of the VPC. + * * +State+ - (String) Describes the current state of the + * VPC. The state of the subnet may be either pending or + * available. + * * +CidrBlock+ - (String) Specifies the CIDR block the + * VPC covers. + * * +DhcpOptionsId+ - (String) Specifies the ID of the + * set of DHCP options associated with the VPC. Contains a value + * of default if the default options are associated with the VPC. + * * +tags+ - (Array) A list of tags for the VPC. + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * * +instanceTenancy+ - (String) The allowed tenancy of + * instances launched into the VPC. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method describeVpnConnections(params, options) + * @!method describeVpnConnections(params, callback) * Gives you information about your VPN connections. - * @param [Object] params + * @param params [Object] * * +VpnConnectionIds+ - (Array) A VPN connection * ID. More than one may be specified per request. * * +Filters+ - (Array) A list of filters used to @@ -3129,47 +3868,54 @@ AWS.EC2 = inherit({}) * * +Name+ - (String) Specifies the name of the filter. * * +Values+ - (Array) Contains one or more * values for the filter. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +VpnConnections+ - (Array) - * * +VpnConnectionId+ - (String) Specifies the ID of the - * VPN gateway at the VPC end of the VPN connection. - * * +State+ - (String) Describes the current state of the - * VPN connection. Valid values are pending, available, deleting, - * and deleted. - * * +CustomerGatewayConfiguration+ - (String) Contains - * configuration information in the native XML format for the VPN - * connection's customer gateway. - * * +Type+ - (String) Specifies the type of VPN - * connection. - * * +CustomerGatewayId+ - (String) Specifies ID of the - * customer gateway at the end of the VPN connection. - * * +VpnGatewayId+ - (String) Specfies the ID of the VPN - * gateway at the VPC end of the VPN connection. - * * +tags+ - (Array) A list of tags for the - * VpnConnection. - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. - * * +vgwTelemetry+ - (Array) - * * +outsideIpAddress+ - (String) - * * +status+ - (String) - * * +lastStatusChange+ - (Date) - * * +statusMessage+ - (String) - * * +acceptedRouteCount+ - (Integer) - * * +options+ - (Object) - * * +staticRoutesOnly+ - (Boolean) - * * +routes+ - (Array) - * * +destinationCidrBlock+ - (String) - * * +source+ - (String) - * * +state+ - (String) - * - * @!method describeVpnGateways(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +VpnConnections+ - (Array) + * * +VpnConnectionId+ - (String) Specifies the ID of the + * VPN gateway at the VPC end of the VPN connection. + * * +State+ - (String) Describes the current state of the + * VPN connection. Valid values are pending, available, deleting, + * and deleted. + * * +CustomerGatewayConfiguration+ - (String) Contains + * configuration information in the native XML format for the VPN + * connection's customer gateway. + * * +Type+ - (String) Specifies the type of VPN + * connection. + * * +CustomerGatewayId+ - (String) Specifies ID of the + * customer gateway at the end of the VPN connection. + * * +VpnGatewayId+ - (String) Specfies the ID of the VPN + * gateway at the VPC end of the VPN connection. + * * +tags+ - (Array) A list of tags for the + * VpnConnection. + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * * +vgwTelemetry+ - (Array) + * * +outsideIpAddress+ - (String) + * * +status+ - (String) + * * +lastStatusChange+ - (Date) + * * +statusMessage+ - (String) + * * +acceptedRouteCount+ - (Integer) + * * +options+ - (Object) + * * +staticRoutesOnly+ - (Boolean) + * * +routes+ - (Array) + * * +destinationCidrBlock+ - (String) + * * +source+ - (String) + * * +state+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method describeVpnGateways(params, callback) * Gives you information about your VPN gateways. You can filter the * results to return information only about VPN gateways that match * criteria you specify. - * @param [Object] params + * @param params [Object] * * +VpnGatewayIds+ - (Array) A list of filters * used to match properties for VPN Gateways. For a complete * reference to the available filter keys for this operation, see @@ -3181,53 +3927,76 @@ AWS.EC2 = inherit({}) * * +Name+ - (String) Specifies the name of the filter. * * +Values+ - (Array) Contains one or more * values for the filter. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +VpnGateways+ - (Array) - * * +VpnGatewayId+ - (String) Specifies the ID of the VPN - * gateway. - * * +State+ - (String) Describes the current state of the - * VPN gateway. Valid values are pending, available, deleting, - * and deleted. - * * +Type+ - (String) Specifies the type of VPN - * connection the VPN gateway supports. - * * +AvailabilityZone+ - (String) Specifies the - * Availability Zone where the VPN gateway was created. - * * +VpcAttachments+ - (Array) Contains - * information about the VPCs attached to the VPN gateway. - * * +VpcId+ - (String) - * * +State+ - (String) - * * +tags+ - (Array) A list of tags for the - * VpnGateway. - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +VpnGateways+ - (Array) + * * +VpnGatewayId+ - (String) Specifies the ID of the VPN + * gateway. + * * +State+ - (String) Describes the current state of the + * VPN gateway. Valid values are pending, available, deleting, + * and deleted. + * * +Type+ - (String) Specifies the type of VPN + * connection the VPN gateway supports. + * * +AvailabilityZone+ - (String) Specifies the + * Availability Zone where the VPN gateway was created. + * * +VpcAttachments+ - (Array) Contains + * information about the VPCs attached to the VPN gateway. + * * +VpcId+ - (String) + * * +State+ - (String) + * * +tags+ - (Array) A list of tags for the + * VpnGateway. + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method detachInternetGateway(params, options) + * @!method detachInternetGateway(params, callback) * Detaches an Internet gateway from a VPC, disabling connectivity * between the Internet and the VPC. The VPC must not contain any * running instances with elastic IP addresses. For more information * about your VPC and Internet gateway, go to Amazon Virtual Private * Cloud User Guide. - * @param [Object] params + * @param params [Object] * * +internetGatewayId+ - (*required*, String) The ID of * the Internet gateway to detach. * * +vpcId+ - (*required*, String) The ID of the VPC. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method detachNetworkInterface(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method detachNetworkInterface(params, callback) * Calls the DetachNetworkInterface API operation. - * @param [Object] params + * @param params [Object] * * +attachmentId+ - (*required*, String) * * +force+ - (Boolean) - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method detachVolume(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method detachVolume(params, callback) * Detach a previously attached volume from a running instance. - * @param [Object] params + * @param params [Object] * * +VolumeId+ - (*required*, String) The ID of the volume * to detach. * * +InstanceId+ - (String) The ID of the instance from @@ -3237,116 +4006,185 @@ AWS.EC2 = inherit({}) * * +Force+ - (Boolean) Forces detachment if the previous * detachment attempt did not occur cleanly (logging into an * instance, unmounting the volume, and detaching normally). - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Attachment+ - (Object) The updated EBS volume - * attachment information after trying to detach the volume from - * the specified instance. - * * +VolumeId+ - (String) - * * +InstanceId+ - (String) - * * +Device+ - (String) How the device is exposed to the - * instance (e.g., /dev/sdh). - * * +State+ - (String) - * * +AttachTime+ - (Date) Timestamp when this attachment - * initiated. - * * +deleteOnTermination+ - (Boolean) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Attachment+ - (Object) The updated EBS volume + * attachment information after trying to detach the volume from + * the specified instance. + * * +VolumeId+ - (String) + * * +InstanceId+ - (String) + * * +Device+ - (String) How the device is exposed to the + * instance (e.g., /dev/sdh). + * * +State+ - (String) + * * +AttachTime+ - (Date) Timestamp when this attachment + * initiated. + * * +deleteOnTermination+ - (Boolean) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method detachVpnGateway(params, options) + * @!method detachVpnGateway(params, callback) * Detaches a VPN gateway from a VPC. You do this if you're planning to * turn off the VPC and not use it anymore. You can confirm a VPN * gateway has been completely detached from a VPC by describing the * VPN gateway (any attachments to the VPN gateway are also described). - * @param [Object] params + * @param params [Object] * * +VpnGatewayId+ - (*required*, String) The ID of the VPN * gateway to detach from the VPC. * * +VpcId+ - (*required*, String) The ID of the VPC to * detach the VPN gateway from. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method disableVgwRoutePropagation(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method disableVgwRoutePropagation(params, callback) * Calls the DisableVgwRoutePropagation API operation. - * @param [Object] params + * @param params [Object] * * +RouteTableId+ - (*required*, String) * * +GatewayId+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method disassociateAddress(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method disassociateAddress(params, callback) * The DisassociateAddress operation disassociates the specified * elastic IP address from the instance to which it is assigned. This * is an idempotent operation. If you enter it more than once, Amazon * EC2 does not return an error. - * @param [Object] params + * @param params [Object] * * +PublicIp+ - (*required*, String) The elastic IP * address that you are disassociating from the instance. * * +AssociationId+ - (String) Association ID corresponding * to the VPC elastic IP address you want to disassociate. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method disassociateRouteTable(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method disassociateRouteTable(params, callback) * Disassociates a subnet from a route table. - * @param [Object] params + * @param params [Object] * * +associationId+ - (*required*, String) The association * ID representing the current association between the route table * and subnet. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method enableVgwRoutePropagation(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method enableVgwRoutePropagation(params, callback) * Calls the EnableVgwRoutePropagation API operation. - * @param [Object] params + * @param params [Object] * * +RouteTableId+ - (*required*, String) * * +GatewayId+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method enableVolumeIO(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method enableVolumeIO(params, callback) * Enable IO on the volume after an event has occured. - * @param [Object] params + * @param params [Object] * * +volumeId+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method getConsoleOutput(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method getConsoleOutput(params, callback) * The GetConsoleOutput operation retrieves console output for the * specified instance. - * @param [Object] params + * @param params [Object] * * +InstanceId+ - (*required*, String) The ID of the * instance for which you want console output. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +InstanceId+ - (String) The ID of the instance whose - * console output was requested. - * * +Timestamp+ - (Date) The time the output was last - * updated. - * * +Output+ - (String) The console output, Base64 encoded. - * - * @!method getPasswordData(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +InstanceId+ - (String) The ID of the instance whose + * console output was requested. + * * +Timestamp+ - (Date) The time the output was last + * updated. + * * +Output+ - (String) The console output, Base64 encoded. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method getPasswordData(params, callback) * Retrieves the encrypted administrator password for the instances * running Windows. - * @param [Object] params + * @param params [Object] * * +InstanceId+ - (*required*, String) The ID of the * instance for which you want the Windows administrator password. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +InstanceId+ - (String) The ID of the instance whose - * Windows administrator password was requested. - * * +Timestamp+ - (Date) The time the data was last - * updated. - * * +PasswordData+ - (String) The Windows administrator - * password of the specified instance. - * - * @!method importInstance(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +InstanceId+ - (String) The ID of the instance whose + * Windows administrator password was requested. + * * +Timestamp+ - (Date) The time the data was last + * updated. + * * +PasswordData+ - (String) The Windows administrator + * password of the specified instance. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method importInstance(params, callback) * Calls the ImportInstance API operation. - * @param [Object] params + * @param params [Object] * * +description+ - (String) * * +launchSpecification+ - (Object) * * +architecture+ - (String) @@ -3401,17 +4239,40 @@ AWS.EC2 = inherit({}) * * +Volume+ - (Object) * * +size+ - (*required*, Integer) * * +platform+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +conversionTask+ - (Object) - * * +conversionTaskId+ - (String) - * * +expirationTime+ - (String) - * * +importInstance+ - (Object) - * * +volumes+ - (Array) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +conversionTask+ - (Object) + * * +conversionTaskId+ - (String) + * * +expirationTime+ - (String) + * * +importInstance+ - (Object) + * * +volumes+ - (Array) + * * +bytesConverted+ - (Integer) + * * +availabilityZone+ - (String) + * * +image+ - (Object) + * * +format+ - (String) + * * +size+ - (Integer) + * * +importManifestUrl+ - (String) + * * +checksum+ - (String) + * * +volume+ - (Object) + * * +size+ - (Integer) + * * +id+ - (String) + * * +status+ - (String) + * * +statusMessage+ - (String) + * * +description+ - (String) + * * +instanceId+ - (String) + * * +platform+ - (String) + * * +description+ - (String) + * * +importVolume+ - (Object) * * +bytesConverted+ - (Integer) * * +availabilityZone+ - (String) + * * +description+ - (String) * * +image+ - (Object) * * +format+ - (String) * * +size+ - (Integer) @@ -3420,51 +4281,42 @@ AWS.EC2 = inherit({}) * * +volume+ - (Object) * * +size+ - (Integer) * * +id+ - (String) - * * +status+ - (String) - * * +statusMessage+ - (String) - * * +description+ - (String) - * * +instanceId+ - (String) - * * +platform+ - (String) - * * +description+ - (String) - * * +importVolume+ - (Object) - * * +bytesConverted+ - (Integer) - * * +availabilityZone+ - (String) - * * +description+ - (String) - * * +image+ - (Object) - * * +format+ - (String) - * * +size+ - (Integer) - * * +importManifestUrl+ - (String) - * * +checksum+ - (String) - * * +volume+ - (Object) - * * +size+ - (Integer) - * * +id+ - (String) - * * +state+ - (String) - * * +statusMessage+ - (String) - * * +tags+ - (Array) - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. + * * +state+ - (String) + * * +statusMessage+ - (String) + * * +tags+ - (Array) + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method importKeyPair(params, options) + * @!method importKeyPair(params, callback) * Imports the public key from an RSA key pair created with a * third-party tool. This operation differs from CreateKeyPair as the * private key is never transferred between the caller and AWS servers. - * @param [Object] params + * @param params [Object] * * +keyName+ - (*required*, String) The unique name for * the key pair. * * +publicKeyMaterial+ - (*required*, String) The public * key portion of the key pair being imported. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +keyName+ - (String) The specified unique key pair - * name. - * * +keyFingerprint+ - (String) The MD5 public key - * fingerprint as specified in section 4 of RFC4716 . - * - * @!method importVolume(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +keyName+ - (String) The specified unique key pair + * name. + * * +keyFingerprint+ - (String) The MD5 public key + * fingerprint as specified in section 4 of RFC4716 . + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method importVolume(params, callback) * Calls the ImportVolume API operation. - * @param [Object] params + * @param params [Object] * * +availabilityZone+ - (String) * * +image+ - (Object) * * +format+ - (*required*, String) @@ -3473,17 +4325,40 @@ AWS.EC2 = inherit({}) * * +description+ - (String) * * +volume+ - (Object) * * +size+ - (*required*, Integer) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +conversionTask+ - (Object) - * * +conversionTaskId+ - (String) - * * +expirationTime+ - (String) - * * +importInstance+ - (Object) - * * +volumes+ - (Array) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +conversionTask+ - (Object) + * * +conversionTaskId+ - (String) + * * +expirationTime+ - (String) + * * +importInstance+ - (Object) + * * +volumes+ - (Array) + * * +bytesConverted+ - (Integer) + * * +availabilityZone+ - (String) + * * +image+ - (Object) + * * +format+ - (String) + * * +size+ - (Integer) + * * +importManifestUrl+ - (String) + * * +checksum+ - (String) + * * +volume+ - (Object) + * * +size+ - (Integer) + * * +id+ - (String) + * * +status+ - (String) + * * +statusMessage+ - (String) + * * +description+ - (String) + * * +instanceId+ - (String) + * * +platform+ - (String) + * * +description+ - (String) + * * +importVolume+ - (Object) * * +bytesConverted+ - (Integer) * * +availabilityZone+ - (String) + * * +description+ - (String) * * +image+ - (Object) * * +format+ - (String) * * +size+ - (Integer) @@ -3492,33 +4367,17 @@ AWS.EC2 = inherit({}) * * +volume+ - (Object) * * +size+ - (Integer) * * +id+ - (String) - * * +status+ - (String) - * * +statusMessage+ - (String) - * * +description+ - (String) - * * +instanceId+ - (String) - * * +platform+ - (String) - * * +description+ - (String) - * * +importVolume+ - (Object) - * * +bytesConverted+ - (Integer) - * * +availabilityZone+ - (String) - * * +description+ - (String) - * * +image+ - (Object) - * * +format+ - (String) - * * +size+ - (Integer) - * * +importManifestUrl+ - (String) - * * +checksum+ - (String) - * * +volume+ - (Object) - * * +size+ - (Integer) - * * +id+ - (String) - * * +state+ - (String) - * * +statusMessage+ - (String) - * * +tags+ - (Array) - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. + * * +state+ - (String) + * * +statusMessage+ - (String) + * * +tags+ - (Array) + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method modifyImageAttribute(params, options) + * @!method modifyImageAttribute(params, callback) * The ModifyImageAttribute operation modifies an attribute of an AMI. - * @param [Object] params + * @param params [Object] * * +ImageId+ - (*required*, String) The ID of the AMI * whose attribute you want to modify. * * +Attribute+ - (String) The name of the AMI attribute @@ -3552,12 +4411,20 @@ AWS.EC2 = inherit({}) * involved in this launch permission. * * +Description+ - (Object) * * +value+ - (String) - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method modifyInstanceAttribute(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method modifyInstanceAttribute(params, callback) * Modifies an attribute of an instance. - * @param [Object] params + * @param params [Object] * * +instanceId+ - (*required*, String) The ID of the * instance whose attribute is being modified. * * +attribute+ - (String) The name of the attribute being @@ -3599,12 +4466,20 @@ AWS.EC2 = inherit({}) * * +groups+ - (Array) * * +ebsOptimized+ - (Object) * * +value+ - (Boolean) - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method modifyNetworkInterfaceAttribute(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method modifyNetworkInterfaceAttribute(params, callback) * Calls the ModifyNetworkInterfaceAttribute API operation. - * @param [Object] params + * @param params [Object] * * +networkInterfaceId+ - (*required*, String) * * +description+ - (Object) * * +value+ - (String) @@ -3614,12 +4489,20 @@ AWS.EC2 = inherit({}) * * +attachment+ - (Object) * * +attachmentId+ - (String) * * +deleteOnTermination+ - (Boolean) - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method modifySnapshotAttribute(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method modifySnapshotAttribute(params, callback) * Adds or remove permission settings for the specified snapshot. - * @param [Object] params + * @param params [Object] * * +SnapshotId+ - (*required*, String) The ID of the EBS * snapshot whose attributes are being modified. * * +Attribute+ - (String) The name of the attribute being @@ -3645,42 +4528,65 @@ AWS.EC2 = inherit({}) * can create volumes from the snapshot. * * +Group+ - (String) The group that is allowed to * create volumes from the snapshot (currently supports "all"). - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method modifyVolumeAttribute(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method modifyVolumeAttribute(params, callback) * Calls the ModifyVolumeAttribute API operation. - * @param [Object] params + * @param params [Object] * * +VolumeId+ - (*required*, String) * * +AutoEnableIO+ - (Boolean) - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method monitorInstances(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method monitorInstances(params, callback) * Enables monitoring for a running instance. - * @param [Object] params + * @param params [Object] * * +InstanceIds+ - (*required*, Array) The list of * Amazon EC2 instances on which to enable monitoring. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +InstanceMonitorings+ - (Array) A list of - * updated monitoring information for the instances specified in - * the request. - * * +InstanceId+ - (String) Instance ID. - * * +Monitoring+ - (Object) Monitoring state for the - * associated instance. - * * +State+ - (String) The state of monitoring on an - * Amazon EC2 instance (ex: enabled, disabled). + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +InstanceMonitorings+ - (Array) A list of + * updated monitoring information for the instances specified in + * the request. + * * +InstanceId+ - (String) Instance ID. + * * +Monitoring+ - (Object) Monitoring state for the + * associated instance. + * * +State+ - (String) The state of monitoring on an + * Amazon EC2 instance (ex: enabled, disabled). + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method purchaseReservedInstancesOffering(params, options) + * @!method purchaseReservedInstancesOffering(params, callback) * The PurchaseReservedInstancesOffering operation purchases a Reserved * Instance for use with your account. With Amazon EC2 Reserved * Instances, you purchase the right to launch Amazon EC2 instances for * a period of time (without getting insufficient capacity errors) and * pay a lower usage rate for the actual time used. - * @param [Object] params + * @param params [Object] * * +ReservedInstancesOfferingId+ - (*required*, String) * The unique ID of the Reserved Instances offering being * purchased. @@ -3689,30 +4595,45 @@ AWS.EC2 = inherit({}) * * +limitPrice+ - (Object) * * +amount+ - (Float) * * +currencyCode+ - (String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +ReservedInstancesId+ - (String) The unique ID of the - * Reserved Instances purchased for your account. - * - * @!method rebootInstances(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +ReservedInstancesId+ - (String) The unique ID of the + * Reserved Instances purchased for your account. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method rebootInstances(params, callback) * The RebootInstances operation requests a reboot of one or more * instances. This operation is asynchronous; it only queues a request * to reboot the specified instance(s). The operation will succeed if * the instances are valid and belong to the user. Requests to reboot * terminated instances are ignored. - * @param [Object] params + * @param params [Object] * * +InstanceIds+ - (*required*, Array) The list of * instances to terminate. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method registerImage(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method registerImage(params, callback) * The RegisterImage operation registers an AMI with Amazon EC2. Images * must be registered before they can be launched. For more * information, see RunInstances. - * @param [Object] params + * @param params [Object] * * +ImageLocation+ - (String) * * +name+ - (String) The name to give the new Amazon * Machine Image. @@ -3744,46 +4665,68 @@ AWS.EC2 = inherit({}) * * +iops+ - (Integer) * * +noDevice+ - (String) Specifies the device name to * suppress during instance launch. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +ImageId+ - (String) The ID of the new Amazon Machine - * Image (AMI). - * - * @!method releaseAddress(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +ImageId+ - (String) The ID of the new Amazon Machine + * Image (AMI). + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method releaseAddress(params, callback) * The ReleaseAddress operation releases an elastic IP address * associated with your account. - * @param [Object] params + * @param params [Object] * * +PublicIp+ - (String) The elastic IP address that you * are releasing from your account. * * +AllocationId+ - (String) The allocation ID that AWS * provided when you allocated the address for use with Amazon VPC. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method replaceNetworkAclAssociation(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method replaceNetworkAclAssociation(params, callback) * Changes which network ACL a subnet is associated with. By default * when you create a subnet, it's automatically associated with the * default network ACL. For more information about network ACLs, go to * Network ACLs in the Amazon Virtual Private Cloud User Guide. - * @param [Object] params + * @param params [Object] * * +associationId+ - (*required*, String) The ID * representing the current association between the original * network ACL and the subnet. * * +networkAclId+ - (*required*, String) The ID of the new * ACL to associate with the subnet. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +newAssociationId+ - (String) - * - * @!method replaceNetworkAclEntry(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +newAssociationId+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method replaceNetworkAclEntry(params, callback) * Replaces an entry (i.e., rule) in a network ACL. For more * information about network ACLs, go to Network ACLs in the Amazon * Virtual Private Cloud User Guide. - * @param [Object] params + * @param params [Object] * * +networkAclId+ - (*required*, String) ID of the ACL * where the entry will be replaced. * * +ruleNumber+ - (*required*, Integer) Rule number of the @@ -3810,14 +4753,22 @@ AWS.EC2 = inherit({}) * Required if specifying tcp or udp for the protocol. * * +to+ - (Integer) The last port in the range. Required * if specifying tcp or udp for the protocol. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method replaceRoute(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method replaceRoute(params, callback) * Replaces an existing route within a route table in a VPC. For more * information about route tables, go to Route Tables in the Amazon * Virtual Private Cloud User Guide. - * @param [Object] params + * @param params [Object] * * +routeTableId+ - (*required*, String) The ID of the * route table where the route will be replaced. * * +destinationCidrBlock+ - (*required*, String) The CIDR @@ -3829,42 +4780,65 @@ AWS.EC2 = inherit({}) * * +instanceId+ - (String) The ID of a NAT instance in * your VPC. * * +networkInterfaceId+ - (String) - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method replaceRouteTableAssociation(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method replaceRouteTableAssociation(params, callback) * Changes the route table associated with a given subnet in a VPC. * After you execute this action, the subnet uses the routes in the new * route table it's associated with. For more information about route * tables, go to Route Tables in the Amazon Virtual Private Cloud User * Guide. - * @param [Object] params + * @param params [Object] * * +associationId+ - (*required*, String) The ID * representing the current association between the original route * table and the subnet. * * +routeTableId+ - (*required*, String) The ID of the new * route table to associate with the subnet. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +newAssociationId+ - (String) - * - * @!method reportInstanceStatus(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +newAssociationId+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method reportInstanceStatus(params, callback) * Calls the ReportInstanceStatus API operation. - * @param [Object] params + * @param params [Object] * * +instances+ - (Array) * * +status+ - (String) * * +startTime+ - (Date) * * +endTime+ - (Date) * * +reasonCodes+ - (Array) * * +description+ - (String) - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method requestSpotInstances(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method requestSpotInstances(params, callback) * Creates a Spot Instance request. - * @param [Object] params + * @param params [Object] * * +spotPrice+ - (*required*, String) Specifies the * maximum hourly price for any Spot Instance launched to fulfill * the request. @@ -3951,149 +4925,188 @@ AWS.EC2 = inherit({}) * * +arn+ - (String) * * +name+ - (String) * * +ebsOptimized+ - (Boolean) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +spotInstanceRequests+ - (Array) Contains a - * list of Spot Instance requests. - * * +spotInstanceRequestId+ - (String) - * * +spotPrice+ - (String) - * * +type+ - (String) - * * +state+ - (String) - * * +fault+ - (Object) - * * +code+ - (String) - * * +message+ - (String) - * * +validFrom+ - (Date) - * * +validUntil+ - (Date) - * * +launchGroup+ - (String) - * * +availabilityZoneGroup+ - (String) - * * +launchSpecification+ - (Object) - * * +imageId+ - (String) The AMI ID. - * * +keyName+ - (String) The name of the key pair. - * * +SecurityGroups+ - (Array) - * * +GroupName+ - (String) - * * +groupId+ - (String) - * * +userData+ - (String) Optional data, specific to a - * user's application, to provide in the launch request. All - * instances that collectively comprise the launch request have - * access to this data. User data is never returned through API - * responses. - * * +addressingType+ - (String) Deprecated. - * * +instanceType+ - (String) Specifies the instance - * type. - * * +placement+ - (Object) Defines a placement item. - * * +availabilityZone+ - (String) The availability - * zone in which an Amazon EC2 instance runs. - * * +groupName+ - (String) The name of the - * PlacementGroup in which an Amazon EC2 instance runs. - * Placement groups are primarily used for launching High - * Performance Computing instances in the same group to - * ensure fast connection speeds. - * * +kernelId+ - (String) Specifies the ID of the - * kernel to select. - * * +ramdiskId+ - (String) Specifies the ID of the RAM - * disk to select. Some kernels require additional drivers at - * launch. Check the kernel requirements for information on - * whether or not you need to specify a RAM disk and search for - * the kernel ID. - * * +blockDeviceMappings+ - (Array) Specifies - * how block devices are exposed to the instance. Each mapping - * is made up of a virtualName and a deviceName. - * * +VirtualName+ - (String) Specifies the virtual - * device name. - * * +DeviceName+ - (String) Specifies the device name - * (e.g., /dev/sdh). - * * +ebs+ - (Object) Specifies parameters used to - * automatically setup Amazon EBS volumes when the instance - * is launched. - * * +snapshotId+ - (String) The ID of the snapshot - * from which the volume will be created. - * * +volumeSize+ - (Integer) The size of the - * volume, in gigabytes. - * * +deleteOnTermination+ - (Boolean) Specifies - * whether the Amazon EBS volume is deleted on instance - * termination. - * * +volumeType+ - (String) - * * +iops+ - (Integer) - * * +noDevice+ - (String) Specifies the device name - * to suppress during instance launch. - * * +monitoringEnabled+ - (Boolean) Enables monitoring - * for the instance. - * * +subnetId+ - (String) Specifies the Amazon VPC - * subnet ID within which to launch the instance(s) for Amazon - * Virtual Private Cloud. - * * +networkInterfaces+ - (Array) - * * +networkInterfaceId+ - (String) - * * +deviceIndex+ - (Integer) - * * +subnetId+ - (String) - * * +description+ - (String) - * * +privateIpAddress+ - (String) - * * +groups+ - (Array) - * * +deleteOnTermination+ - (Boolean) - * * +privateIpAddresses+ - (Array) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +spotInstanceRequests+ - (Array) Contains a + * list of Spot Instance requests. + * * +spotInstanceRequestId+ - (String) + * * +spotPrice+ - (String) + * * +type+ - (String) + * * +state+ - (String) + * * +fault+ - (Object) + * * +code+ - (String) + * * +message+ - (String) + * * +validFrom+ - (Date) + * * +validUntil+ - (Date) + * * +launchGroup+ - (String) + * * +availabilityZoneGroup+ - (String) + * * +launchSpecification+ - (Object) + * * +imageId+ - (String) The AMI ID. + * * +keyName+ - (String) The name of the key pair. + * * +SecurityGroups+ - (Array) + * * +GroupName+ - (String) + * * +groupId+ - (String) + * * +userData+ - (String) Optional data, specific to a + * user's application, to provide in the launch request. All + * instances that collectively comprise the launch request have + * access to this data. User data is never returned through API + * responses. + * * +addressingType+ - (String) Deprecated. + * * +instanceType+ - (String) Specifies the instance + * type. + * * +placement+ - (Object) Defines a placement item. + * * +availabilityZone+ - (String) The availability + * zone in which an Amazon EC2 instance runs. + * * +groupName+ - (String) The name of the + * PlacementGroup in which an Amazon EC2 instance runs. + * Placement groups are primarily used for launching High + * Performance Computing instances in the same group to + * ensure fast connection speeds. + * * +kernelId+ - (String) Specifies the ID of the + * kernel to select. + * * +ramdiskId+ - (String) Specifies the ID of the RAM + * disk to select. Some kernels require additional drivers at + * launch. Check the kernel requirements for information on + * whether or not you need to specify a RAM disk and search for + * the kernel ID. + * * +blockDeviceMappings+ - (Array) Specifies + * how block devices are exposed to the instance. Each mapping + * is made up of a virtualName and a deviceName. + * * +VirtualName+ - (String) Specifies the virtual + * device name. + * * +DeviceName+ - (String) Specifies the device name + * (e.g., /dev/sdh). + * * +ebs+ - (Object) Specifies parameters used to + * automatically setup Amazon EBS volumes when the instance + * is launched. + * * +snapshotId+ - (String) The ID of the snapshot + * from which the volume will be created. + * * +volumeSize+ - (Integer) The size of the + * volume, in gigabytes. + * * +deleteOnTermination+ - (Boolean) Specifies + * whether the Amazon EBS volume is deleted on instance + * termination. + * * +volumeType+ - (String) + * * +iops+ - (Integer) + * * +noDevice+ - (String) Specifies the device name + * to suppress during instance launch. + * * +monitoringEnabled+ - (Boolean) Enables monitoring + * for the instance. + * * +subnetId+ - (String) Specifies the Amazon VPC + * subnet ID within which to launch the instance(s) for Amazon + * Virtual Private Cloud. + * * +networkInterfaces+ - (Array) + * * +networkInterfaceId+ - (String) + * * +deviceIndex+ - (Integer) + * * +subnetId+ - (String) + * * +description+ - (String) * * +privateIpAddress+ - (String) - * * +primary+ - (Boolean) - * * +secondaryPrivateIpAddressCount+ - (Integer) - * * +iamInstanceProfile+ - (Object) - * * +arn+ - (String) - * * +name+ - (String) - * * +ebsOptimized+ - (Boolean) - * * +instanceId+ - (String) - * * +createTime+ - (Date) - * * +productDescription+ - (String) - * * +tags+ - (Array) A list of tags for this spot - * instance request. - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. - * * +launchedAvailabilityZone+ - (String) The - * Availability Zone in which the bid is launched. + * * +groups+ - (Array) + * * +deleteOnTermination+ - (Boolean) + * * +privateIpAddresses+ - (Array) + * * +privateIpAddress+ - (String) + * * +primary+ - (Boolean) + * * +secondaryPrivateIpAddressCount+ - (Integer) + * * +iamInstanceProfile+ - (Object) + * * +arn+ - (String) + * * +name+ - (String) + * * +ebsOptimized+ - (Boolean) + * * +instanceId+ - (String) + * * +createTime+ - (Date) + * * +productDescription+ - (String) + * * +tags+ - (Array) A list of tags for this spot + * instance request. + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * * +launchedAvailabilityZone+ - (String) The + * Availability Zone in which the bid is launched. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method resetImageAttribute(params, options) + * @!method resetImageAttribute(params, callback) * The ResetImageAttribute operation resets an attribute of an AMI to * its default value. - * @param [Object] params + * @param params [Object] * * +ImageId+ - (*required*, String) The ID of the AMI * whose attribute is being reset. * * +Attribute+ - (*required*, String) The name of the * attribute being reset. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method resetInstanceAttribute(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method resetInstanceAttribute(params, callback) * Resets an attribute of an instance to its default value. - * @param [Object] params + * @param params [Object] * * +instanceId+ - (*required*, String) The ID of the * Amazon EC2 instance whose attribute is being reset. * * +attribute+ - (*required*, String) The name of the * attribute being reset. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method resetNetworkInterfaceAttribute(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method resetNetworkInterfaceAttribute(params, callback) * Calls the ResetNetworkInterfaceAttribute API operation. - * @param [Object] params + * @param params [Object] * * +networkInterfaceId+ - (*required*, String) * * +sourceDestCheck+ - (String) - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method resetSnapshotAttribute(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method resetSnapshotAttribute(params, callback) * Resets permission settings for the specified snapshot. - * @param [Object] params + * @param params [Object] * * +SnapshotId+ - (*required*, String) The ID of the * snapshot whose attribute is being reset. * * +Attribute+ - (*required*, String) The name of the * attribute being reset. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method revokeSecurityGroupEgress(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method revokeSecurityGroupEgress(params, callback) * This action applies only to security groups in a VPC. It doesn't * work with EC2 security groups. For information about Amazon Virtual * Private Cloud and VPC security groups, go to the Amazon Virtual * Private Cloud User Guide. - * @param [Object] params + * @param params [Object] * * +groupId+ - (*required*, String) ID of the VPC security * group to modify. * * +sourceSecurityGroupName+ - (String) Deprecated. @@ -4128,14 +5141,22 @@ AWS.EC2 = inherit({}) * * +IpRanges+ - (Array) The list of CIDR IP * ranges included in this permission. * * +CidrIp+ - (String) The list of CIDR IP ranges. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method revokeSecurityGroupIngress(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method revokeSecurityGroupIngress(params, callback) * The RevokeSecurityGroupIngress operation revokes permissions from a * security group. The permissions used to revoke must be specified * using the same values used to grant the permissions. - * @param [Object] params + * @param params [Object] * * +GroupName+ - (String) Name of the standard (EC2) * security group to modify. The group must belong to your account. * Can be used instead of GroupID for standard (EC2) security @@ -4177,12 +5198,20 @@ AWS.EC2 = inherit({}) * * +IpRanges+ - (Array) The list of CIDR IP * ranges included in this permission. * * +CidrIp+ - (String) The list of CIDR IP ranges. - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method runInstances(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method runInstances(params, callback) * The RunInstances operation launches a specified number of instances. - * @param [Object] params + * @param params [Object] * * +ImageId+ - (*required*, String) Unique ID of a machine * image, returned by a call to DescribeImages. * * +MinCount+ - (*required*, Integer) Minimum number of @@ -4286,167 +5315,174 @@ AWS.EC2 = inherit({}) * * +arn+ - (String) * * +name+ - (String) * * +ebsOptimized+ - (Boolean) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Reservation+ - (Object) The newly created reservation, - * containing the new instances. - * * +ReservationId+ - (String) The unique ID of this - * reservation. - * * +OwnerId+ - (String) The AWS Access Key ID of the - * user who owns the reservation. - * * +RequesterId+ - (String) The unique ID of the user - * who requested the instances in this reservation. - * * +Groups+ - (Array) The list of security - * groups requested for the instances in this reservation. - * * +GroupName+ - (String) - * * +groupId+ - (String) - * * +Instances+ - (Array) The list of Amazon EC2 - * instances included in this reservation. - * * +InstanceId+ - (String) Unique ID of the instance - * launched. - * * +ImageId+ - (String) Image ID of the AMI used to - * launch the instance. - * * +State+ - (Object) The current state of the - * instance. - * * +Code+ - (Integer) A 16-bit unsigned integer. The - * high byte is an opaque internal value and should be - * ignored. The low byte is set based on the state - * represented. - * * +Name+ - (String) The current state of the + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Reservation+ - (Object) The newly created reservation, + * containing the new instances. + * * +ReservationId+ - (String) The unique ID of this + * reservation. + * * +OwnerId+ - (String) The AWS Access Key ID of the + * user who owns the reservation. + * * +RequesterId+ - (String) The unique ID of the user + * who requested the instances in this reservation. + * * +Groups+ - (Array) The list of security + * groups requested for the instances in this reservation. + * * +GroupName+ - (String) + * * +groupId+ - (String) + * * +Instances+ - (Array) The list of Amazon EC2 + * instances included in this reservation. + * * +InstanceId+ - (String) Unique ID of the instance + * launched. + * * +ImageId+ - (String) Image ID of the AMI used to + * launch the instance. + * * +State+ - (Object) The current state of the * instance. - * * +PrivateDnsName+ - (String) The private DNS name - * assigned to the instance. This DNS name can only be used - * inside the Amazon EC2 network. This element remains empty - * until the instance enters a running state. - * * +PublicDnsName+ - (String) The public DNS name - * assigned to the instance. This DNS name is contactable from - * outside the Amazon EC2 network. This element remains empty - * until the instance enters a running state. - * * +StateTransitionReason+ - (String) Reason for the - * most recent state transition. This might be an empty string. - * * +KeyName+ - (String) If this instance was launched - * with an associated key pair, this displays the key pair - * name. - * * +AmiLaunchIndex+ - (Integer) The AMI launch index, - * which can be used to find this instance within the launch - * group. - * * +ProductCodes+ - (Array) Product codes - * attached to this instance. - * * +ProductCodeId+ - (String) The unique ID of an - * AWS DevPay product code. - * * +ProductCodeType+ - (String) - * * +InstanceType+ - (String) The instance type. For - * more information on instance types, please see the Amazon - * Elastic Compute Cloud Developer Guide. - * * +LaunchTime+ - (Date) The time this instance - * launched. - * * +Placement+ - (Object) The location where this - * instance launched. - * * +AvailabilityZone+ - (String) The availability - * zone in which an Amazon EC2 instance runs. - * * +groupName+ - (String) The name of the - * PlacementGroup in which an Amazon EC2 instance runs. - * Placement groups are primarily used for launching High - * Performance Computing instances in the same group to - * ensure fast connection speeds. - * * +tenancy+ - (String) The allowed tenancy of - * instances launched into the VPC. A value of default means - * instances can be launched with any tenancy; a value of - * dedicated means all instances launched into the VPC will - * be launched as dedicated tenancy regardless of the tenancy - * assigned to the instance at launch. - * * +KernelId+ - (String) Kernel associated with this - * instance. - * * +RamdiskId+ - (String) RAM disk associated with - * this instance. - * * +Platform+ - (String) Platform of the instance - * (e.g., Windows). - * * +Monitoring+ - (Object) Monitoring status for this - * instance. - * * +State+ - (String) The state of monitoring on an - * Amazon EC2 instance (ex: enabled, disabled). - * * +SubnetId+ - (String) Specifies the Amazon VPC - * subnet ID in which the instance is running. - * * +VpcId+ - (String) Specifies the Amazon VPC in - * which the instance is running. - * * +PrivateIpAddress+ - (String) Specifies the private - * IP address that is assigned to the instance (Amazon VPC). - * * +PublicIpAddress+ - (String) Specifies the IP - * address of the instance. - * * +stateReason+ - (Object) The reason for the state - * change. - * * +code+ - (String) Reason code for the state + * * +Code+ - (Integer) A 16-bit unsigned integer. The + * high byte is an opaque internal value and should be + * ignored. The low byte is set based on the state + * represented. + * * +Name+ - (String) The current state of the + * instance. + * * +PrivateDnsName+ - (String) The private DNS name + * assigned to the instance. This DNS name can only be used + * inside the Amazon EC2 network. This element remains empty + * until the instance enters a running state. + * * +PublicDnsName+ - (String) The public DNS name + * assigned to the instance. This DNS name is contactable from + * outside the Amazon EC2 network. This element remains empty + * until the instance enters a running state. + * * +StateTransitionReason+ - (String) Reason for the + * most recent state transition. This might be an empty string. + * * +KeyName+ - (String) If this instance was launched + * with an associated key pair, this displays the key pair + * name. + * * +AmiLaunchIndex+ - (Integer) The AMI launch index, + * which can be used to find this instance within the launch + * group. + * * +ProductCodes+ - (Array) Product codes + * attached to this instance. + * * +ProductCodeId+ - (String) The unique ID of an + * AWS DevPay product code. + * * +ProductCodeType+ - (String) + * * +InstanceType+ - (String) The instance type. For + * more information on instance types, please see the Amazon + * Elastic Compute Cloud Developer Guide. + * * +LaunchTime+ - (Date) The time this instance + * launched. + * * +Placement+ - (Object) The location where this + * instance launched. + * * +AvailabilityZone+ - (String) The availability + * zone in which an Amazon EC2 instance runs. + * * +groupName+ - (String) The name of the + * PlacementGroup in which an Amazon EC2 instance runs. + * Placement groups are primarily used for launching High + * Performance Computing instances in the same group to + * ensure fast connection speeds. + * * +tenancy+ - (String) The allowed tenancy of + * instances launched into the VPC. A value of default means + * instances can be launched with any tenancy; a value of + * dedicated means all instances launched into the VPC will + * be launched as dedicated tenancy regardless of the tenancy + * assigned to the instance at launch. + * * +KernelId+ - (String) Kernel associated with this + * instance. + * * +RamdiskId+ - (String) RAM disk associated with + * this instance. + * * +Platform+ - (String) Platform of the instance + * (e.g., Windows). + * * +Monitoring+ - (Object) Monitoring status for this + * instance. + * * +State+ - (String) The state of monitoring on an + * Amazon EC2 instance (ex: enabled, disabled). + * * +SubnetId+ - (String) Specifies the Amazon VPC + * subnet ID in which the instance is running. + * * +VpcId+ - (String) Specifies the Amazon VPC in + * which the instance is running. + * * +PrivateIpAddress+ - (String) Specifies the private + * IP address that is assigned to the instance (Amazon VPC). + * * +PublicIpAddress+ - (String) Specifies the IP + * address of the instance. + * * +stateReason+ - (Object) The reason for the state * change. - * * +message+ - (String) Descriptive message for the - * state change. - * * +architecture+ - (String) The architecture of this - * instance. - * * +rootDeviceType+ - (String) The root device type - * used by the AMI. The AMI can use an Amazon EBS or instance - * store root device. - * * +rootDeviceName+ - (String) The root device name - * (e.g., /dev/sda1). - * * +blockDeviceMappings+ - (Array) Block - * device mapping set. - * * +deviceName+ - (String) The device name (e.g., - * /dev/sdh) at which the block device is exposed on the + * * +code+ - (String) Reason code for the state + * change. + * * +message+ - (String) Descriptive message for the + * state change. + * * +architecture+ - (String) The architecture of this * instance. - * * +ebs+ - (Object) The optional EBS device mapped - * to the specified device name. - * * +volumeId+ - (String) The ID of the EBS volume. - * * +status+ - (String) The status of the EBS - * volume. - * * +attachTime+ - (Date) The time at which the EBS - * volume was attached to the associated instance. - * * +deleteOnTermination+ - (Boolean) Specifies - * whether the Amazon EBS volume is deleted on instance - * termination. - * * +virtualizationType+ - (String) - * * +instanceLifecycle+ - (String) - * * +spotInstanceRequestId+ - (String) - * * +license+ - (Object) - * * +pool+ - (String) The license pool from which - * this license was used (ex: 'windows'). - * * +clientToken+ - (String) - * * +tags+ - (Array) A list of tags for the - * Instance. - * * +key+ - (String) The tag's key. - * * +value+ - (String) The tag's value. - * * +securityGroups+ - (Array) - * * +GroupName+ - (String) - * * +groupId+ - (String) - * * +sourceDestCheck+ - (Boolean) - * * +hypervisor+ - (String) - * * +networkInterfaces+ - (Array) - * * +networkInterfaceId+ - (String) - * * +subnetId+ - (String) - * * +vpcId+ - (String) - * * +description+ - (String) - * * +ownerId+ - (String) - * * +status+ - (String) - * * +privateIpAddress+ - (String) - * * +privateDnsName+ - (String) - * * +sourceDestCheck+ - (Boolean) - * * +groups+ - (Array) + * * +rootDeviceType+ - (String) The root device type + * used by the AMI. The AMI can use an Amazon EBS or instance + * store root device. + * * +rootDeviceName+ - (String) The root device name + * (e.g., /dev/sda1). + * * +blockDeviceMappings+ - (Array) Block + * device mapping set. + * * +deviceName+ - (String) The device name (e.g., + * /dev/sdh) at which the block device is exposed on the + * instance. + * * +ebs+ - (Object) The optional EBS device mapped + * to the specified device name. + * * +volumeId+ - (String) The ID of the EBS volume. + * * +status+ - (String) The status of the EBS + * volume. + * * +attachTime+ - (Date) The time at which the EBS + * volume was attached to the associated instance. + * * +deleteOnTermination+ - (Boolean) Specifies + * whether the Amazon EBS volume is deleted on instance + * termination. + * * +virtualizationType+ - (String) + * * +instanceLifecycle+ - (String) + * * +spotInstanceRequestId+ - (String) + * * +license+ - (Object) + * * +pool+ - (String) The license pool from which + * this license was used (ex: 'windows'). + * * +clientToken+ - (String) + * * +tags+ - (Array) A list of tags for the + * Instance. + * * +key+ - (String) The tag's key. + * * +value+ - (String) The tag's value. + * * +securityGroups+ - (Array) * * +GroupName+ - (String) * * +groupId+ - (String) - * * +attachment+ - (Object) - * * +attachmentId+ - (String) - * * +deviceIndex+ - (Integer) + * * +sourceDestCheck+ - (Boolean) + * * +hypervisor+ - (String) + * * +networkInterfaces+ - (Array) + * * +networkInterfaceId+ - (String) + * * +subnetId+ - (String) + * * +vpcId+ - (String) + * * +description+ - (String) + * * +ownerId+ - (String) * * +status+ - (String) - * * +attachTime+ - (Date) - * * +deleteOnTermination+ - (Boolean) - * * +association+ - (Object) - * * +publicIp+ - (String) - * * +ipOwnerId+ - (String) - * * +iamInstanceProfile+ - (Object) - * * +arn+ - (String) - * * +id+ - (String) - * * +ebsOptimized+ - (Boolean) + * * +privateIpAddress+ - (String) + * * +privateDnsName+ - (String) + * * +sourceDestCheck+ - (Boolean) + * * +groups+ - (Array) + * * +GroupName+ - (String) + * * +groupId+ - (String) + * * +attachment+ - (Object) + * * +attachmentId+ - (String) + * * +deviceIndex+ - (Integer) + * * +status+ - (String) + * * +attachTime+ - (Date) + * * +deleteOnTermination+ - (Boolean) + * * +association+ - (Object) + * * +publicIp+ - (String) + * * +ipOwnerId+ - (String) + * * +iamInstanceProfile+ - (Object) + * * +arn+ - (String) + * * +id+ - (String) + * * +ebsOptimized+ - (Boolean) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method startInstances(params, options) + * @!method startInstances(params, callback) * Starts an instance that uses an Amazon EBS volume as its root * device. Instances that use Amazon EBS volumes as their root devices * can be quickly stopped and started. When an instance is stopped, the @@ -4454,34 +5490,41 @@ AWS.EC2 = inherit({}) * instance usage. However, your root partition Amazon EBS volume * remains, continues to persist your data, and you are charged for * Amazon EBS volume usage. You can restart your instance at any time. - * @param [Object] params + * @param params [Object] * * +InstanceIds+ - (*required*, Array) The list of * Amazon EC2 instances to start. * * +additionalInfo+ - (String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +startingInstances+ - (Array) The list of the - * starting instances and details on how their state has changed. - * * +InstanceId+ - (String) The ID of the instance whose - * state changed. - * * +CurrentState+ - (Object) The current state of the - * specified instance. - * * +Code+ - (Integer) A 16-bit unsigned integer. The - * high byte is an opaque internal value and should be ignored. - * The low byte is set based on the state represented. - * * +Name+ - (String) The current state of the - * instance. - * * +PreviousState+ - (Object) The previous state of the - * specified instance. - * * +Code+ - (Integer) A 16-bit unsigned integer. The - * high byte is an opaque internal value and should be ignored. - * The low byte is set based on the state represented. - * * +Name+ - (String) The current state of the - * instance. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +startingInstances+ - (Array) The list of the + * starting instances and details on how their state has changed. + * * +InstanceId+ - (String) The ID of the instance whose + * state changed. + * * +CurrentState+ - (Object) The current state of the + * specified instance. + * * +Code+ - (Integer) A 16-bit unsigned integer. The + * high byte is an opaque internal value and should be ignored. + * The low byte is set based on the state represented. + * * +Name+ - (String) The current state of the + * instance. + * * +PreviousState+ - (Object) The previous state of the + * specified instance. + * * +Code+ - (Integer) A 16-bit unsigned integer. The + * high byte is an opaque internal value and should be ignored. + * The low byte is set based on the state represented. + * * +Name+ - (String) The current state of the + * instance. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method stopInstances(params, options) + * @!method stopInstances(params, callback) * Stops an instance that uses an Amazon EBS volume as its root device. * Instances that use Amazon EBS volumes as their root devices can be * quickly stopped and started. When an instance is stopped, the @@ -4489,89 +5532,118 @@ AWS.EC2 = inherit({}) * instance usage. However, your root partition Amazon EBS volume * remains, continues to persist your data, and you are charged for * Amazon EBS volume usage. You can restart your instance at any time. - * @param [Object] params + * @param params [Object] * * +InstanceIds+ - (*required*, Array) The list of * Amazon EC2 instances to stop. * * +force+ - (Boolean) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +stoppingInstances+ - (Array) The list of the - * stopping instances and details on how their state has changed. - * * +InstanceId+ - (String) The ID of the instance whose - * state changed. - * * +CurrentState+ - (Object) The current state of the - * specified instance. - * * +Code+ - (Integer) A 16-bit unsigned integer. The - * high byte is an opaque internal value and should be ignored. - * The low byte is set based on the state represented. - * * +Name+ - (String) The current state of the - * instance. - * * +PreviousState+ - (Object) The previous state of the - * specified instance. - * * +Code+ - (Integer) A 16-bit unsigned integer. The - * high byte is an opaque internal value and should be ignored. - * The low byte is set based on the state represented. - * * +Name+ - (String) The current state of the - * instance. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +stoppingInstances+ - (Array) The list of the + * stopping instances and details on how their state has changed. + * * +InstanceId+ - (String) The ID of the instance whose + * state changed. + * * +CurrentState+ - (Object) The current state of the + * specified instance. + * * +Code+ - (Integer) A 16-bit unsigned integer. The + * high byte is an opaque internal value and should be ignored. + * The low byte is set based on the state represented. + * * +Name+ - (String) The current state of the + * instance. + * * +PreviousState+ - (Object) The previous state of the + * specified instance. + * * +Code+ - (Integer) A 16-bit unsigned integer. The + * high byte is an opaque internal value and should be ignored. + * The low byte is set based on the state represented. + * * +Name+ - (String) The current state of the + * instance. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method terminateInstances(params, options) + * @!method terminateInstances(params, callback) * The TerminateInstances operation shuts down one or more instances. * This operation is idempotent; if you terminate an instance more than * once, each call will succeed. - * @param [Object] params + * @param params [Object] * * +InstanceIds+ - (*required*, Array) The list of * instances to terminate. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +TerminatingInstances+ - (Array) The list of - * the terminating instances and details on how their state has - * changed. - * * +InstanceId+ - (String) The ID of the instance whose - * state changed. - * * +CurrentState+ - (Object) The current state of the - * specified instance. - * * +Code+ - (Integer) A 16-bit unsigned integer. The - * high byte is an opaque internal value and should be ignored. - * The low byte is set based on the state represented. - * * +Name+ - (String) The current state of the - * instance. - * * +PreviousState+ - (Object) The previous state of the - * specified instance. - * * +Code+ - (Integer) A 16-bit unsigned integer. The - * high byte is an opaque internal value and should be ignored. - * The low byte is set based on the state represented. - * * +Name+ - (String) The current state of the - * instance. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +TerminatingInstances+ - (Array) The list of + * the terminating instances and details on how their state has + * changed. + * * +InstanceId+ - (String) The ID of the instance whose + * state changed. + * * +CurrentState+ - (Object) The current state of the + * specified instance. + * * +Code+ - (Integer) A 16-bit unsigned integer. The + * high byte is an opaque internal value and should be ignored. + * The low byte is set based on the state represented. + * * +Name+ - (String) The current state of the + * instance. + * * +PreviousState+ - (Object) The previous state of the + * specified instance. + * * +Code+ - (Integer) A 16-bit unsigned integer. The + * high byte is an opaque internal value and should be ignored. + * The low byte is set based on the state represented. + * * +Name+ - (String) The current state of the + * instance. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method unassignPrivateIpAddresses(params, options) + * @!method unassignPrivateIpAddresses(params, callback) * Calls the UnassignPrivateIpAddresses API operation. - * @param [Object] params + * @param params [Object] * * +networkInterfaceId+ - (*required*, String) * * +privateIpAddresses+ - (*required*, Array) - * @param [Object] options - * @return [AWS.AWSRequest] - * - * @!method unmonitorInstances(params, options) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method unmonitorInstances(params, callback) * Disables monitoring for a running instance. - * @param [Object] params + * @param params [Object] * * +InstanceIds+ - (*required*, Array) The list of * Amazon EC2 instances on which to disable monitoring. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +InstanceMonitorings+ - (Array) A list of - * updated monitoring information for the instances specified in - * the request. - * * +InstanceId+ - (String) Instance ID. - * * +Monitoring+ - (Object) Monitoring state for the - * associated instance. - * * +State+ - (String) The state of monitoring on an - * Amazon EC2 instance (ex: enabled, disabled). + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +InstanceMonitorings+ - (Array) A list of + * updated monitoring information for the instances specified in + * the request. + * * +InstanceId+ - (String) Instance ID. + * * +Monitoring+ - (Object) Monitoring state for the + * associated instance. + * * +State+ - (String) The state of monitoring on an + * Amazon EC2 instance (ex: enabled, disabled). + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * * * @!method constructor(options) diff --git a/doc-src/s3.docs.js b/doc-src/s3.docs.js index 9149d38086..b8e6416169 100644 --- a/doc-src/s3.docs.js +++ b/doc-src/s3.docs.js @@ -24,8 +24,12 @@ AWS = {}; * === Sending a Request Using S3 * * svc = new AWS.S3(); - * svc.client.OPERATION_NAME(params).always(function (resp) { - * console.log(resp.data, resp.error); + * svc.client.OPERATION_NAME(params, function (err, data) { + * if (err) { + * console.log(err); // an error occurred + * } else { + * console.log(data); // successful response + * } * }); * * @!method constructor(options) @@ -46,19 +50,27 @@ AWS.S3 = inherit({}) * The low-level S3 client class. This class provides one function * for each API operation on the service. * - * @!method abortMultipartUpload(params, options) + * @!method abortMultipartUpload(params, callback) * Aborts a multipart upload. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) * * +Key+ - (*required*, String) * * +UploadId+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method completeMultipartUpload(params, options) + * @!method completeMultipartUpload(params, callback) * Completes a multipart upload by assembling previously uploaded * parts. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) * * +Key+ - (*required*, String) * * +UploadId+ - (*required*, String) @@ -68,24 +80,31 @@ AWS.S3 = inherit({}) * identifies the part. * * +ETag+ - (String) Entity tag returned when the part * was uploaded. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Location+ - (String) - * * +Bucket+ - (String) - * * +Key+ - (String) - * * +ETag+ - (String) Entity tag for the uploaded object. - * * +Expiration+ - (Date) If the object expiration is - * configured, this will contain the expiration date (expiry-date) - * and rule ID (rule-id). The value of rule-id is URL encoded. - * * +ServerSideEncryption+ - (String) The Server-side - * encryption algorithm used when storing this object in S3. - * * +VersionId+ - (String) Version of the object. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Location+ - (String) + * * +Bucket+ - (String) + * * +Key+ - (String) + * * +ETag+ - (String) Entity tag for the uploaded object. + * * +Expiration+ - (Date) If the object expiration is + * configured, this will contain the expiration date (expiry-date) + * and rule ID (rule-id). The value of rule-id is URL encoded. + * * +ServerSideEncryption+ - (String) The Server-side + * encryption algorithm used when storing this object in S3. + * * +VersionId+ - (String) Version of the object. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method copyObject(params, options) + * @!method copyObject(params, callback) * Creates a copy of an object that is already stored in Amazon S3. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) * * +Key+ - (*required*, String) * * +MetadataDirective+ - (String) Specifies whether the @@ -120,22 +139,29 @@ AWS.S3 = inherit({}) * object if it hasn''t been modified since the specified time. * * +CopySourceIfModifiedSince+ - (Date) Copies the object * if it has been modified since the specified time. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +CopyObjectResult+ - (Object) - * * +ETag+ - (String) - * * +LastModified+ - (String) - * * +Expiration+ - (String) If the object expiration is - * configured, the response includes this header. - * * +CopySourceVersionId+ - (String) - * * +ServerSideEncryption+ - (String) The Server-side - * encryption algorithm used when storing this object in S3. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +CopyObjectResult+ - (Object) + * * +ETag+ - (String) + * * +LastModified+ - (String) + * * +Expiration+ - (String) If the object expiration is + * configured, the response includes this header. + * * +CopySourceVersionId+ - (String) + * * +ServerSideEncryption+ - (String) The Server-side + * encryption algorithm used when storing this object in S3. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method createBucket(params, options) + * @!method createBucket(params, callback) * Creates a new bucket. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) * * +CreateBucketConfiguration+ - (Object) * * +LocationConstraint+ - (String) Specifies the region @@ -151,15 +177,22 @@ AWS.S3 = inherit({}) * ACL for the applicable bucket. * * +GrantFullControl+ - (String) Allows grantee the read, * write, read ACP, and write ACP permissions on the bucket. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Location+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Location+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method createMultipartUpload(params, options) + * @!method createMultipartUpload(params, callback) * Initiates a multipart upload and returns an upload ID. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) * * +Key+ - (*required*, String) * * +CacheControl+ - (String) Can be used to specify @@ -193,84 +226,146 @@ AWS.S3 = inherit({}) * encryption algorithm used when storing this object in S3. * * +Metadata+ - (Object) A map of metadata to * store with the object in S3. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Bucket+ - (String) Name of the bucket to which the - * multipart upload was initiated. - * * +Key+ - (String) Object key for which the multipart - * upload was initiated. - * * +UploadId+ - (String) ID for the initiated multipart - * upload. - * * +ServerSideEncryption+ - (String) The Server-side - * encryption algorithm used when storing this object in S3. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Bucket+ - (String) Name of the bucket to which the + * multipart upload was initiated. + * * +Key+ - (String) Object key for which the multipart + * upload was initiated. + * * +UploadId+ - (String) ID for the initiated multipart + * upload. + * * +ServerSideEncryption+ - (String) The Server-side + * encryption algorithm used when storing this object in S3. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method deleteBucket(params, options) + * @!method deleteBucket(params, callback) * Deletes the bucket. All objects (including all object versions and * Delete Markers) in the bucket must be deleted before the bucket * itself can be deleted. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method deleteBucketCors(params, options) + * @!method deleteBucketCors(params, callback) * Deletes the cors configuration information set for the bucket. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method deleteBucketLifecycle(params, options) + * @!method deleteBucketLifecycle(params, callback) * Deletes the lifecycle configuration from the bucket. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method deleteBucketPolicy(params, options) + * @!method deleteBucketPolicy(params, callback) * Deletes the policy from the bucket. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method deleteBucketTagging(params, options) + * @!method deleteBucketTagging(params, callback) * Deletes the tags from the bucket. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method deleteBucketWebsite(params, options) + * @!method deleteBucketWebsite(params, callback) * This operation removes the website configuration from the bucket. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method deleteObject(params, options) + * @!method deleteObject(params, callback) * Removes the null version (if there is one) of an object and inserts * a delete marker, which becomes the latest version of the object. If * there isn''t a null version, Amazon S3 does not remove any objects. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) * * +Key+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +DeleteMarker+ - (String) Specifies whether the - * versioned object that was permanently deleted was (true) or was - * not (false) a delete marker. - * * +VersionId+ - (String) Returns the version ID of the - * delete marker created as a result of the DELETE operation. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +DeleteMarker+ - (String) Specifies whether the + * versioned object that was permanently deleted was (true) or was + * not (false) a delete marker. + * * +VersionId+ - (String) Returns the version ID of the + * delete marker created as a result of the DELETE operation. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method deleteObjects(params, options) + * @!method deleteObjects(params, callback) * This operation enables you to delete multiple objects from a bucket * using a single HTTP request. You may specify up to 1000 keys. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) * * +Delete+ - (*required*, Object) * * +Quiet+ - (Boolean) Element to enable quiet mode for @@ -284,229 +379,313 @@ AWS.S3 = inherit({}) * * +MFA+ - (String) The concatenation of the * authentication device''s serial number, a space, and the value * that is displayed on your authentication device. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Deleted+ - (Array) - * * +Key+ - (String) - * * +VersionId+ - (String) - * * +DeleteMarker+ - (Boolean) - * * +DeleteMarkerVersionId+ - (String) - * * +Errors+ - (Array) - * * +Key+ - (String) - * * +VersionId+ - (String) - * * +Code+ - (String) - * * +Message+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Deleted+ - (Array) + * * +Key+ - (String) + * * +VersionId+ - (String) + * * +DeleteMarker+ - (Boolean) + * * +DeleteMarkerVersionId+ - (String) + * * +Errors+ - (Array) + * * +Key+ - (String) + * * +VersionId+ - (String) + * * +Code+ - (String) + * * +Message+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method getBucketAcl(params, options) + * @!method getBucketAcl(params, callback) * Gets the access control policy for the bucket. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Owner+ - (Object) - * * +ID+ - (String) - * * +DisplayName+ - (String) - * * +Grants+ - (Array) A list of grants. - * * +Grantee+ - (Object) - * * +Type+ - (String) Type of grantee - * * +ID+ - (String) The canonical user ID of the - * grantee. - * * +DisplayName+ - (String) Screen name of the - * grantee. - * * +EmailAddress+ - (String) Email address of the - * grantee. - * * +URI+ - (String) URI of the grantee group. - * * +Permission+ - (String) Specifies the permission - * given to the grantee. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Owner+ - (Object) + * * +ID+ - (String) + * * +DisplayName+ - (String) + * * +Grants+ - (Array) A list of grants. + * * +Grantee+ - (Object) + * * +Type+ - (String) Type of grantee + * * +ID+ - (String) The canonical user ID of the + * grantee. + * * +DisplayName+ - (String) Screen name of the + * grantee. + * * +EmailAddress+ - (String) Email address of the + * grantee. + * * +URI+ - (String) URI of the grantee group. + * * +Permission+ - (String) Specifies the permission + * given to the grantee. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method getBucketCors(params, options) + * @!method getBucketCors(params, callback) * Returns the cors configuration for the bucket. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +CORSRules+ - (Array) - * * +AllowedOrigins+ - (Array) One or more - * origins you want customers to be able to access the bucket - * from. - * * +AllowedMethods+ - (Array) Identifies HTTP - * methods that the domain/origin specified in the rule is - * allowed to execute. - * * +MaxAgeSeconds+ - (Integer) The time in seconds that - * your browser is to cache the preflight response for the - * specified resource. - * * +ExposeHeaders+ - (Array) One or more headers - * in the response that you want customers to be able to access - * from their applications (for example, from a JavaScript - * XMLHttpRequest object). + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +CORSRules+ - (Array) + * * +AllowedOrigins+ - (Array) One or more + * origins you want customers to be able to access the bucket + * from. + * * +AllowedMethods+ - (Array) Identifies HTTP + * methods that the domain/origin specified in the rule is + * allowed to execute. + * * +MaxAgeSeconds+ - (Integer) The time in seconds that + * your browser is to cache the preflight response for the + * specified resource. + * * +ExposeHeaders+ - (Array) One or more headers + * in the response that you want customers to be able to access + * from their applications (for example, from a JavaScript + * XMLHttpRequest object). + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method getBucketLifecycle(params, options) + * @!method getBucketLifecycle(params, callback) * Returns the lifecycle configuration information set on the bucket. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Rules+ - (Array) - * * +ID+ - (String) Unique identifier for the rule. The - * value cannot be longer than 255 characters. - * * +Prefix+ - (String) Prefix identifying one or more - * objects to which the rule applies. - * * +Status+ - (String) If 'Enabled', the rule is - * currently being applied. If 'Disabled', the rule is not - * currently being applied. - * * +Transition+ - (Object) - * * +Days+ - (Integer) Indicates the lifetime, in days, - * of the objects that are subject to the rule. The value must - * be a non-zero positive integer. - * * +Date+ - (Date) Indicates at what date the object - * is to be moved or deleted. Should be in GMT ISO 8601 Format. - * * +StorageClass+ - (String) The class of storage used - * to store the object. - * * +Expiration+ - (Object) - * * +Days+ - (Integer) Indicates the lifetime, in days, - * of the objects that are subject to the rule. The value must - * be a non-zero positive integer. - * * +Date+ - (Date) Indicates at what date the object - * is to be moved or deleted. Should be in GMT ISO 8601 Format. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Rules+ - (Array) + * * +ID+ - (String) Unique identifier for the rule. The + * value cannot be longer than 255 characters. + * * +Prefix+ - (String) Prefix identifying one or more + * objects to which the rule applies. + * * +Status+ - (String) If 'Enabled', the rule is + * currently being applied. If 'Disabled', the rule is not + * currently being applied. + * * +Transition+ - (Object) + * * +Days+ - (Integer) Indicates the lifetime, in days, + * of the objects that are subject to the rule. The value must + * be a non-zero positive integer. + * * +Date+ - (Date) Indicates at what date the object + * is to be moved or deleted. Should be in GMT ISO 8601 Format. + * * +StorageClass+ - (String) The class of storage used + * to store the object. + * * +Expiration+ - (Object) + * * +Days+ - (Integer) Indicates the lifetime, in days, + * of the objects that are subject to the rule. The value must + * be a non-zero positive integer. + * * +Date+ - (Date) Indicates at what date the object + * is to be moved or deleted. Should be in GMT ISO 8601 Format. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method getBucketLocation(params, options) + * @!method getBucketLocation(params, callback) * Returns the region the bucket resides in. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +LocationConstraint+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +LocationConstraint+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method getBucketLogging(params, options) + * @!method getBucketLogging(params, callback) * Returns the logging status of a bucket and the permissions users * have to view and modify that status. To use GET, you must be the * bucket owner. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +LoggingEnabled+ - (Object) - * * +TargetBucket+ - (String) Specifies the bucket where - * you want Amazon S3 to store server access logs. You can have - * your logs delivered to any bucket that you own, including the - * same bucket that is being logged. You can also configure - * multiple buckets to deliver their logs to the same target - * bucket. In this case you should choose a different - * TargetPrefix for each source bucket so that the delivered log - * files can be distinguished by key. - * * +TargetPrefix+ - (String) This element lets you - * specify a prefix for the keys that the log files will be - * stored under. - * * +TargetGrants+ - (Array) - * * +Grantee+ - (Object) - * * +Type+ - (String) Type of grantee - * * +ID+ - (String) The canonical user ID of the - * grantee. - * * +DisplayName+ - (String) Screen name of the - * grantee. - * * +EmailAddress+ - (String) Email address of the - * grantee. - * * +URI+ - (String) URI of the grantee group. - * * +Permission+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +LoggingEnabled+ - (Object) + * * +TargetBucket+ - (String) Specifies the bucket where + * you want Amazon S3 to store server access logs. You can have + * your logs delivered to any bucket that you own, including the + * same bucket that is being logged. You can also configure + * multiple buckets to deliver their logs to the same target + * bucket. In this case you should choose a different + * TargetPrefix for each source bucket so that the delivered log + * files can be distinguished by key. + * * +TargetPrefix+ - (String) This element lets you + * specify a prefix for the keys that the log files will be + * stored under. + * * +TargetGrants+ - (Array) + * * +Grantee+ - (Object) + * * +Type+ - (String) Type of grantee + * * +ID+ - (String) The canonical user ID of the + * grantee. + * * +DisplayName+ - (String) Screen name of the + * grantee. + * * +EmailAddress+ - (String) Email address of the + * grantee. + * * +URI+ - (String) URI of the grantee group. + * * +Permission+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method getBucketNotification(params, options) + * @!method getBucketNotification(params, callback) * Return the notification configuration of a bucket. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +TopicConfiguration+ - (Object) - * * +Topic+ - (String) Amazon SNS topic to which Amazon - * S3 will publish a message to report the specified events for - * the bucket. - * * +Event+ - (String) Bucket event for which to send - * notifications. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +TopicConfiguration+ - (Object) + * * +Topic+ - (String) Amazon SNS topic to which Amazon + * S3 will publish a message to report the specified events for + * the bucket. + * * +Event+ - (String) Bucket event for which to send + * notifications. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method getBucketPolicy(params, options) + * @!method getBucketPolicy(params, callback) * Returns the policy of a specified bucket. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Policy+ - (String) The bucket policy as a JSON - * document. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Policy+ - (String) The bucket policy as a JSON + * document. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method getBucketRequestPayment(params, options) + * @!method getBucketRequestPayment(params, callback) * Returns the request payment configuration of a bucket. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Payer+ - (String) Specifies who pays for the download - * and request fees. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Payer+ - (String) Specifies who pays for the download + * and request fees. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method getBucketTagging(params, options) + * @!method getBucketTagging(params, callback) * Returns the tag set associated with the bucket. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +TagSet+ - (Array) - * * +Key+ - (String) Name of the tag. - * * +Value+ - (String) Value of the tag. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +TagSet+ - (Array) + * * +Key+ - (String) Name of the tag. + * * +Value+ - (String) Value of the tag. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method getBucketVersioning(params, options) + * @!method getBucketVersioning(params, callback) * Returns the versioning state of a bucket. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Status+ - (String) The versioning state of the bucket. - * * +MFADelete+ - (String) Specifies whether MFA delete is - * enabled in the bucket versioning configuration. This element is - * only returned if the bucket has been configured with MFA delete. - * If the bucket has never been so configured, this element is not - * returned. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Status+ - (String) The versioning state of the bucket. + * * +MFADelete+ - (String) Specifies whether MFA delete is + * enabled in the bucket versioning configuration. This element is + * only returned if the bucket has been configured with MFA delete. + * If the bucket has never been so configured, this element is not + * returned. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method getBucketWebsite(params, options) + * @!method getBucketWebsite(params, callback) * Returns the website configuration for a bucket. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +IndexDocument+ - (Object) - * * +Suffix+ - (String) A suffix that is appended to a - * request that is for a directory on the website endpoint (e.g. - * if the suffix is index.html and you make a request to - * samplebucket/images/ the data that is returned will be for the - * object with the key name images/index.html) The suffix must - * not be empty and must not include a slash character. - * * +ErrorDocument+ - (Object) - * * +Key+ - (String) The object key name to use when a - * 4XX class error occurs. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +IndexDocument+ - (Object) + * * +Suffix+ - (String) A suffix that is appended to a + * request that is for a directory on the website endpoint (e.g. + * if the suffix is index.html and you make a request to + * samplebucket/images/ the data that is returned will be for the + * object with the key name images/index.html) The suffix must + * not be empty and must not include a slash character. + * * +ErrorDocument+ - (Object) + * * +Key+ - (String) The object key name to use when a + * 4XX class error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method getObject(params, options) + * @!method getObject(params, callback) * Retrieves objects from Amazon S3. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) * * +Key+ - (*required*, String) * * +ResponseContentType+ - (String) Sets the Content-Type @@ -539,95 +718,124 @@ AWS.S3 = inherit({}) * * +IfNoneMatch+ - (String) Return the object only if its * entity tag (ETag) is different from the one specified, otherwise * return a 304 (not modified). - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Body+ - (Base64 Encoded Data) Object data. - * * +DeleteMarker+ - (String) Specifies whether the object - * retrieved was (true) or was not (false) a Delete Marker. If - * false, this response header does not appear in the response. - * * +Expiration+ - (String) If the object expiration is - * configured (see PUT Bucket lifecycle), the response includes - * this header. It includes the expiry-date and rule-id key value - * pairs providing object expiration information. The value of the - * rule-id is URL encoded. - * * +WebsiteRedirectLocation+ - (String) When a bucket is - * configured as a website, you can set this metadata on the object - * so the website endpoint will evaluate the request for the object - * as a 301 redirect to another object in the same bucket or an - * external URL. - * * +LastModified+ - (Date) Last modified date of the - * object - * * +ContentType+ - (String) Content type of the object - * * +ContentLength+ - (Integer) Size of the body in bytes. - * * +ETag+ - (String) An ETag is an opaque identifier - * assigned by a web server to a specific version of a resource - * found at a URL - * * +MissingMeta+ - (Integer) This is set to the number of - * metadata entries not returned in x-amz-meta headers. This can - * happen if you create metadata using an API like SOAP that - * supports more flexible metadata than the REST API. For example, - * using SOAP, you can create metadata whose values are not legal - * HTTP headers. - * * +ServerSideEncryption+ - (String) The Server-side - * encryption algorithm used when storing this object in S3. - * * +VersionId+ - (String) Version of the object. - * * +Metadata+ - (Object) A map of metadata to - * store with the object in S3. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Body+ - (Base64 Encoded Data) Object data. + * * +DeleteMarker+ - (String) Specifies whether the object + * retrieved was (true) or was not (false) a Delete Marker. If + * false, this response header does not appear in the response. + * * +Expiration+ - (String) If the object expiration is + * configured (see PUT Bucket lifecycle), the response includes + * this header. It includes the expiry-date and rule-id key value + * pairs providing object expiration information. The value of the + * rule-id is URL encoded. + * * +WebsiteRedirectLocation+ - (String) When a bucket is + * configured as a website, you can set this metadata on the object + * so the website endpoint will evaluate the request for the object + * as a 301 redirect to another object in the same bucket or an + * external URL. + * * +LastModified+ - (Date) Last modified date of the + * object + * * +ContentType+ - (String) Content type of the object + * * +ContentLength+ - (Integer) Size of the body in bytes. + * * +ETag+ - (String) An ETag is an opaque identifier + * assigned by a web server to a specific version of a resource + * found at a URL + * * +MissingMeta+ - (Integer) This is set to the number of + * metadata entries not returned in x-amz-meta headers. This can + * happen if you create metadata using an API like SOAP that + * supports more flexible metadata than the REST API. For example, + * using SOAP, you can create metadata whose values are not legal + * HTTP headers. + * * +ServerSideEncryption+ - (String) The Server-side + * encryption algorithm used when storing this object in S3. + * * +VersionId+ - (String) Version of the object. + * * +Metadata+ - (Object) A map of metadata to + * store with the object in S3. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method getObjectAcl(params, options) + * @!method getObjectAcl(params, callback) * Returns the access control list (ACL) of an object. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) * * +Key+ - (*required*, String) * * +VersionId+ - (String) VersionId used to reference a * specific version of the object. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Owner+ - (Object) - * * +ID+ - (String) - * * +DisplayName+ - (String) - * * +Grants+ - (Array) A list of grants. - * * +Grantee+ - (Object) - * * +Type+ - (String) Type of grantee - * * +ID+ - (String) The canonical user ID of the - * grantee. - * * +DisplayName+ - (String) Screen name of the - * grantee. - * * +EmailAddress+ - (String) Email address of the - * grantee. - * * +URI+ - (String) URI of the grantee group. - * * +Permission+ - (String) Specifies the permission - * given to the grantee. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Owner+ - (Object) + * * +ID+ - (String) + * * +DisplayName+ - (String) + * * +Grants+ - (Array) A list of grants. + * * +Grantee+ - (Object) + * * +Type+ - (String) Type of grantee + * * +ID+ - (String) The canonical user ID of the + * grantee. + * * +DisplayName+ - (String) Screen name of the + * grantee. + * * +EmailAddress+ - (String) Email address of the + * grantee. + * * +URI+ - (String) URI of the grantee group. + * * +Permission+ - (String) Specifies the permission + * given to the grantee. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method getObjectTorrent(params, options) + * @!method getObjectTorrent(params, callback) * Return torrent files from a bucket. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) * * +Key+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Body+ - (Base64 Encoded Data) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Body+ - (Base64 Encoded Data) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method headBucket(params, options) + * @!method headBucket(params, callback) * This operation is useful to determine if a bucket exists and you * have permission to access it. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method headObject(params, options) + * @!method headObject(params, callback) * The HEAD operation retrieves metadata from an object without * returning the object itself. This operation is useful if you''re * only interested in an object''s metadata. To use HEAD, you must have * READ access to the object. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) * * +Key+ - (*required*, String) * * +VersionId+ - (String) VersionId used to reference a @@ -648,60 +856,74 @@ AWS.S3 = inherit({}) * * +IfNoneMatch+ - (String) Return the object only if its * entity tag (ETag) is different from the one specified, otherwise * return a 304 (not modified). - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +DeleteMarker+ - (String) Specifies whether the object - * retrieved was (true) or was not (false) a Delete Marker. If - * false, this response header does not appear in the response. - * * +Expiration+ - (String) If the object expiration is - * configured (see PUT Bucket lifecycle), the response includes - * this header. It includes the expiry-date and rule-id key value - * pairs providing object expiration information. The value of the - * rule-id is URL encoded. - * * +WebsiteRedirectLocation+ - (String) When a bucket is - * configured as a website, you can set this metadata on the object - * so the website endpoint will evaluate the request for the object - * as a 301 redirect to another object in the same bucket or an - * external URL. - * * +LastModified+ - (Date) Last modified date of the - * object - * * +ContentType+ - (String) Content type of the object - * * +ContentLength+ - (Integer) Size of the body in bytes. - * * +ETag+ - (String) An ETag is an opaque identifier - * assigned by a web server to a specific version of a resource - * found at a URL - * * +MissingMeta+ - (Integer) This is set to the number of - * metadata entries not returned in x-amz-meta headers. This can - * happen if you create metadata using an API like SOAP that - * supports more flexible metadata than the REST API. For example, - * using SOAP, you can create metadata whose values are not legal - * HTTP headers. - * * +ServerSideEncryption+ - (String) The Server-side - * encryption algorithm used when storing this object in S3. - * * +VersionId+ - (String) Version of the object. - * * +Metadata+ - (Object) A map of metadata to - * store with the object in S3. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +DeleteMarker+ - (String) Specifies whether the object + * retrieved was (true) or was not (false) a Delete Marker. If + * false, this response header does not appear in the response. + * * +Expiration+ - (String) If the object expiration is + * configured (see PUT Bucket lifecycle), the response includes + * this header. It includes the expiry-date and rule-id key value + * pairs providing object expiration information. The value of the + * rule-id is URL encoded. + * * +WebsiteRedirectLocation+ - (String) When a bucket is + * configured as a website, you can set this metadata on the object + * so the website endpoint will evaluate the request for the object + * as a 301 redirect to another object in the same bucket or an + * external URL. + * * +LastModified+ - (Date) Last modified date of the + * object + * * +ContentType+ - (String) Content type of the object + * * +ContentLength+ - (Integer) Size of the body in bytes. + * * +ETag+ - (String) An ETag is an opaque identifier + * assigned by a web server to a specific version of a resource + * found at a URL + * * +MissingMeta+ - (Integer) This is set to the number of + * metadata entries not returned in x-amz-meta headers. This can + * happen if you create metadata using an API like SOAP that + * supports more flexible metadata than the REST API. For example, + * using SOAP, you can create metadata whose values are not legal + * HTTP headers. + * * +ServerSideEncryption+ - (String) The Server-side + * encryption algorithm used when storing this object in S3. + * * +VersionId+ - (String) Version of the object. + * * +Metadata+ - (Object) A map of metadata to + * store with the object in S3. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method listBuckets(params, options) + * @!method listBuckets(params, callback) * Returns a list of all buckets owned by the authenticated sender of * the request. - * @param [Object] params - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Buckets+ - (Array) - * * +Name+ - (String) The name of the bucket. - * * +CreationDate+ - (Date) Date the bucket was created. - * * +Owner+ - (Object) - * * +ID+ - (String) - * * +DisplayName+ - (String) + * @param params [Object] + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Buckets+ - (Array) + * * +Name+ - (String) The name of the bucket. + * * +CreationDate+ - (Date) Date the bucket was created. + * * +Owner+ - (Object) + * * +ID+ - (String) + * * +DisplayName+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method listMultipartUploads(params, options) + * @!method listMultipartUploads(params, callback) * This operation lists in-progress multipart uploads. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) * * +Prefix+ - (String) Lists in-progress uploads only for * those keys that begin with the specified prefix. @@ -717,52 +939,59 @@ AWS.S3 = inherit({}) * specifies the multipart upload after which listing should begin. * If key-marker is not specified, the upload-id-marker parameter * is ignored. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Bucket+ - (String) Name of the bucket to which the - * multipart upload was initiated. - * * +KeyMarker+ - (String) The key at or after which the - * listing began. - * * +UploadIdMarker+ - (String) Upload ID after which - * listing began. - * * +NextKeyMarker+ - (String) When a list is truncated, - * this element specifies the value that should be used for the - * key-marker request parameter in a subsequent request. - * * +NextUploadIdMarker+ - (String) When a list is - * truncated, this element specifies the value that should be used - * for the upload-id-marker request parameter in a subsequent - * request. - * * +MaxUploads+ - (Integer) Maximum number of multipart - * uploads that could have been included in the response. - * * +IsTruncated+ - (Boolean) Indicates whether the - * returned list of multipart uploads is truncated. A value of true - * indicates that the list was truncated. The list can be truncated - * if the number of multipart uploads exceeds the limit allowed or - * specified by max uploads. - * * +Uploads+ - (Array) - * * +UploadId+ - (String) Upload ID that identifies the - * multipart upload. - * * +Key+ - (String) Key of the object for which the + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Bucket+ - (String) Name of the bucket to which the * multipart upload was initiated. - * * +Initiated+ - (Date) Date and time at which the - * multipart upload was initiated. - * * +StorageClass+ - (String) The class of storage used - * to store the object. - * * +Owner+ - (Object) - * * +ID+ - (String) - * * +DisplayName+ - (String) - * * +Initiator+ - (Object) Identifies who initiated the - * multipart upload. - * * +ID+ - (String) If the principal is an AWS account, - * it provides the Canonical User ID. If the principal is an - * IAM User, it provides a user ARN value. - * * +DisplayName+ - (String) Name of the Principal. + * * +KeyMarker+ - (String) The key at or after which the + * listing began. + * * +UploadIdMarker+ - (String) Upload ID after which + * listing began. + * * +NextKeyMarker+ - (String) When a list is truncated, + * this element specifies the value that should be used for the + * key-marker request parameter in a subsequent request. + * * +NextUploadIdMarker+ - (String) When a list is + * truncated, this element specifies the value that should be used + * for the upload-id-marker request parameter in a subsequent + * request. + * * +MaxUploads+ - (Integer) Maximum number of multipart + * uploads that could have been included in the response. + * * +IsTruncated+ - (Boolean) Indicates whether the + * returned list of multipart uploads is truncated. A value of true + * indicates that the list was truncated. The list can be truncated + * if the number of multipart uploads exceeds the limit allowed or + * specified by max uploads. + * * +Uploads+ - (Array) + * * +UploadId+ - (String) Upload ID that identifies the + * multipart upload. + * * +Key+ - (String) Key of the object for which the + * multipart upload was initiated. + * * +Initiated+ - (Date) Date and time at which the + * multipart upload was initiated. + * * +StorageClass+ - (String) The class of storage used + * to store the object. + * * +Owner+ - (Object) + * * +ID+ - (String) + * * +DisplayName+ - (String) + * * +Initiator+ - (Object) Identifies who initiated the + * multipart upload. + * * +ID+ - (String) If the principal is an AWS account, + * it provides the Canonical User ID. If the principal is an + * IAM User, it provides a user ARN value. + * * +DisplayName+ - (String) Name of the Principal. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method listObjectVersions(params, options) + * @!method listObjectVersions(params, callback) * Returns metadata about all of the versions of objects in a bucket. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) * * +KeyMarker+ - (String) Specifies the key to start with * when listing objects in a bucket. @@ -775,59 +1004,66 @@ AWS.S3 = inherit({}) * use to group keys. * * +Prefix+ - (String) Limits the response to keys that * begin with the specified prefix. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +KeyMarker+ - (String) Marks the last Key returned in a - * truncated response. - * * +VersionIdMarker+ - (String) - * * +NextKeyMarker+ - (String) Use this value for the key - * marker request parameter in a subsequent request. - * * +NextVersionIdMarker+ - (String) Use this value for the - * next version id marker parameter in a subsequent request. - * * +Versions+ - (Array) - * * +ETag+ - (String) - * * +Size+ - (String) Size in bytes of the object. - * * +StorageClass+ - (String) The class of storage used - * to store the object. - * * +Key+ - (String) The object key. - * * +VersionId+ - (String) Version ID of an object. - * * +IsLatest+ - (Boolean) Specifies whether the object - * is (true) or is not (false) the latest version of an object. - * * +LastModified+ - (Date) Date and time the object was - * last modified. - * * +Owner+ - (Object) - * * +ID+ - (String) - * * +DisplayName+ - (String) - * * +DeleteMarkers+ - (Array) - * * +Owner+ - (Object) - * * +ID+ - (String) - * * +DisplayName+ - (String) - * * +Key+ - (String) The object key. - * * +VersionId+ - (String) Version ID of an object. - * * +IsLatest+ - (Boolean) Specifies whether the object - * is (true) or is not (false) the latest version of an object. - * * +LastModified+ - (Date) Date and time the object was - * last modified. - * * +Name+ - (String) - * * +Prefix+ - (String) - * * +MaxKeys+ - (Integer) - * * +IsTruncated+ - (Boolean) A flag that indicates whether - * (true) or not (false) Amazon S3 returned all of the results that - * satisfied the search criteria. If your results were truncated, - * you can make a follow-up paginated request using the - * NextKeyMarker and NextVersionIdMarker response parameters as a - * starting place in another request to return the rest of the - * results. - * * +CommonPrefixes+ - (Array) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +KeyMarker+ - (String) Marks the last Key returned in a + * truncated response. + * * +VersionIdMarker+ - (String) + * * +NextKeyMarker+ - (String) Use this value for the key + * marker request parameter in a subsequent request. + * * +NextVersionIdMarker+ - (String) Use this value for the + * next version id marker parameter in a subsequent request. + * * +Versions+ - (Array) + * * +ETag+ - (String) + * * +Size+ - (String) Size in bytes of the object. + * * +StorageClass+ - (String) The class of storage used + * to store the object. + * * +Key+ - (String) The object key. + * * +VersionId+ - (String) Version ID of an object. + * * +IsLatest+ - (Boolean) Specifies whether the object + * is (true) or is not (false) the latest version of an object. + * * +LastModified+ - (Date) Date and time the object was + * last modified. + * * +Owner+ - (Object) + * * +ID+ - (String) + * * +DisplayName+ - (String) + * * +DeleteMarkers+ - (Array) + * * +Owner+ - (Object) + * * +ID+ - (String) + * * +DisplayName+ - (String) + * * +Key+ - (String) The object key. + * * +VersionId+ - (String) Version ID of an object. + * * +IsLatest+ - (Boolean) Specifies whether the object + * is (true) or is not (false) the latest version of an object. + * * +LastModified+ - (Date) Date and time the object was + * last modified. + * * +Name+ - (String) * * +Prefix+ - (String) + * * +MaxKeys+ - (Integer) + * * +IsTruncated+ - (Boolean) A flag that indicates whether + * (true) or not (false) Amazon S3 returned all of the results that + * satisfied the search criteria. If your results were truncated, + * you can make a follow-up paginated request using the + * NextKeyMarker and NextVersionIdMarker response parameters as a + * starting place in another request to return the rest of the + * results. + * * +CommonPrefixes+ - (Array) + * * +Prefix+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method listObjects(params, options) + * @!method listObjects(params, callback) * Returns some or all (up to 1000) of the objects in a bucket. You can * use the request parameters as selection criteria to return a subset * of the objects in a bucket. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) * * +Marker+ - (String) Specifies the key to start with * when listing objects in a bucket. @@ -838,38 +1074,45 @@ AWS.S3 = inherit({}) * use to group keys. * * +Prefix+ - (String) Limits the response to keys that * begin with the specified prefix. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Marker+ - (String) - * * +Contents+ - (Array) - * * +Key+ - (String) - * * +LastModified+ - (Date) - * * +ETag+ - (String) - * * +Size+ - (Integer) - * * +StorageClass+ - (String) The class of storage used - * to store the object. - * * +Owner+ - (Object) - * * +ID+ - (String) - * * +DisplayName+ - (String) - * * +Name+ - (String) - * * +Prefix+ - (String) - * * +MaxKeys+ - (Integer) - * * +IsTruncated+ - (Boolean) A flag that indicates whether - * (true) or not (false) Amazon S3 returned all of the results that - * satisfied the search criteria. If your results were truncated, - * you can make a follow-up paginated request using the - * NextKeyMarker and NextVersionIdMarker response parameters as a - * starting place in another request to return the rest of the - * results. - * * +CommonPrefixes+ - (Array) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Marker+ - (String) + * * +Contents+ - (Array) + * * +Key+ - (String) + * * +LastModified+ - (Date) + * * +ETag+ - (String) + * * +Size+ - (Integer) + * * +StorageClass+ - (String) The class of storage used + * to store the object. + * * +Owner+ - (Object) + * * +ID+ - (String) + * * +DisplayName+ - (String) + * * +Name+ - (String) * * +Prefix+ - (String) + * * +MaxKeys+ - (Integer) + * * +IsTruncated+ - (Boolean) A flag that indicates whether + * (true) or not (false) Amazon S3 returned all of the results that + * satisfied the search criteria. If your results were truncated, + * you can make a follow-up paginated request using the + * NextKeyMarker and NextVersionIdMarker response parameters as a + * starting place in another request to return the rest of the + * results. + * * +CommonPrefixes+ - (Array) + * * +Prefix+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method listParts(params, options) + * @!method listParts(params, callback) * Lists the parts that have been uploaded for a specific multipart * upload. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) * * +Key+ - (*required*, String) * * +UploadId+ - (*required*, String) Upload ID identifying @@ -879,49 +1122,56 @@ AWS.S3 = inherit({}) * * +PartNumberMarker+ - (String) Specifies the part after * which listing should begin. Only parts with higher part numbers * will be listed. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Bucket+ - (String) Name of the bucket to which the - * multipart upload was initiated. - * * +Key+ - (String) Object key for which the multipart - * upload was initiated. - * * +UploadId+ - (String) Upload ID identifying the - * multipart upload whose parts are being listed. - * * +PartNumberMarker+ - (Integer) Part number after which - * listing begins. - * * +NextPartNumberMarker+ - (Integer) When a list is - * truncated, this element specifies the last part in the list, as - * well as the value to use for the part-number-marker request - * parameter in a subsequent request. - * * +MaxParts+ - (Integer) Maximum number of parts that - * were allowed in the response. - * * +IsTruncated+ - (Boolean) Indicates whether the - * returned list of parts is truncated. - * * +Parts+ - (Array) - * * +PartNumber+ - (Integer) Part number identifying the - * part. - * * +LastModified+ - (Date) Date and time at which the - * part was uploaded. - * * +ETag+ - (String) Entity tag returned when the part - * was uploaded. - * * +Size+ - (Integer) Size of the uploaded part data. - * * +Initiator+ - (Object) Identifies who initiated the - * multipart upload. - * * +ID+ - (String) If the principal is an AWS account, - * it provides the Canonical User ID. If the principal is an IAM - * User, it provides a user ARN value. - * * +DisplayName+ - (String) Name of the Principal. - * * +Owner+ - (Object) - * * +ID+ - (String) - * * +DisplayName+ - (String) - * * +StorageClass+ - (String) The class of storage used to - * store the object. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Bucket+ - (String) Name of the bucket to which the + * multipart upload was initiated. + * * +Key+ - (String) Object key for which the multipart + * upload was initiated. + * * +UploadId+ - (String) Upload ID identifying the + * multipart upload whose parts are being listed. + * * +PartNumberMarker+ - (Integer) Part number after which + * listing begins. + * * +NextPartNumberMarker+ - (Integer) When a list is + * truncated, this element specifies the last part in the list, as + * well as the value to use for the part-number-marker request + * parameter in a subsequent request. + * * +MaxParts+ - (Integer) Maximum number of parts that + * were allowed in the response. + * * +IsTruncated+ - (Boolean) Indicates whether the + * returned list of parts is truncated. + * * +Parts+ - (Array) + * * +PartNumber+ - (Integer) Part number identifying the + * part. + * * +LastModified+ - (Date) Date and time at which the + * part was uploaded. + * * +ETag+ - (String) Entity tag returned when the part + * was uploaded. + * * +Size+ - (Integer) Size of the uploaded part data. + * * +Initiator+ - (Object) Identifies who initiated the + * multipart upload. + * * +ID+ - (String) If the principal is an AWS account, + * it provides the Canonical User ID. If the principal is an IAM + * User, it provides a user ARN value. + * * +DisplayName+ - (String) Name of the Principal. + * * +Owner+ - (Object) + * * +ID+ - (String) + * * +DisplayName+ - (String) + * * +StorageClass+ - (String) The class of storage used to + * store the object. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method putBucketAcl(params, options) + * @!method putBucketAcl(params, callback) * Sets the permissions on a bucket using access control lists (ACL). - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) * * +AccessControlPolicy+ - (Object) * * +Owner+ - (Object) @@ -950,12 +1200,20 @@ AWS.S3 = inherit({}) * ACL for the applicable bucket. * * +GrantFullControl+ - (String) Allows grantee the read, * write, read ACP, and write ACP permissions on the bucket. - * @param [Object] options - * @return [AWS.AWSRequest] + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method putBucketCors(params, options) + * @!method putBucketCors(params, callback) * Sets the cors configuration for a bucket. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) * * +CORSConfiguration+ - (Object) * * +CORSRules+ - (Array) @@ -972,13 +1230,21 @@ AWS.S3 = inherit({}) * headers in the response that you want customers to be able * to access from their applications (for example, from a * JavaScript XMLHttpRequest object). - * @param [Object] options - * @return [AWS.AWSRequest] + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method putBucketLifecycle(params, options) + * @!method putBucketLifecycle(params, callback) * Sets lifecycle configuration for your bucket. If a lifecycle * configuration exists, it replaces it. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) * * +LifecycleConfiguration+ - (Object) * * +Rules+ - (*required*, Array) @@ -1005,14 +1271,22 @@ AWS.S3 = inherit({}) * * +Date+ - (Date) Indicates at what date the object * is to be moved or deleted. Should be in GMT ISO 8601 * Format. - * @param [Object] options - * @return [AWS.AWSRequest] + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method putBucketLogging(params, options) + * @!method putBucketLogging(params, callback) * Set the logging parameters for a bucket and to specify permissions * for who can view and modify the logging parameters. To set the * logging status of a bucket, you must be the bucket owner. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) * * +BucketLoggingStatus+ - (*required*, Object) * * +LoggingEnabled+ - (*required*, Object) @@ -1038,12 +1312,20 @@ AWS.S3 = inherit({}) * grantee. * * +URI+ - (String) URI of the grantee group. * * +Permission+ - (String) - * @param [Object] options - * @return [AWS.AWSRequest] + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method putBucketNotification(params, options) + * @!method putBucketNotification(params, callback) * Enables notifications of specified events for a bucket. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) * * +NotificationConfiguration+ - (*required*, Object) * * +TopicConfiguration+ - (*required*, Object) @@ -1052,47 +1334,79 @@ AWS.S3 = inherit({}) * the bucket. * * +Event+ - (String) Bucket event for which to send * notifications. - * @param [Object] options - * @return [AWS.AWSRequest] + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method putBucketPolicy(params, options) + * @!method putBucketPolicy(params, callback) * Replaces a policy on a bucket. If the bucket already has a policy, * the one in this request completely replaces it. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) * * +Policy+ - (*required*, String) The bucket policy as a * JSON document. - * @param [Object] options - * @return [AWS.AWSRequest] + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method putBucketRequestPayment(params, options) + * @!method putBucketRequestPayment(params, callback) * Sets the request payment configuration for a bucket. By default, the * bucket owner pays for downloads from the bucket. This configuration * parameter enables the bucket owner (only) to specify that the person * requesting the download will be charged for the download. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) * * +RequestPaymentConfiguration+ - (*required*, Object) * * +Payer+ - (*required*, String) Specifies who pays for * the download and request fees. - * @param [Object] options - * @return [AWS.AWSRequest] + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method putBucketTagging(params, options) + * @!method putBucketTagging(params, callback) * Sets the tags for a bucket. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) * * +Tagging+ - (*required*, Object) * * +TagSet+ - (*required*, Array) * * +Key+ - (*required*, String) Name of the tag. * * +Value+ - (*required*, String) Value of the tag. - * @param [Object] options - * @return [AWS.AWSRequest] + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method putBucketVersioning(params, options) + * @!method putBucketVersioning(params, callback) * Sets the versioning state of an existing bucket. To set the * versioning state, you must be the bucket owner. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) * * +VersioningConfiguration+ - (*required*, Object) * * +Status+ - (String) The versioning state of the @@ -1105,12 +1419,20 @@ AWS.S3 = inherit({}) * * +MFA+ - (String) The value is the concatenation of the * authentication device''s serial number, a space, and the value * displayed on your authentication device. - * @param [Object] options - * @return [AWS.AWSRequest] + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method putBucketWebsite(params, options) + * @!method putBucketWebsite(params, callback) * Set the website configuration for a bucket. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) * * +WebsiteConfiguration+ - (*required*, Object) * * +IndexDocument+ - (Object) @@ -1124,12 +1446,20 @@ AWS.S3 = inherit({}) * * +ErrorDocument+ - (Object) * * +Key+ - (*required*, String) The object key name to * use when a 4XX class error occurs. - * @param [Object] options - * @return [AWS.AWSRequest] + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method putObject(params, options) + * @!method putObject(params, callback) * Adds an object to a bucket. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) * * +Key+ - (*required*, String) * * +CacheControl+ - (String) Can be used to specify @@ -1164,22 +1494,29 @@ AWS.S3 = inherit({}) * encryption algorithm used when storing this object in S3. * * +Metadata+ - (Object) A map of metadata to * store with the object in S3. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +Expiration+ - (Date) If the object expiration is - * configured, this will contain the expiration date (expiry-date) - * and rule ID (rule-id). The value of rule-id is URL encoded. - * * +ServerSideEncryption+ - (String) The Server-side - * encryption algorithm used when storing this object in S3. - * * +ETag+ - (String) Entity tag for the uploaded object. - * * +VersionId+ - (String) Version of the object. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +Expiration+ - (Date) If the object expiration is + * configured, this will contain the expiration date (expiry-date) + * and rule ID (rule-id). The value of rule-id is URL encoded. + * * +ServerSideEncryption+ - (String) The Server-side + * encryption algorithm used when storing this object in S3. + * * +ETag+ - (String) Entity tag for the uploaded object. + * * +VersionId+ - (String) Version of the object. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method putObjectAcl(params, options) + * @!method putObjectAcl(params, callback) * uses the acl subresource to set the access control list (ACL) * permissions for an object that already exists in a bucket - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) * * +Key+ - (*required*, String) * * +AccessControlPolicy+ - (Object) @@ -1209,23 +1546,39 @@ AWS.S3 = inherit({}) * ACL for the applicable bucket. * * +GrantFullControl+ - (String) Allows grantee the read, * write, read ACP, and write ACP permissions on the bucket. - * @param [Object] options - * @return [AWS.AWSRequest] + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method restoreObject(params, options) + * @!method restoreObject(params, callback) * Restores an archived copy of an object back into Amazon S3 - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) * * +Key+ - (*required*, String) * * +RestoreRequest+ - (Object) * * +Days+ - (*required*, Integer) Lifetime of the active * copy in days - * @param [Object] options - * @return [AWS.AWSRequest] + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method uploadPart(params, options) + * @!method uploadPart(params, callback) * Uploads a part in a multipart upload. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) * * +Key+ - (*required*, String) * * +UploadId+ - (*required*, String) Upload ID identifying @@ -1233,18 +1586,25 @@ AWS.S3 = inherit({}) * * +PartNumber+ - (*required*, String) Part number of part * being uploaded. * * +Body+ - (Base64 Encoded Data) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +ServerSideEncryption+ - (String) The Server-side - * encryption algorithm used when storing this object in S3. - * * +ETag+ - (String) Entity tag for the uploaded object. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +ServerSideEncryption+ - (String) The Server-side + * encryption algorithm used when storing this object in S3. + * * +ETag+ - (String) Entity tag for the uploaded object. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method uploadPartCopy(params, options) + * @!method uploadPartCopy(params, callback) * Uploads a part by copying data from an existing object as data * source. - * @param [Object] params + * @param params [Object] * * +Bucket+ - (*required*, String) * * +Key+ - (*required*, String) * * +UploadId+ - (*required*, String) Upload ID identifying @@ -1268,19 +1628,26 @@ AWS.S3 = inherit({}) * object if it hasn''t been modified since the specified time. * * +CopySourceIfModifiedSince+ - (Date) Copies the object * if it has been modified since the specified time. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +CopySourceVersionId+ - (String) The version of the - * source object that was copied, if you have enabled versioning on - * the source bucket. - * * +CopyPartResult+ - (Object) - * * +ETag+ - (String) Entity tag of the object. - * * +LastModified+ - (Date) Date and time at which the - * object was uploaded. - * * +ServerSideEncryption+ - (String) The Server-side - * encryption algorithm used when storing this object in S3. + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +CopySourceVersionId+ - (String) The version of the + * source object that was copied, if you have enabled versioning on + * the source bucket. + * * +CopyPartResult+ - (Object) + * * +ETag+ - (String) Entity tag of the object. + * * +LastModified+ - (Date) Date and time at which the + * object was uploaded. + * * +ServerSideEncryption+ - (String) The Server-side + * encryption algorithm used when storing this object in S3. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * * * @!method constructor(options) diff --git a/doc-src/simpleworkflow.docs.js b/doc-src/simpleworkflow.docs.js index 46dd80b1c1..20e279b0ea 100644 --- a/doc-src/simpleworkflow.docs.js +++ b/doc-src/simpleworkflow.docs.js @@ -24,8 +24,12 @@ AWS = {}; * === Sending a Request Using SimpleWorkflow * * svc = new AWS.SimpleWorkflow(); - * svc.client.OPERATION_NAME(params).always(function (resp) { - * console.log(resp.data, resp.error); + * svc.client.OPERATION_NAME(params, function (err, data) { + * if (err) { + * console.log(err); // an error occurred + * } else { + * console.log(data); // successful response + * } * }); * * @!method constructor(options) @@ -46,1473 +50,1377 @@ AWS.SimpleWorkflow = inherit({}) * The low-level SimpleWorkflow client class. This class provides one function * for each API operation on the service. * - * @!method countClosedWorkflowExecutions(params, options) - * Returns the number of closed workflow executions within the given - * domain that meet the specified filtering criteria. - * @param [Object] params - * * +domain+ - (*required*, String) The name of the domain - * containing the workflow executions to count. - * * +startTimeFilter+ - (Object) If specified, only - * workflow executions that meet the start time criteria of the - * filter are counted. + * @!method countClosedWorkflowExecutions(params, callback) + * Calls the CountClosedWorkflowExecutions API operation. + * @param params [Object] + * * +domain+ - (*required*, String) + * * +startTimeFilter+ - (Object) * * +oldestDate+ - (*required*, Date) * * +latestDate+ - (Date) - * * +closeTimeFilter+ - (Object) If specified, only - * workflow executions that meet the close time criteria of the - * filter are counted. + * * +closeTimeFilter+ - (Object) * * +oldestDate+ - (*required*, Date) * * +latestDate+ - (Date) - * * +executionFilter+ - (Object) If specified, only - * workflow executions matching the WorkflowId in the filter are - * counted. + * * +executionFilter+ - (Object) * * +workflowId+ - (*required*, String) - * * +typeFilter+ - (Object) If specified, indicates the - * type of the workflow executions to be counted. + * * +typeFilter+ - (Object) * * +name+ - (*required*, String) * * +version+ - (String) - * * +tagFilter+ - (Object) If specified, only executions - * that have a tag that matches the filter are counted. + * * +tagFilter+ - (Object) * * +tag+ - (*required*, String) - * * +closeStatusFilter+ - (Object) If specified, only - * workflow executions that match this close status are counted. - * This filter has an affect only if executionStatus is specified - * as CLOSED. + * * +closeStatusFilter+ - (Object) * * +status+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +count+ - (Integer) - * * +truncated+ - (Boolean) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +count+ - (Integer) + * * +truncated+ - (Boolean) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method countOpenWorkflowExecutions(params, options) - * Returns the number of open workflow executions within the given - * domain that meet the specified filtering criteria. - * @param [Object] params - * * +domain+ - (*required*, String) The name of the domain - * containing the workflow executions to count. - * * +startTimeFilter+ - (*required*, Object) Specifies the - * start time criteria that workflow executions must meet in order - * to be counted. + * @!method countOpenWorkflowExecutions(params, callback) + * Calls the CountOpenWorkflowExecutions API operation. + * @param params [Object] + * * +domain+ - (*required*, String) + * * +startTimeFilter+ - (*required*, Object) * * +oldestDate+ - (*required*, Date) * * +latestDate+ - (Date) - * * +typeFilter+ - (Object) Specifies the type of the - * workflow executions to be counted. + * * +typeFilter+ - (Object) * * +name+ - (*required*, String) * * +version+ - (String) - * * +tagFilter+ - (Object) If specified, only executions - * that have a tag that matches the filter are counted. + * * +tagFilter+ - (Object) * * +tag+ - (*required*, String) - * * +executionFilter+ - (Object) If specified, only - * workflow executions matching the WorkflowId in the filter are - * counted. + * * +executionFilter+ - (Object) * * +workflowId+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +count+ - (Integer) - * * +truncated+ - (Boolean) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +count+ - (Integer) + * * +truncated+ - (Boolean) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method countPendingActivityTasks(params, options) - * Returns the estimated number of activity tasks in the specified task - * list. The count returned is an approximation and is not guaranteed - * to be exact. If you specify a task list that no activity task was - * ever scheduled in then 0 will be returned. - * @param [Object] params - * * +domain+ - (*required*, String) The name of the domain - * that contains the task list. - * * +taskList+ - (*required*, Object) The name of the task - * list. + * @!method countPendingActivityTasks(params, callback) + * Calls the CountPendingActivityTasks API operation. + * @param params [Object] + * * +domain+ - (*required*, String) + * * +taskList+ - (*required*, Object) * * +name+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +count+ - (Integer) - * * +truncated+ - (Boolean) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +count+ - (Integer) + * * +truncated+ - (Boolean) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method countPendingDecisionTasks(params, options) - * Returns the estimated number of decision tasks in the specified task - * list. The count returned is an approximation and is not guaranteed - * to be exact. If you specify a task list that no decision task was - * ever scheduled in then 0 will be returned. - * @param [Object] params - * * +domain+ - (*required*, String) The name of the domain - * that contains the task list. - * * +taskList+ - (*required*, Object) The name of the task - * list. + * @!method countPendingDecisionTasks(params, callback) + * Calls the CountPendingDecisionTasks API operation. + * @param params [Object] + * * +domain+ - (*required*, String) + * * +taskList+ - (*required*, Object) * * +name+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +count+ - (Integer) - * * +truncated+ - (Boolean) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +count+ - (Integer) + * * +truncated+ - (Boolean) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method deprecateActivityType(params, options) - * Deprecates the specified activity type. After an activity type has - * been deprecated, you cannot create new tasks of that activity type. - * Tasks of this type that were scheduled before the type was - * deprecated will continue to run. - * @param [Object] params - * * +domain+ - (*required*, String) The name of the domain - * in which the activity type is registered. - * * +activityType+ - (*required*, Object) The activity type - * to deprecate. + * @!method deprecateActivityType(params, callback) + * Calls the DeprecateActivityType API operation. + * @param params [Object] + * * +domain+ - (*required*, String) + * * +activityType+ - (*required*, Object) * * +name+ - (*required*, String) * * +version+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method deprecateDomain(params, options) - * Deprecates the specified domain. After a domain has been deprecated - * it cannot be used to create new workflow executions or register new - * types. However, you can still use visibility actions on this domain. - * Deprecating a domain also deprecates all activity and workflow types - * registered in the domain. Executions that were started before the - * domain was deprecated will continue to run. - * @param [Object] params - * * +name+ - (*required*, String) The name of the domain to - * deprecate. - * @param [Object] options - * @return [AWS.AWSRequest] + * @!method deprecateDomain(params, callback) + * Calls the DeprecateDomain API operation. + * @param params [Object] + * * +name+ - (*required*, String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method deprecateWorkflowType(params, options) - * Deprecates the specified workflow type. After a workflow type has - * been deprecated, you cannot create new executions of that type. - * Executions that were started before the type was deprecated will - * continue to run. A deprecated workflow type may still be used when - * calling visibility actions. - * @param [Object] params - * * +domain+ - (*required*, String) The name of the domain - * in which the workflow type is registered. - * * +workflowType+ - (*required*, Object) The workflow type - * to deprecate. + * @!method deprecateWorkflowType(params, callback) + * Calls the DeprecateWorkflowType API operation. + * @param params [Object] + * * +domain+ - (*required*, String) + * * +workflowType+ - (*required*, Object) * * +name+ - (*required*, String) * * +version+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method describeActivityType(params, options) - * Returns information about the specified activity type. This includes - * configuration settings provided at registration time as well as - * other general information about the type. - * @param [Object] params - * * +domain+ - (*required*, String) The name of the domain - * in which the activity type is registered. - * * +activityType+ - (*required*, Object) The activity type - * to describe. + * @!method describeActivityType(params, callback) + * Calls the DescribeActivityType API operation. + * @param params [Object] + * * +domain+ - (*required*, String) + * * +activityType+ - (*required*, Object) * * +name+ - (*required*, String) * * +version+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +typeInfo+ - (Object) - * * +activityType+ - (Object) - * * +name+ - (String) - * * +version+ - (String) - * * +status+ - (String) - * * +description+ - (String) - * * +creationDate+ - (Date) - * * +deprecationDate+ - (Date) - * * +configuration+ - (Object) - * * +defaultTaskStartToCloseTimeout+ - (String) - * * +defaultTaskHeartbeatTimeout+ - (String) - * * +defaultTaskList+ - (Object) - * * +name+ - (String) - * * +defaultTaskScheduleToStartTimeout+ - (String) - * * +defaultTaskScheduleToCloseTimeout+ - (String) - * - * @!method describeDomain(params, options) - * Returns information about the specified domain including description - * and status. - * @param [Object] params - * * +name+ - (*required*, String) The name of the domain to - * describe. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +domainInfo+ - (Object) - * * +name+ - (String) - * * +status+ - (String) - * * +description+ - (String) - * * +configuration+ - (Object) - * * +workflowExecutionRetentionPeriodInDays+ - (*required*, - * String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +typeInfo+ - (Object) + * * +activityType+ - (Object) + * * +name+ - (String) + * * +version+ - (String) + * * +status+ - (String) + * * +description+ - (String) + * * +creationDate+ - (Date) + * * +deprecationDate+ - (Date) + * * +configuration+ - (Object) + * * +defaultTaskStartToCloseTimeout+ - (String) + * * +defaultTaskHeartbeatTimeout+ - (String) + * * +defaultTaskList+ - (Object) + * * +name+ - (String) + * * +defaultTaskScheduleToStartTimeout+ - (String) + * * +defaultTaskScheduleToCloseTimeout+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method describeWorkflowExecution(params, options) - * Returns information about the specified workflow execution including - * its type and some statistics. - * @param [Object] params - * * +domain+ - (*required*, String) The name of the domain - * containing the workflow execution. - * * +execution+ - (*required*, Object) The workflow - * execution to describe. - * * +workflowId+ - (*required*, String) - * * +runId+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +executionInfo+ - (Object) - * * +execution+ - (Object) - * * +workflowId+ - (String) - * * +runId+ - (String) - * * +workflowType+ - (Object) + * @!method describeDomain(params, callback) + * Calls the DescribeDomain API operation. + * @param params [Object] + * * +name+ - (*required*, String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +domainInfo+ - (Object) * * +name+ - (String) - * * +version+ - (String) - * * +startTimestamp+ - (Date) - * * +closeTimestamp+ - (Date) - * * +executionStatus+ - (String) - * * +closeStatus+ - (String) - * * +parent+ - (Object) - * * +workflowId+ - (String) - * * +runId+ - (String) - * * +tagList+ - (Array) - * * +cancelRequested+ - (Boolean) - * * +executionConfiguration+ - (Object) - * * +taskStartToCloseTimeout+ - (String) - * * +executionStartToCloseTimeout+ - (String) - * * +taskList+ - (Object) - * * +name+ - (String) - * * +childPolicy+ - (String) - * * +openCounts+ - (Object) - * * +openActivityTasks+ - (Integer) - * * +openDecisionTasks+ - (Integer) - * * +openTimers+ - (Integer) - * * +openChildWorkflowExecutions+ - (Integer) - * * +latestActivityTaskTimestamp+ - (Date) - * * +latestExecutionContext+ - (String) + * * +status+ - (String) + * * +description+ - (String) + * * +configuration+ - (Object) + * * +workflowExecutionRetentionPeriodInDays+ - (*required*, + * String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method describeWorkflowType(params, options) - * Returns information about the specified workflow type. This includes - * configuration settings specified when the type was registered and - * other information such as creation date, current status, etc. - * @param [Object] params - * * +domain+ - (*required*, String) The name of the domain - * in which this workflow type is registered. - * * +workflowType+ - (*required*, Object) The workflow type - * to describe. - * * +name+ - (*required*, String) - * * +version+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +typeInfo+ - (Object) - * * +workflowType+ - (Object) - * * +name+ - (String) - * * +version+ - (String) - * * +status+ - (String) - * * +description+ - (String) - * * +creationDate+ - (Date) - * * +deprecationDate+ - (Date) - * * +configuration+ - (Object) - * * +defaultTaskStartToCloseTimeout+ - (String) - * * +defaultExecutionStartToCloseTimeout+ - (String) - * * +defaultTaskList+ - (Object) - * * +name+ - (String) - * * +defaultChildPolicy+ - (String) - * - * @!method getWorkflowExecutionHistory(params, options) - * Returns the history of the specified workflow execution. The results - * may be split into multiple pages. To retrieve subsequent pages, make - * the call again using the nextPageToken returned by the initial call. - * @param [Object] params - * * +domain+ - (*required*, String) The name of the domain - * containing the workflow execution. - * * +execution+ - (*required*, Object) Specifies the - * workflow execution for which to return the history. + * @!method describeWorkflowExecution(params, callback) + * Calls the DescribeWorkflowExecution API operation. + * @param params [Object] + * * +domain+ - (*required*, String) + * * +execution+ - (*required*, Object) * * +workflowId+ - (*required*, String) * * +runId+ - (*required*, String) - * * +nextPageToken+ - (String) If a NextPageToken is - * returned, the result has more than one pages. To get the next - * page, repeat the call and specify the nextPageToken with all - * other arguments unchanged. - * * +maximumPageSize+ - (Integer) Specifies the maximum - * number of history events returned in one page. The next page in - * the result is identified by the NextPageToken returned. By - * default 100 history events are returned in a page but the caller - * can override this value to a page size smaller than the default. - * You cannot specify a page size larger than 100. - * * +reverseOrder+ - (Boolean) When set to true, returns - * the events in reverse order. By default the results are returned - * in ascending order of the eventTimeStamp of the events. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +events+ - (Array) - * * +eventTimestamp+ - (Date) - * * +eventType+ - (String) - * * +eventId+ - (Integer) - * * +workflowExecutionStartedEventAttributes+ - (Object) - * * +input+ - (String) - * * +executionStartToCloseTimeout+ - (String) - * * +taskStartToCloseTimeout+ - (String) - * * +childPolicy+ - (String) - * * +taskList+ - (Object) - * * +name+ - (String) - * * +workflowType+ - (Object) - * * +name+ - (String) - * * +version+ - (String) - * * +tagList+ - (Array) - * * +continuedExecutionRunId+ - (String) - * * +parentWorkflowExecution+ - (Object) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +executionInfo+ - (Object) + * * +execution+ - (Object) * * +workflowId+ - (String) * * +runId+ - (String) - * * +parentInitiatedEventId+ - (Integer) - * * +workflowExecutionCompletedEventAttributes+ - - * (Object) - * * +result+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +completeWorkflowExecutionFailedEventAttributes+ - - * (Object) - * * +cause+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +workflowExecutionFailedEventAttributes+ - (Object) - * * +reason+ - (String) - * * +details+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +failWorkflowExecutionFailedEventAttributes+ - - * (Object) - * * +cause+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +workflowExecutionTimedOutEventAttributes+ - (Object) - * * +timeoutType+ - (String) - * * +childPolicy+ - (String) - * * +workflowExecutionCanceledEventAttributes+ - (Object) - * * +details+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +cancelWorkflowExecutionFailedEventAttributes+ - - * (Object) - * * +cause+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +workflowExecutionContinuedAsNewEventAttributes+ - - * (Object) - * * +input+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +newExecutionRunId+ - (String) - * * +executionStartToCloseTimeout+ - (String) - * * +taskList+ - (Object) - * * +name+ - (String) - * * +taskStartToCloseTimeout+ - (String) - * * +childPolicy+ - (String) - * * +tagList+ - (Array) * * +workflowType+ - (Object) * * +name+ - (String) * * +version+ - (String) - * * +continueAsNewWorkflowExecutionFailedEventAttributes+ - - * (Object) - * * +cause+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +workflowExecutionTerminatedEventAttributes+ - - * (Object) - * * +reason+ - (String) - * * +details+ - (String) - * * +childPolicy+ - (String) - * * +cause+ - (String) - * * +workflowExecutionCancelRequestedEventAttributes+ - - * (Object) - * * +externalWorkflowExecution+ - (Object) + * * +startTimestamp+ - (Date) + * * +closeTimestamp+ - (Date) + * * +executionStatus+ - (String) + * * +closeStatus+ - (String) + * * +parent+ - (Object) * * +workflowId+ - (String) * * +runId+ - (String) - * * +externalInitiatedEventId+ - (Integer) - * * +cause+ - (String) - * * +decisionTaskScheduledEventAttributes+ - (Object) - * * +taskList+ - (Object) - * * +name+ - (String) - * * +startToCloseTimeout+ - (String) - * * +decisionTaskStartedEventAttributes+ - (Object) - * * +identity+ - (String) - * * +scheduledEventId+ - (Integer) - * * +decisionTaskCompletedEventAttributes+ - (Object) - * * +executionContext+ - (String) - * * +scheduledEventId+ - (Integer) - * * +startedEventId+ - (Integer) - * * +decisionTaskTimedOutEventAttributes+ - (Object) - * * +timeoutType+ - (String) - * * +scheduledEventId+ - (Integer) - * * +startedEventId+ - (Integer) - * * +activityTaskScheduledEventAttributes+ - (Object) - * * +activityType+ - (Object) - * * +name+ - (String) - * * +version+ - (String) - * * +activityId+ - (String) - * * +input+ - (String) - * * +control+ - (String) - * * +scheduleToStartTimeout+ - (String) - * * +scheduleToCloseTimeout+ - (String) - * * +startToCloseTimeout+ - (String) - * * +taskList+ - (Object) - * * +name+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +heartbeatTimeout+ - (String) - * * +activityTaskStartedEventAttributes+ - (Object) - * * +identity+ - (String) - * * +scheduledEventId+ - (Integer) - * * +activityTaskCompletedEventAttributes+ - (Object) - * * +result+ - (String) - * * +scheduledEventId+ - (Integer) - * * +startedEventId+ - (Integer) - * * +activityTaskFailedEventAttributes+ - (Object) - * * +reason+ - (String) - * * +details+ - (String) - * * +scheduledEventId+ - (Integer) - * * +startedEventId+ - (Integer) - * * +activityTaskTimedOutEventAttributes+ - (Object) - * * +timeoutType+ - (String) - * * +scheduledEventId+ - (Integer) - * * +startedEventId+ - (Integer) - * * +details+ - (String) - * * +activityTaskCanceledEventAttributes+ - (Object) - * * +details+ - (String) - * * +scheduledEventId+ - (Integer) - * * +startedEventId+ - (Integer) - * * +latestCancelRequestedEventId+ - (Integer) - * * +activityTaskCancelRequestedEventAttributes+ - - * (Object) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +activityId+ - (String) - * * +workflowExecutionSignaledEventAttributes+ - (Object) - * * +signalName+ - (String) - * * +input+ - (String) - * * +externalWorkflowExecution+ - (Object) - * * +workflowId+ - (String) - * * +runId+ - (String) - * * +externalInitiatedEventId+ - (Integer) - * * +markerRecordedEventAttributes+ - (Object) - * * +markerName+ - (String) - * * +details+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +timerStartedEventAttributes+ - (Object) - * * +timerId+ - (String) - * * +control+ - (String) - * * +startToFireTimeout+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +timerFiredEventAttributes+ - (Object) - * * +timerId+ - (String) - * * +startedEventId+ - (Integer) - * * +timerCanceledEventAttributes+ - (Object) - * * +timerId+ - (String) - * * +startedEventId+ - (Integer) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +startChildWorkflowExecutionInitiatedEventAttributes+ - - * (Object) - * * +workflowId+ - (String) - * * +workflowType+ - (Object) - * * +name+ - (String) - * * +version+ - (String) - * * +control+ - (String) - * * +input+ - (String) + * * +tagList+ - (Array) + * * +cancelRequested+ - (Boolean) + * * +executionConfiguration+ - (Object) + * * +taskStartToCloseTimeout+ - (String) * * +executionStartToCloseTimeout+ - (String) * * +taskList+ - (Object) * * +name+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) * * +childPolicy+ - (String) - * * +taskStartToCloseTimeout+ - (String) - * * +tagList+ - (Array) - * * +childWorkflowExecutionStartedEventAttributes+ - - * (Object) - * * +workflowExecution+ - (Object) - * * +workflowId+ - (String) - * * +runId+ - (String) + * * +openCounts+ - (Object) + * * +openActivityTasks+ - (Integer) + * * +openDecisionTasks+ - (Integer) + * * +openTimers+ - (Integer) + * * +openChildWorkflowExecutions+ - (Integer) + * * +latestActivityTaskTimestamp+ - (Date) + * * +latestExecutionContext+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method describeWorkflowType(params, callback) + * Calls the DescribeWorkflowType API operation. + * @param params [Object] + * * +domain+ - (*required*, String) + * * +workflowType+ - (*required*, Object) + * * +name+ - (*required*, String) + * * +version+ - (*required*, String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +typeInfo+ - (Object) * * +workflowType+ - (Object) * * +name+ - (String) * * +version+ - (String) - * * +initiatedEventId+ - (Integer) - * * +childWorkflowExecutionCompletedEventAttributes+ - - * (Object) - * * +workflowExecution+ - (Object) - * * +workflowId+ - (String) - * * +runId+ - (String) - * * +workflowType+ - (Object) + * * +status+ - (String) + * * +description+ - (String) + * * +creationDate+ - (Date) + * * +deprecationDate+ - (Date) + * * +configuration+ - (Object) + * * +defaultTaskStartToCloseTimeout+ - (String) + * * +defaultExecutionStartToCloseTimeout+ - (String) + * * +defaultTaskList+ - (Object) * * +name+ - (String) - * * +version+ - (String) - * * +result+ - (String) - * * +initiatedEventId+ - (Integer) - * * +startedEventId+ - (Integer) - * * +childWorkflowExecutionFailedEventAttributes+ - - * (Object) - * * +workflowExecution+ - (Object) + * * +defaultChildPolicy+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method getWorkflowExecutionHistory(params, callback) + * Calls the GetWorkflowExecutionHistory API operation. + * @param params [Object] + * * +domain+ - (*required*, String) + * * +execution+ - (*required*, Object) + * * +workflowId+ - (*required*, String) + * * +runId+ - (*required*, String) + * * +nextPageToken+ - (String) + * * +maximumPageSize+ - (Integer) + * * +reverseOrder+ - (Boolean) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +events+ - (Array) + * * +eventTimestamp+ - (Date) + * * +eventType+ - (String) + * * +eventId+ - (Integer) + * * +workflowExecutionStartedEventAttributes+ - (Object) + * * +input+ - (String) + * * +executionStartToCloseTimeout+ - (String) + * * +taskStartToCloseTimeout+ - (String) + * * +childPolicy+ - (String) + * * +taskList+ - (Object) + * * +name+ - (String) + * * +workflowType+ - (Object) + * * +name+ - (String) + * * +version+ - (String) + * * +tagList+ - (Array) + * * +continuedExecutionRunId+ - (String) + * * +parentWorkflowExecution+ - (Object) + * * +workflowId+ - (String) + * * +runId+ - (String) + * * +parentInitiatedEventId+ - (Integer) + * * +workflowExecutionCompletedEventAttributes+ - + * (Object) + * * +result+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +completeWorkflowExecutionFailedEventAttributes+ - + * (Object) + * * +cause+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +workflowExecutionFailedEventAttributes+ - (Object) + * * +reason+ - (String) + * * +details+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +failWorkflowExecutionFailedEventAttributes+ - + * (Object) + * * +cause+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +workflowExecutionTimedOutEventAttributes+ - (Object) + * * +timeoutType+ - (String) + * * +childPolicy+ - (String) + * * +workflowExecutionCanceledEventAttributes+ - (Object) + * * +details+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +cancelWorkflowExecutionFailedEventAttributes+ - + * (Object) + * * +cause+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +workflowExecutionContinuedAsNewEventAttributes+ - + * (Object) + * * +input+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +newExecutionRunId+ - (String) + * * +executionStartToCloseTimeout+ - (String) + * * +taskList+ - (Object) + * * +name+ - (String) + * * +taskStartToCloseTimeout+ - (String) + * * +childPolicy+ - (String) + * * +tagList+ - (Array) + * * +workflowType+ - (Object) + * * +name+ - (String) + * * +version+ - (String) + * * +continueAsNewWorkflowExecutionFailedEventAttributes+ - + * (Object) + * * +cause+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +workflowExecutionTerminatedEventAttributes+ - + * (Object) + * * +reason+ - (String) + * * +details+ - (String) + * * +childPolicy+ - (String) + * * +cause+ - (String) + * * +workflowExecutionCancelRequestedEventAttributes+ - + * (Object) + * * +externalWorkflowExecution+ - (Object) + * * +workflowId+ - (String) + * * +runId+ - (String) + * * +externalInitiatedEventId+ - (Integer) + * * +cause+ - (String) + * * +decisionTaskScheduledEventAttributes+ - (Object) + * * +taskList+ - (Object) + * * +name+ - (String) + * * +startToCloseTimeout+ - (String) + * * +decisionTaskStartedEventAttributes+ - (Object) + * * +identity+ - (String) + * * +scheduledEventId+ - (Integer) + * * +decisionTaskCompletedEventAttributes+ - (Object) + * * +executionContext+ - (String) + * * +scheduledEventId+ - (Integer) + * * +startedEventId+ - (Integer) + * * +decisionTaskTimedOutEventAttributes+ - (Object) + * * +timeoutType+ - (String) + * * +scheduledEventId+ - (Integer) + * * +startedEventId+ - (Integer) + * * +activityTaskScheduledEventAttributes+ - (Object) + * * +activityType+ - (Object) + * * +name+ - (String) + * * +version+ - (String) + * * +activityId+ - (String) + * * +input+ - (String) + * * +control+ - (String) + * * +scheduleToStartTimeout+ - (String) + * * +scheduleToCloseTimeout+ - (String) + * * +startToCloseTimeout+ - (String) + * * +taskList+ - (Object) + * * +name+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +heartbeatTimeout+ - (String) + * * +activityTaskStartedEventAttributes+ - (Object) + * * +identity+ - (String) + * * +scheduledEventId+ - (Integer) + * * +activityTaskCompletedEventAttributes+ - (Object) + * * +result+ - (String) + * * +scheduledEventId+ - (Integer) + * * +startedEventId+ - (Integer) + * * +activityTaskFailedEventAttributes+ - (Object) + * * +reason+ - (String) + * * +details+ - (String) + * * +scheduledEventId+ - (Integer) + * * +startedEventId+ - (Integer) + * * +activityTaskTimedOutEventAttributes+ - (Object) + * * +timeoutType+ - (String) + * * +scheduledEventId+ - (Integer) + * * +startedEventId+ - (Integer) + * * +details+ - (String) + * * +activityTaskCanceledEventAttributes+ - (Object) + * * +details+ - (String) + * * +scheduledEventId+ - (Integer) + * * +startedEventId+ - (Integer) + * * +latestCancelRequestedEventId+ - (Integer) + * * +activityTaskCancelRequestedEventAttributes+ - + * (Object) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +activityId+ - (String) + * * +workflowExecutionSignaledEventAttributes+ - (Object) + * * +signalName+ - (String) + * * +input+ - (String) + * * +externalWorkflowExecution+ - (Object) + * * +workflowId+ - (String) + * * +runId+ - (String) + * * +externalInitiatedEventId+ - (Integer) + * * +markerRecordedEventAttributes+ - (Object) + * * +markerName+ - (String) + * * +details+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +timerStartedEventAttributes+ - (Object) + * * +timerId+ - (String) + * * +control+ - (String) + * * +startToFireTimeout+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +timerFiredEventAttributes+ - (Object) + * * +timerId+ - (String) + * * +startedEventId+ - (Integer) + * * +timerCanceledEventAttributes+ - (Object) + * * +timerId+ - (String) + * * +startedEventId+ - (Integer) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +startChildWorkflowExecutionInitiatedEventAttributes+ - + * (Object) * * +workflowId+ - (String) - * * +runId+ - (String) - * * +workflowType+ - (Object) - * * +name+ - (String) - * * +version+ - (String) - * * +reason+ - (String) - * * +details+ - (String) - * * +initiatedEventId+ - (Integer) - * * +startedEventId+ - (Integer) - * * +childWorkflowExecutionTimedOutEventAttributes+ - - * (Object) - * * +workflowExecution+ - (Object) + * * +workflowType+ - (Object) + * * +name+ - (String) + * * +version+ - (String) + * * +control+ - (String) + * * +input+ - (String) + * * +executionStartToCloseTimeout+ - (String) + * * +taskList+ - (Object) + * * +name+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +childPolicy+ - (String) + * * +taskStartToCloseTimeout+ - (String) + * * +tagList+ - (Array) + * * +childWorkflowExecutionStartedEventAttributes+ - + * (Object) + * * +workflowExecution+ - (Object) + * * +workflowId+ - (String) + * * +runId+ - (String) + * * +workflowType+ - (Object) + * * +name+ - (String) + * * +version+ - (String) + * * +initiatedEventId+ - (Integer) + * * +childWorkflowExecutionCompletedEventAttributes+ - + * (Object) + * * +workflowExecution+ - (Object) + * * +workflowId+ - (String) + * * +runId+ - (String) + * * +workflowType+ - (Object) + * * +name+ - (String) + * * +version+ - (String) + * * +result+ - (String) + * * +initiatedEventId+ - (Integer) + * * +startedEventId+ - (Integer) + * * +childWorkflowExecutionFailedEventAttributes+ - + * (Object) + * * +workflowExecution+ - (Object) + * * +workflowId+ - (String) + * * +runId+ - (String) + * * +workflowType+ - (Object) + * * +name+ - (String) + * * +version+ - (String) + * * +reason+ - (String) + * * +details+ - (String) + * * +initiatedEventId+ - (Integer) + * * +startedEventId+ - (Integer) + * * +childWorkflowExecutionTimedOutEventAttributes+ - + * (Object) + * * +workflowExecution+ - (Object) + * * +workflowId+ - (String) + * * +runId+ - (String) + * * +workflowType+ - (Object) + * * +name+ - (String) + * * +version+ - (String) + * * +timeoutType+ - (String) + * * +initiatedEventId+ - (Integer) + * * +startedEventId+ - (Integer) + * * +childWorkflowExecutionCanceledEventAttributes+ - + * (Object) + * * +workflowExecution+ - (Object) + * * +workflowId+ - (String) + * * +runId+ - (String) + * * +workflowType+ - (Object) + * * +name+ - (String) + * * +version+ - (String) + * * +details+ - (String) + * * +initiatedEventId+ - (Integer) + * * +startedEventId+ - (Integer) + * * +childWorkflowExecutionTerminatedEventAttributes+ - + * (Object) + * * +workflowExecution+ - (Object) + * * +workflowId+ - (String) + * * +runId+ - (String) + * * +workflowType+ - (Object) + * * +name+ - (String) + * * +version+ - (String) + * * +initiatedEventId+ - (Integer) + * * +startedEventId+ - (Integer) + * * +signalExternalWorkflowExecutionInitiatedEventAttributes+ - + * (Object) * * +workflowId+ - (String) * * +runId+ - (String) - * * +workflowType+ - (Object) - * * +name+ - (String) - * * +version+ - (String) - * * +timeoutType+ - (String) - * * +initiatedEventId+ - (Integer) - * * +startedEventId+ - (Integer) - * * +childWorkflowExecutionCanceledEventAttributes+ - - * (Object) - * * +workflowExecution+ - (Object) + * * +signalName+ - (String) + * * +input+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +control+ - (String) + * * +externalWorkflowExecutionSignaledEventAttributes+ - + * (Object) + * * +workflowExecution+ - (Object) + * * +workflowId+ - (String) + * * +runId+ - (String) + * * +initiatedEventId+ - (Integer) + * * +signalExternalWorkflowExecutionFailedEventAttributes+ - + * (Object) * * +workflowId+ - (String) * * +runId+ - (String) - * * +workflowType+ - (Object) - * * +name+ - (String) - * * +version+ - (String) - * * +details+ - (String) - * * +initiatedEventId+ - (Integer) - * * +startedEventId+ - (Integer) - * * +childWorkflowExecutionTerminatedEventAttributes+ - - * (Object) - * * +workflowExecution+ - (Object) + * * +cause+ - (String) + * * +initiatedEventId+ - (Integer) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +control+ - (String) + * * +externalWorkflowExecutionCancelRequestedEventAttributes+ - + * (Object) + * * +workflowExecution+ - (Object) + * * +workflowId+ - (String) + * * +runId+ - (String) + * * +initiatedEventId+ - (Integer) + * * + * +requestCancelExternalWorkflowExecutionInitiatedEventAttributes+ + * - (Object) * * +workflowId+ - (String) * * +runId+ - (String) - * * +workflowType+ - (Object) - * * +name+ - (String) - * * +version+ - (String) - * * +initiatedEventId+ - (Integer) - * * +startedEventId+ - (Integer) - * * +signalExternalWorkflowExecutionInitiatedEventAttributes+ - - * (Object) - * * +workflowId+ - (String) - * * +runId+ - (String) - * * +signalName+ - (String) - * * +input+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +control+ - (String) - * * +externalWorkflowExecutionSignaledEventAttributes+ - - * (Object) - * * +workflowExecution+ - (Object) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +control+ - (String) + * * +requestCancelExternalWorkflowExecutionFailedEventAttributes+ + * - (Object) * * +workflowId+ - (String) * * +runId+ - (String) - * * +initiatedEventId+ - (Integer) - * * +signalExternalWorkflowExecutionFailedEventAttributes+ - - * (Object) - * * +workflowId+ - (String) - * * +runId+ - (String) - * * +cause+ - (String) - * * +initiatedEventId+ - (Integer) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +control+ - (String) - * * +externalWorkflowExecutionCancelRequestedEventAttributes+ - - * (Object) - * * +workflowExecution+ - (Object) + * * +cause+ - (String) + * * +initiatedEventId+ - (Integer) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +control+ - (String) + * * +scheduleActivityTaskFailedEventAttributes+ - + * (Object) + * * +activityType+ - (Object) + * * +name+ - (String) + * * +version+ - (String) + * * +activityId+ - (String) + * * +cause+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +requestCancelActivityTaskFailedEventAttributes+ - + * (Object) + * * +activityId+ - (String) + * * +cause+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +startTimerFailedEventAttributes+ - (Object) + * * +timerId+ - (String) + * * +cause+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +cancelTimerFailedEventAttributes+ - (Object) + * * +timerId+ - (String) + * * +cause+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +startChildWorkflowExecutionFailedEventAttributes+ - + * (Object) + * * +workflowType+ - (Object) + * * +name+ - (String) + * * +version+ - (String) + * * +cause+ - (String) * * +workflowId+ - (String) - * * +runId+ - (String) - * * +initiatedEventId+ - (Integer) - * * - * +requestCancelExternalWorkflowExecutionInitiatedEventAttributes+ - * - (Object) - * * +workflowId+ - (String) - * * +runId+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +control+ - (String) - * * +requestCancelExternalWorkflowExecutionFailedEventAttributes+ - * - (Object) - * * +workflowId+ - (String) - * * +runId+ - (String) - * * +cause+ - (String) - * * +initiatedEventId+ - (Integer) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +control+ - (String) - * * +scheduleActivityTaskFailedEventAttributes+ - - * (Object) + * * +initiatedEventId+ - (Integer) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +control+ - (String) + * * +nextPageToken+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method listActivityTypes(params, callback) + * Calls the ListActivityTypes API operation. + * @param params [Object] + * * +domain+ - (*required*, String) + * * +name+ - (String) + * * +registrationStatus+ - (*required*, String) + * * +nextPageToken+ - (String) + * * +maximumPageSize+ - (Integer) + * * +reverseOrder+ - (Boolean) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +typeInfos+ - (Array) * * +activityType+ - (Object) * * +name+ - (String) * * +version+ - (String) - * * +activityId+ - (String) - * * +cause+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +requestCancelActivityTaskFailedEventAttributes+ - - * (Object) - * * +activityId+ - (String) - * * +cause+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +startTimerFailedEventAttributes+ - (Object) - * * +timerId+ - (String) - * * +cause+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +cancelTimerFailedEventAttributes+ - (Object) - * * +timerId+ - (String) - * * +cause+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +startChildWorkflowExecutionFailedEventAttributes+ - - * (Object) - * * +workflowType+ - (Object) - * * +name+ - (String) - * * +version+ - (String) - * * +cause+ - (String) - * * +workflowId+ - (String) - * * +initiatedEventId+ - (Integer) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +control+ - (String) - * * +nextPageToken+ - (String) + * * +status+ - (String) + * * +description+ - (String) + * * +creationDate+ - (Date) + * * +deprecationDate+ - (Date) + * * +nextPageToken+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method listActivityTypes(params, options) - * Returns information about all activities registered in the specified - * domain that match the specified name and registration status. The - * result includes information like creation date, current status of - * the activity, etc. The results may be split into multiple pages. To - * retrieve subsequent pages, make the call again using the - * nextPageToken returned by the initial call. - * @param [Object] params - * * +domain+ - (*required*, String) The name of the domain - * in which the activity types have been registered. - * * +name+ - (String) If specified, only lists the activity - * types that have this name. - * * +registrationStatus+ - (*required*, String) Specifies - * the registration status of the activity types to list. - * * +nextPageToken+ - (String) If on a previous call to - * this method a NextResultToken was returned, the results have - * more than one page. To get the next page of results, repeat the - * call with the nextPageToken and keep all other arguments - * unchanged. - * * +maximumPageSize+ - (Integer) The maximum number of - * results returned in each page. The default is 100, but the - * caller can override this value to a page size smaller than the - * default. You cannot specify a page size greater than 100. - * * +reverseOrder+ - (Boolean) When set to true, returns - * the results in reverse order. By default the results are - * returned in ascending alphabetical order of the name of the - * activity types. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +typeInfos+ - (Array) - * * +activityType+ - (Object) - * * +name+ - (String) - * * +version+ - (String) - * * +status+ - (String) - * * +description+ - (String) - * * +creationDate+ - (Date) - * * +deprecationDate+ - (Date) - * * +nextPageToken+ - (String) - * - * @!method listClosedWorkflowExecutions(params, options) - * Returns a list of closed workflow executions in the specified domain - * that meet the filtering criteria. The results may be split into - * multiple pages. To retrieve subsequent pages, make the call again - * using the nextPageToken returned by the initial call. - * @param [Object] params - * * +domain+ - (*required*, String) The name of the domain - * that contains the workflow executions to list. - * * +startTimeFilter+ - (Object) If specified, the workflow - * executions are included in the returned results based on whether - * their start times are within the range specified by this filter. - * Also, if this parameter is specified, the returned results are - * ordered by their start times. + * @!method listClosedWorkflowExecutions(params, callback) + * Calls the ListClosedWorkflowExecutions API operation. + * @param params [Object] + * * +domain+ - (*required*, String) + * * +startTimeFilter+ - (Object) * * +oldestDate+ - (*required*, Date) * * +latestDate+ - (Date) - * * +closeTimeFilter+ - (Object) If specified, the workflow - * executions are included in the returned results based on whether - * their close times are within the range specified by this filter. - * Also, if this parameter is specified, the returned results are - * ordered by their close times. + * * +closeTimeFilter+ - (Object) * * +oldestDate+ - (*required*, Date) * * +latestDate+ - (Date) - * * +executionFilter+ - (Object) If specified, only - * workflow executions matching the workflow id specified in the - * filter are returned. + * * +executionFilter+ - (Object) * * +workflowId+ - (*required*, String) - * * +closeStatusFilter+ - (Object) If specified, only - * workflow executions that match this close status are listed. For - * example, if TERMINATED is specified, then only TERMINATED - * workflow executions are listed. + * * +closeStatusFilter+ - (Object) * * +status+ - (*required*, String) - * * +typeFilter+ - (Object) If specified, only executions - * of the type specified in the filter are returned. + * * +typeFilter+ - (Object) * * +name+ - (*required*, String) * * +version+ - (String) - * * +tagFilter+ - (Object) If specified, only executions - * that have the matching tag are listed. + * * +tagFilter+ - (Object) * * +tag+ - (*required*, String) - * * +nextPageToken+ - (String) If on a previous call to - * this method a NextPageToken was returned, the results are being - * paginated. To get the next page of results, repeat the call with - * the returned token and all other arguments unchanged. - * * +maximumPageSize+ - (Integer) The maximum number of - * results returned in each page. The default is 100, but the - * caller can override this value to a page size smaller than the - * default. You cannot specify a page size greater than 100. - * * +reverseOrder+ - (Boolean) When set to true, returns - * the results in reverse order. By default the results are - * returned in descending order of the start or the close time of - * the executions. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +executionInfos+ - (Array) - * * +execution+ - (Object) - * * +workflowId+ - (String) - * * +runId+ - (String) - * * +workflowType+ - (Object) - * * +name+ - (String) - * * +version+ - (String) - * * +startTimestamp+ - (Date) - * * +closeTimestamp+ - (Date) - * * +executionStatus+ - (String) - * * +closeStatus+ - (String) - * * +parent+ - (Object) - * * +workflowId+ - (String) - * * +runId+ - (String) - * * +tagList+ - (Array) - * * +cancelRequested+ - (Boolean) * * +nextPageToken+ - (String) + * * +maximumPageSize+ - (Integer) + * * +reverseOrder+ - (Boolean) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +executionInfos+ - (Array) + * * +execution+ - (Object) + * * +workflowId+ - (String) + * * +runId+ - (String) + * * +workflowType+ - (Object) + * * +name+ - (String) + * * +version+ - (String) + * * +startTimestamp+ - (Date) + * * +closeTimestamp+ - (Date) + * * +executionStatus+ - (String) + * * +closeStatus+ - (String) + * * +parent+ - (Object) + * * +workflowId+ - (String) + * * +runId+ - (String) + * * +tagList+ - (Array) + * * +cancelRequested+ - (Boolean) + * * +nextPageToken+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method listDomains(params, options) - * Returns the list of domains registered in the account. The results - * may be split into multiple pages. To retrieve subsequent pages, make - * the call again using the nextPageToken returned by the initial call. - * @param [Object] params - * * +nextPageToken+ - (String) If on a previous call to - * this method a NextPageToken was returned, the result has more - * than one page. To get the next page of results, repeat the call - * with the returned token and all other arguments unchanged. - * * +registrationStatus+ - (*required*, String) Specifies - * the registration status of the domains to list. - * * +maximumPageSize+ - (Integer) The maximum number of - * results returned in each page. The default is 100, but the - * caller can override this value to a page size smaller than the - * default. You cannot specify a page size greater than 100. - * * +reverseOrder+ - (Boolean) When set to true, returns - * the results in reverse order. By default the results are - * returned in ascending alphabetical order of the name of the - * domains. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +domainInfos+ - (Array) - * * +name+ - (String) - * * +status+ - (String) - * * +description+ - (String) + * @!method listDomains(params, callback) + * Calls the ListDomains API operation. + * @param params [Object] * * +nextPageToken+ - (String) + * * +registrationStatus+ - (*required*, String) + * * +maximumPageSize+ - (Integer) + * * +reverseOrder+ - (Boolean) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +domainInfos+ - (Array) + * * +name+ - (String) + * * +status+ - (String) + * * +description+ - (String) + * * +nextPageToken+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method listOpenWorkflowExecutions(params, options) - * Returns a list of open workflow executions in the specified domain - * that meet the filtering criteria. The results may be split into - * multiple pages. To retrieve subsequent pages, make the call again - * using the nextPageToken returned by the initial call. - * @param [Object] params - * * +domain+ - (*required*, String) The name of the domain - * that contains the workflow executions to list. - * * +startTimeFilter+ - (*required*, Object) Workflow - * executions are included in the returned results based on whether - * their start times are within the range specified by this filter. + * @!method listOpenWorkflowExecutions(params, callback) + * Calls the ListOpenWorkflowExecutions API operation. + * @param params [Object] + * * +domain+ - (*required*, String) + * * +startTimeFilter+ - (*required*, Object) * * +oldestDate+ - (*required*, Date) * * +latestDate+ - (Date) - * * +typeFilter+ - (Object) If specified, only executions - * of the type specified in the filter are returned. + * * +typeFilter+ - (Object) * * +name+ - (*required*, String) * * +version+ - (String) - * * +tagFilter+ - (Object) If specified, only executions - * that have the matching tag are listed. + * * +tagFilter+ - (Object) * * +tag+ - (*required*, String) - * * +nextPageToken+ - (String) If on a previous call to - * this method a NextPageToken was returned, the results are being - * paginated. To get the next page of results, repeat the call with - * the returned token and all other arguments unchanged. - * * +maximumPageSize+ - (Integer) The maximum number of - * results returned in each page. The default is 100, but the - * caller can override this value to a page size smaller than the - * default. You cannot specify a page size greater than 100. - * * +reverseOrder+ - (Boolean) When set to true, returns - * the results in reverse order. By default the results are - * returned in descending order of the start time of the - * executions. - * * +executionFilter+ - (Object) If specified, only - * workflow executions matching the workflow id specified in the - * filter are returned. - * * +workflowId+ - (*required*, String) - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +executionInfos+ - (Array) - * * +execution+ - (Object) - * * +workflowId+ - (String) - * * +runId+ - (String) - * * +workflowType+ - (Object) - * * +name+ - (String) - * * +version+ - (String) - * * +startTimestamp+ - (Date) - * * +closeTimestamp+ - (Date) - * * +executionStatus+ - (String) - * * +closeStatus+ - (String) - * * +parent+ - (Object) - * * +workflowId+ - (String) - * * +runId+ - (String) - * * +tagList+ - (Array) - * * +cancelRequested+ - (Boolean) * * +nextPageToken+ - (String) - * - * @!method listWorkflowTypes(params, options) - * Returns information about workflow types in the specified domain. - * The results may be split into multiple pages that can be retrieved - * by making the call repeatedly. - * @param [Object] params - * * +domain+ - (*required*, String) The name of the domain - * in which the workflow types have been registered. - * * +name+ - (String) If specified, lists the workflow type - * with this name. - * * +registrationStatus+ - (*required*, String) Specifies - * the registration status of the workflow types to list. - * * +nextPageToken+ - (String) If on a previous call to - * this method a NextPageToken was returned, the results are being - * paginated. To get the next page of results, repeat the call with - * the returned token and all other arguments unchanged. - * * +maximumPageSize+ - (Integer) The maximum number of - * results returned in each page. The default is 100, but the - * caller can override this value to a page size smaller than the - * default. You cannot specify a page size greater than 100. - * * +reverseOrder+ - (Boolean) When set to true, returns - * the results in reverse order. By default the results are - * returned in ascending alphabetical order of the name of the - * workflow types. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +typeInfos+ - (Array) - * * +workflowType+ - (Object) - * * +name+ - (String) - * * +version+ - (String) - * * +status+ - (String) - * * +description+ - (String) - * * +creationDate+ - (Date) - * * +deprecationDate+ - (Date) - * * +nextPageToken+ - (String) - * - * @!method pollForActivityTask(params, options) - * Used by workers to get an ActivityTask from the specified activity - * taskList. This initiates a long poll, where the service holds the - * HTTP connection open and responds as soon as a task becomes - * available. The maximum time the service holds on to the request - * before responding is 60 seconds. If no task is available within 60 - * seconds, the poll will return an empty result. An empty result, in - * this context, means that an ActivityTask is returned, but that the - * value of taskToken is an empty string. If a task is returned, the - * worker should use its type to identify and process it correctly. - * @param [Object] params - * * +domain+ - (*required*, String) The name of the domain - * that contains the task lists being polled. - * * +taskList+ - (*required*, Object) Specifies the task - * list to poll for activity tasks. - * * +name+ - (*required*, String) - * * +identity+ - (String) Identity of the worker making the - * request, which is recorded in the ActivityTaskStarted event in - * the workflow history. This enables diagnostic tracing when - * problems arise. The form of this identity is user defined. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +taskToken+ - (String) - * * +activityId+ - (String) - * * +startedEventId+ - (Integer) - * * +workflowExecution+ - (Object) - * * +workflowId+ - (String) - * * +runId+ - (String) - * * +activityType+ - (Object) - * * +name+ - (String) - * * +version+ - (String) - * * +input+ - (String) - * - * @!method pollForDecisionTask(params, options) - * Used by deciders to get a DecisionTask from the specified decision - * taskList. A decision task may be returned for any open workflow - * execution that is using the specified task list. The task includes a - * paginated view of the history of the workflow execution. The decider - * should use the workflow type and the history to determine how to - * properly handle the task. - * @param [Object] params - * * +domain+ - (*required*, String) The name of the domain - * containing the task lists to poll. - * * +taskList+ - (*required*, Object) Specifies the task - * list to poll for decision tasks. - * * +name+ - (*required*, String) - * * +identity+ - (String) Identity of the decider making - * the request, which is recorded in the DecisionTaskStarted event - * in the workflow history. This enables diagnostic tracing when - * problems arise. The form of this identity is user defined. - * * +nextPageToken+ - (String) If on a previous call to - * this method a NextPageToken was returned, the results are being - * paginated. To get the next page of results, repeat the call with - * the returned token and all other arguments unchanged. - * * +maximumPageSize+ - (Integer) The maximum number of - * history events returned in each page. The default is 100, but - * the caller can override this value to a page size smaller than - * the default. You cannot specify a page size greater than 100. - * * +reverseOrder+ - (Boolean) When set to true, returns - * the events in reverse order. By default the results are returned - * in ascending order of the eventTimestamp of the events. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +taskToken+ - (String) - * * +startedEventId+ - (Integer) - * * +workflowExecution+ - (Object) - * * +workflowId+ - (String) - * * +runId+ - (String) - * * +workflowType+ - (Object) - * * +name+ - (String) - * * +version+ - (String) - * * +events+ - (Array) - * * +eventTimestamp+ - (Date) - * * +eventType+ - (String) - * * +eventId+ - (Integer) - * * +workflowExecutionStartedEventAttributes+ - (Object) - * * +input+ - (String) - * * +executionStartToCloseTimeout+ - (String) - * * +taskStartToCloseTimeout+ - (String) - * * +childPolicy+ - (String) - * * +taskList+ - (Object) - * * +name+ - (String) - * * +workflowType+ - (Object) - * * +name+ - (String) - * * +version+ - (String) - * * +tagList+ - (Array) - * * +continuedExecutionRunId+ - (String) - * * +parentWorkflowExecution+ - (Object) + * * +maximumPageSize+ - (Integer) + * * +reverseOrder+ - (Boolean) + * * +executionFilter+ - (Object) + * * +workflowId+ - (*required*, String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +executionInfos+ - (Array) + * * +execution+ - (Object) * * +workflowId+ - (String) * * +runId+ - (String) - * * +parentInitiatedEventId+ - (Integer) - * * +workflowExecutionCompletedEventAttributes+ - - * (Object) - * * +result+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +completeWorkflowExecutionFailedEventAttributes+ - - * (Object) - * * +cause+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +workflowExecutionFailedEventAttributes+ - (Object) - * * +reason+ - (String) - * * +details+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +failWorkflowExecutionFailedEventAttributes+ - - * (Object) - * * +cause+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +workflowExecutionTimedOutEventAttributes+ - (Object) - * * +timeoutType+ - (String) - * * +childPolicy+ - (String) - * * +workflowExecutionCanceledEventAttributes+ - (Object) - * * +details+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +cancelWorkflowExecutionFailedEventAttributes+ - - * (Object) - * * +cause+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +workflowExecutionContinuedAsNewEventAttributes+ - - * (Object) - * * +input+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +newExecutionRunId+ - (String) - * * +executionStartToCloseTimeout+ - (String) - * * +taskList+ - (Object) - * * +name+ - (String) - * * +taskStartToCloseTimeout+ - (String) - * * +childPolicy+ - (String) - * * +tagList+ - (Array) * * +workflowType+ - (Object) * * +name+ - (String) * * +version+ - (String) - * * +continueAsNewWorkflowExecutionFailedEventAttributes+ - - * (Object) - * * +cause+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +workflowExecutionTerminatedEventAttributes+ - - * (Object) - * * +reason+ - (String) - * * +details+ - (String) - * * +childPolicy+ - (String) - * * +cause+ - (String) - * * +workflowExecutionCancelRequestedEventAttributes+ - - * (Object) - * * +externalWorkflowExecution+ - (Object) - * * +workflowId+ - (String) - * * +runId+ - (String) - * * +externalInitiatedEventId+ - (Integer) - * * +cause+ - (String) - * * +decisionTaskScheduledEventAttributes+ - (Object) - * * +taskList+ - (Object) - * * +name+ - (String) - * * +startToCloseTimeout+ - (String) - * * +decisionTaskStartedEventAttributes+ - (Object) - * * +identity+ - (String) - * * +scheduledEventId+ - (Integer) - * * +decisionTaskCompletedEventAttributes+ - (Object) - * * +executionContext+ - (String) - * * +scheduledEventId+ - (Integer) - * * +startedEventId+ - (Integer) - * * +decisionTaskTimedOutEventAttributes+ - (Object) - * * +timeoutType+ - (String) - * * +scheduledEventId+ - (Integer) - * * +startedEventId+ - (Integer) - * * +activityTaskScheduledEventAttributes+ - (Object) - * * +activityType+ - (Object) - * * +name+ - (String) - * * +version+ - (String) - * * +activityId+ - (String) - * * +input+ - (String) - * * +control+ - (String) - * * +scheduleToStartTimeout+ - (String) - * * +scheduleToCloseTimeout+ - (String) - * * +startToCloseTimeout+ - (String) - * * +taskList+ - (Object) - * * +name+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +heartbeatTimeout+ - (String) - * * +activityTaskStartedEventAttributes+ - (Object) - * * +identity+ - (String) - * * +scheduledEventId+ - (Integer) - * * +activityTaskCompletedEventAttributes+ - (Object) - * * +result+ - (String) - * * +scheduledEventId+ - (Integer) - * * +startedEventId+ - (Integer) - * * +activityTaskFailedEventAttributes+ - (Object) - * * +reason+ - (String) - * * +details+ - (String) - * * +scheduledEventId+ - (Integer) - * * +startedEventId+ - (Integer) - * * +activityTaskTimedOutEventAttributes+ - (Object) - * * +timeoutType+ - (String) - * * +scheduledEventId+ - (Integer) - * * +startedEventId+ - (Integer) - * * +details+ - (String) - * * +activityTaskCanceledEventAttributes+ - (Object) - * * +details+ - (String) - * * +scheduledEventId+ - (Integer) - * * +startedEventId+ - (Integer) - * * +latestCancelRequestedEventId+ - (Integer) - * * +activityTaskCancelRequestedEventAttributes+ - - * (Object) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +activityId+ - (String) - * * +workflowExecutionSignaledEventAttributes+ - (Object) - * * +signalName+ - (String) - * * +input+ - (String) - * * +externalWorkflowExecution+ - (Object) + * * +startTimestamp+ - (Date) + * * +closeTimestamp+ - (Date) + * * +executionStatus+ - (String) + * * +closeStatus+ - (String) + * * +parent+ - (Object) * * +workflowId+ - (String) * * +runId+ - (String) - * * +externalInitiatedEventId+ - (Integer) - * * +markerRecordedEventAttributes+ - (Object) - * * +markerName+ - (String) - * * +details+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +timerStartedEventAttributes+ - (Object) - * * +timerId+ - (String) - * * +control+ - (String) - * * +startToFireTimeout+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +timerFiredEventAttributes+ - (Object) - * * +timerId+ - (String) - * * +startedEventId+ - (Integer) - * * +timerCanceledEventAttributes+ - (Object) - * * +timerId+ - (String) - * * +startedEventId+ - (Integer) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +startChildWorkflowExecutionInitiatedEventAttributes+ - - * (Object) - * * +workflowId+ - (String) - * * +workflowType+ - (Object) - * * +name+ - (String) - * * +version+ - (String) - * * +control+ - (String) - * * +input+ - (String) - * * +executionStartToCloseTimeout+ - (String) - * * +taskList+ - (Object) - * * +name+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +childPolicy+ - (String) - * * +taskStartToCloseTimeout+ - (String) * * +tagList+ - (Array) - * * +childWorkflowExecutionStartedEventAttributes+ - - * (Object) - * * +workflowExecution+ - (Object) - * * +workflowId+ - (String) - * * +runId+ - (String) + * * +cancelRequested+ - (Boolean) + * * +nextPageToken+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method listWorkflowTypes(params, callback) + * Calls the ListWorkflowTypes API operation. + * @param params [Object] + * * +domain+ - (*required*, String) + * * +name+ - (String) + * * +registrationStatus+ - (*required*, String) + * * +nextPageToken+ - (String) + * * +maximumPageSize+ - (Integer) + * * +reverseOrder+ - (Boolean) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +typeInfos+ - (Array) * * +workflowType+ - (Object) * * +name+ - (String) * * +version+ - (String) - * * +initiatedEventId+ - (Integer) - * * +childWorkflowExecutionCompletedEventAttributes+ - - * (Object) - * * +workflowExecution+ - (Object) + * * +status+ - (String) + * * +description+ - (String) + * * +creationDate+ - (Date) + * * +deprecationDate+ - (Date) + * * +nextPageToken+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method pollForActivityTask(params, callback) + * Calls the PollForActivityTask API operation. + * @param params [Object] + * * +domain+ - (*required*, String) + * * +taskList+ - (*required*, Object) + * * +name+ - (*required*, String) + * * +identity+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +taskToken+ - (String) + * * +activityId+ - (String) + * * +startedEventId+ - (Integer) + * * +workflowExecution+ - (Object) + * * +workflowId+ - (String) + * * +runId+ - (String) + * * +activityType+ - (Object) + * * +name+ - (String) + * * +version+ - (String) + * * +input+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. + * + * @!method pollForDecisionTask(params, callback) + * Calls the PollForDecisionTask API operation. + * @param params [Object] + * * +domain+ - (*required*, String) + * * +taskList+ - (*required*, Object) + * * +name+ - (*required*, String) + * * +identity+ - (String) + * * +nextPageToken+ - (String) + * * +maximumPageSize+ - (Integer) + * * +reverseOrder+ - (Boolean) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +taskToken+ - (String) + * * +startedEventId+ - (Integer) + * * +workflowExecution+ - (Object) + * * +workflowId+ - (String) + * * +runId+ - (String) + * * +workflowType+ - (Object) + * * +name+ - (String) + * * +version+ - (String) + * * +events+ - (Array) + * * +eventTimestamp+ - (Date) + * * +eventType+ - (String) + * * +eventId+ - (Integer) + * * +workflowExecutionStartedEventAttributes+ - (Object) + * * +input+ - (String) + * * +executionStartToCloseTimeout+ - (String) + * * +taskStartToCloseTimeout+ - (String) + * * +childPolicy+ - (String) + * * +taskList+ - (Object) + * * +name+ - (String) + * * +workflowType+ - (Object) + * * +name+ - (String) + * * +version+ - (String) + * * +tagList+ - (Array) + * * +continuedExecutionRunId+ - (String) + * * +parentWorkflowExecution+ - (Object) + * * +workflowId+ - (String) + * * +runId+ - (String) + * * +parentInitiatedEventId+ - (Integer) + * * +workflowExecutionCompletedEventAttributes+ - + * (Object) + * * +result+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +completeWorkflowExecutionFailedEventAttributes+ - + * (Object) + * * +cause+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +workflowExecutionFailedEventAttributes+ - (Object) + * * +reason+ - (String) + * * +details+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +failWorkflowExecutionFailedEventAttributes+ - + * (Object) + * * +cause+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +workflowExecutionTimedOutEventAttributes+ - (Object) + * * +timeoutType+ - (String) + * * +childPolicy+ - (String) + * * +workflowExecutionCanceledEventAttributes+ - (Object) + * * +details+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +cancelWorkflowExecutionFailedEventAttributes+ - + * (Object) + * * +cause+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +workflowExecutionContinuedAsNewEventAttributes+ - + * (Object) + * * +input+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +newExecutionRunId+ - (String) + * * +executionStartToCloseTimeout+ - (String) + * * +taskList+ - (Object) + * * +name+ - (String) + * * +taskStartToCloseTimeout+ - (String) + * * +childPolicy+ - (String) + * * +tagList+ - (Array) + * * +workflowType+ - (Object) + * * +name+ - (String) + * * +version+ - (String) + * * +continueAsNewWorkflowExecutionFailedEventAttributes+ - + * (Object) + * * +cause+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +workflowExecutionTerminatedEventAttributes+ - + * (Object) + * * +reason+ - (String) + * * +details+ - (String) + * * +childPolicy+ - (String) + * * +cause+ - (String) + * * +workflowExecutionCancelRequestedEventAttributes+ - + * (Object) + * * +externalWorkflowExecution+ - (Object) + * * +workflowId+ - (String) + * * +runId+ - (String) + * * +externalInitiatedEventId+ - (Integer) + * * +cause+ - (String) + * * +decisionTaskScheduledEventAttributes+ - (Object) + * * +taskList+ - (Object) + * * +name+ - (String) + * * +startToCloseTimeout+ - (String) + * * +decisionTaskStartedEventAttributes+ - (Object) + * * +identity+ - (String) + * * +scheduledEventId+ - (Integer) + * * +decisionTaskCompletedEventAttributes+ - (Object) + * * +executionContext+ - (String) + * * +scheduledEventId+ - (Integer) + * * +startedEventId+ - (Integer) + * * +decisionTaskTimedOutEventAttributes+ - (Object) + * * +timeoutType+ - (String) + * * +scheduledEventId+ - (Integer) + * * +startedEventId+ - (Integer) + * * +activityTaskScheduledEventAttributes+ - (Object) + * * +activityType+ - (Object) + * * +name+ - (String) + * * +version+ - (String) + * * +activityId+ - (String) + * * +input+ - (String) + * * +control+ - (String) + * * +scheduleToStartTimeout+ - (String) + * * +scheduleToCloseTimeout+ - (String) + * * +startToCloseTimeout+ - (String) + * * +taskList+ - (Object) + * * +name+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +heartbeatTimeout+ - (String) + * * +activityTaskStartedEventAttributes+ - (Object) + * * +identity+ - (String) + * * +scheduledEventId+ - (Integer) + * * +activityTaskCompletedEventAttributes+ - (Object) + * * +result+ - (String) + * * +scheduledEventId+ - (Integer) + * * +startedEventId+ - (Integer) + * * +activityTaskFailedEventAttributes+ - (Object) + * * +reason+ - (String) + * * +details+ - (String) + * * +scheduledEventId+ - (Integer) + * * +startedEventId+ - (Integer) + * * +activityTaskTimedOutEventAttributes+ - (Object) + * * +timeoutType+ - (String) + * * +scheduledEventId+ - (Integer) + * * +startedEventId+ - (Integer) + * * +details+ - (String) + * * +activityTaskCanceledEventAttributes+ - (Object) + * * +details+ - (String) + * * +scheduledEventId+ - (Integer) + * * +startedEventId+ - (Integer) + * * +latestCancelRequestedEventId+ - (Integer) + * * +activityTaskCancelRequestedEventAttributes+ - + * (Object) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +activityId+ - (String) + * * +workflowExecutionSignaledEventAttributes+ - (Object) + * * +signalName+ - (String) + * * +input+ - (String) + * * +externalWorkflowExecution+ - (Object) + * * +workflowId+ - (String) + * * +runId+ - (String) + * * +externalInitiatedEventId+ - (Integer) + * * +markerRecordedEventAttributes+ - (Object) + * * +markerName+ - (String) + * * +details+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +timerStartedEventAttributes+ - (Object) + * * +timerId+ - (String) + * * +control+ - (String) + * * +startToFireTimeout+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +timerFiredEventAttributes+ - (Object) + * * +timerId+ - (String) + * * +startedEventId+ - (Integer) + * * +timerCanceledEventAttributes+ - (Object) + * * +timerId+ - (String) + * * +startedEventId+ - (Integer) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +startChildWorkflowExecutionInitiatedEventAttributes+ - + * (Object) * * +workflowId+ - (String) - * * +runId+ - (String) - * * +workflowType+ - (Object) - * * +name+ - (String) - * * +version+ - (String) - * * +result+ - (String) - * * +initiatedEventId+ - (Integer) - * * +startedEventId+ - (Integer) - * * +childWorkflowExecutionFailedEventAttributes+ - - * (Object) - * * +workflowExecution+ - (Object) + * * +workflowType+ - (Object) + * * +name+ - (String) + * * +version+ - (String) + * * +control+ - (String) + * * +input+ - (String) + * * +executionStartToCloseTimeout+ - (String) + * * +taskList+ - (Object) + * * +name+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +childPolicy+ - (String) + * * +taskStartToCloseTimeout+ - (String) + * * +tagList+ - (Array) + * * +childWorkflowExecutionStartedEventAttributes+ - + * (Object) + * * +workflowExecution+ - (Object) + * * +workflowId+ - (String) + * * +runId+ - (String) + * * +workflowType+ - (Object) + * * +name+ - (String) + * * +version+ - (String) + * * +initiatedEventId+ - (Integer) + * * +childWorkflowExecutionCompletedEventAttributes+ - + * (Object) + * * +workflowExecution+ - (Object) + * * +workflowId+ - (String) + * * +runId+ - (String) + * * +workflowType+ - (Object) + * * +name+ - (String) + * * +version+ - (String) + * * +result+ - (String) + * * +initiatedEventId+ - (Integer) + * * +startedEventId+ - (Integer) + * * +childWorkflowExecutionFailedEventAttributes+ - + * (Object) + * * +workflowExecution+ - (Object) + * * +workflowId+ - (String) + * * +runId+ - (String) + * * +workflowType+ - (Object) + * * +name+ - (String) + * * +version+ - (String) + * * +reason+ - (String) + * * +details+ - (String) + * * +initiatedEventId+ - (Integer) + * * +startedEventId+ - (Integer) + * * +childWorkflowExecutionTimedOutEventAttributes+ - + * (Object) + * * +workflowExecution+ - (Object) + * * +workflowId+ - (String) + * * +runId+ - (String) + * * +workflowType+ - (Object) + * * +name+ - (String) + * * +version+ - (String) + * * +timeoutType+ - (String) + * * +initiatedEventId+ - (Integer) + * * +startedEventId+ - (Integer) + * * +childWorkflowExecutionCanceledEventAttributes+ - + * (Object) + * * +workflowExecution+ - (Object) + * * +workflowId+ - (String) + * * +runId+ - (String) + * * +workflowType+ - (Object) + * * +name+ - (String) + * * +version+ - (String) + * * +details+ - (String) + * * +initiatedEventId+ - (Integer) + * * +startedEventId+ - (Integer) + * * +childWorkflowExecutionTerminatedEventAttributes+ - + * (Object) + * * +workflowExecution+ - (Object) + * * +workflowId+ - (String) + * * +runId+ - (String) + * * +workflowType+ - (Object) + * * +name+ - (String) + * * +version+ - (String) + * * +initiatedEventId+ - (Integer) + * * +startedEventId+ - (Integer) + * * +signalExternalWorkflowExecutionInitiatedEventAttributes+ - + * (Object) * * +workflowId+ - (String) * * +runId+ - (String) - * * +workflowType+ - (Object) - * * +name+ - (String) - * * +version+ - (String) - * * +reason+ - (String) - * * +details+ - (String) - * * +initiatedEventId+ - (Integer) - * * +startedEventId+ - (Integer) - * * +childWorkflowExecutionTimedOutEventAttributes+ - - * (Object) - * * +workflowExecution+ - (Object) + * * +signalName+ - (String) + * * +input+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +control+ - (String) + * * +externalWorkflowExecutionSignaledEventAttributes+ - + * (Object) + * * +workflowExecution+ - (Object) + * * +workflowId+ - (String) + * * +runId+ - (String) + * * +initiatedEventId+ - (Integer) + * * +signalExternalWorkflowExecutionFailedEventAttributes+ - + * (Object) * * +workflowId+ - (String) * * +runId+ - (String) - * * +workflowType+ - (Object) - * * +name+ - (String) - * * +version+ - (String) - * * +timeoutType+ - (String) - * * +initiatedEventId+ - (Integer) - * * +startedEventId+ - (Integer) - * * +childWorkflowExecutionCanceledEventAttributes+ - - * (Object) - * * +workflowExecution+ - (Object) + * * +cause+ - (String) + * * +initiatedEventId+ - (Integer) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +control+ - (String) + * * +externalWorkflowExecutionCancelRequestedEventAttributes+ - + * (Object) + * * +workflowExecution+ - (Object) + * * +workflowId+ - (String) + * * +runId+ - (String) + * * +initiatedEventId+ - (Integer) + * * + * +requestCancelExternalWorkflowExecutionInitiatedEventAttributes+ + * - (Object) * * +workflowId+ - (String) * * +runId+ - (String) - * * +workflowType+ - (Object) - * * +name+ - (String) - * * +version+ - (String) - * * +details+ - (String) - * * +initiatedEventId+ - (Integer) - * * +startedEventId+ - (Integer) - * * +childWorkflowExecutionTerminatedEventAttributes+ - - * (Object) - * * +workflowExecution+ - (Object) - * * +workflowId+ - (String) - * * +runId+ - (String) - * * +workflowType+ - (Object) - * * +name+ - (String) - * * +version+ - (String) - * * +initiatedEventId+ - (Integer) - * * +startedEventId+ - (Integer) - * * +signalExternalWorkflowExecutionInitiatedEventAttributes+ - - * (Object) - * * +workflowId+ - (String) - * * +runId+ - (String) - * * +signalName+ - (String) - * * +input+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +control+ - (String) - * * +externalWorkflowExecutionSignaledEventAttributes+ - - * (Object) - * * +workflowExecution+ - (Object) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +control+ - (String) + * * +requestCancelExternalWorkflowExecutionFailedEventAttributes+ + * - (Object) * * +workflowId+ - (String) * * +runId+ - (String) - * * +initiatedEventId+ - (Integer) - * * +signalExternalWorkflowExecutionFailedEventAttributes+ - - * (Object) - * * +workflowId+ - (String) - * * +runId+ - (String) - * * +cause+ - (String) - * * +initiatedEventId+ - (Integer) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +control+ - (String) - * * +externalWorkflowExecutionCancelRequestedEventAttributes+ - - * (Object) - * * +workflowExecution+ - (Object) + * * +cause+ - (String) + * * +initiatedEventId+ - (Integer) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +control+ - (String) + * * +scheduleActivityTaskFailedEventAttributes+ - + * (Object) + * * +activityType+ - (Object) + * * +name+ - (String) + * * +version+ - (String) + * * +activityId+ - (String) + * * +cause+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +requestCancelActivityTaskFailedEventAttributes+ - + * (Object) + * * +activityId+ - (String) + * * +cause+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +startTimerFailedEventAttributes+ - (Object) + * * +timerId+ - (String) + * * +cause+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +cancelTimerFailedEventAttributes+ - (Object) + * * +timerId+ - (String) + * * +cause+ - (String) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +startChildWorkflowExecutionFailedEventAttributes+ - + * (Object) + * * +workflowType+ - (Object) + * * +name+ - (String) + * * +version+ - (String) + * * +cause+ - (String) * * +workflowId+ - (String) - * * +runId+ - (String) - * * +initiatedEventId+ - (Integer) - * * - * +requestCancelExternalWorkflowExecutionInitiatedEventAttributes+ - * - (Object) - * * +workflowId+ - (String) - * * +runId+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +control+ - (String) - * * +requestCancelExternalWorkflowExecutionFailedEventAttributes+ - * - (Object) - * * +workflowId+ - (String) - * * +runId+ - (String) - * * +cause+ - (String) - * * +initiatedEventId+ - (Integer) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +control+ - (String) - * * +scheduleActivityTaskFailedEventAttributes+ - - * (Object) - * * +activityType+ - (Object) - * * +name+ - (String) - * * +version+ - (String) - * * +activityId+ - (String) - * * +cause+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +requestCancelActivityTaskFailedEventAttributes+ - - * (Object) - * * +activityId+ - (String) - * * +cause+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +startTimerFailedEventAttributes+ - (Object) - * * +timerId+ - (String) - * * +cause+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +cancelTimerFailedEventAttributes+ - (Object) - * * +timerId+ - (String) - * * +cause+ - (String) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +startChildWorkflowExecutionFailedEventAttributes+ - - * (Object) - * * +workflowType+ - (Object) - * * +name+ - (String) - * * +version+ - (String) - * * +cause+ - (String) - * * +workflowId+ - (String) - * * +initiatedEventId+ - (Integer) - * * +decisionTaskCompletedEventId+ - (*required*, - * Integer) - * * +control+ - (String) - * * +nextPageToken+ - (String) - * * +previousStartedEventId+ - (Integer) + * * +initiatedEventId+ - (Integer) + * * +decisionTaskCompletedEventId+ - (*required*, + * Integer) + * * +control+ - (String) + * * +nextPageToken+ - (String) + * * +previousStartedEventId+ - (Integer) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method recordActivityTaskHeartbeat(params, options) - * Used by activity workers to report to the service that the - * ActivityTask represented by the specified taskToken is still making - * progress. The worker can also (optionally) specify details of the - * progress, for example percent complete, using the details parameter. - * This action can also be used by the worker as a mechanism to check - * if cancellation is being requested for the activity task. If a - * cancellation is being attempted for the specified task, then the - * boolean cancelRequested flag returned by the service is set to true. - * @param [Object] params - * * +taskToken+ - (*required*, String) The taskToken of the - * ActivityTask. - * * +details+ - (String) If specified, contains details - * about the progress of the task. - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +cancelRequested+ - (Boolean) + * @!method recordActivityTaskHeartbeat(params, callback) + * Calls the RecordActivityTaskHeartbeat API operation. + * @param params [Object] + * * +taskToken+ - (*required*, String) + * * +details+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +cancelRequested+ - (Boolean) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method registerActivityType(params, options) - * Registers a new activity type along with its configuration settings - * in the specified domain. - * @param [Object] params - * * +domain+ - (*required*, String) The name of the domain - * in which this activity is to be registered. - * * +name+ - (*required*, String) The name of the activity - * type within the domain. - * * +version+ - (*required*, String) The version of the - * activity type. - * * +description+ - (String) A textual description of the - * activity type. - * * +defaultTaskStartToCloseTimeout+ - (String) If set, - * specifies the default maximum duration that a worker can take to - * process tasks of this activity type. This default can be - * overridden when scheduling an activity task using the - * ScheduleActivityTask Decision. - * * +defaultTaskHeartbeatTimeout+ - (String) If set, - * specifies the default maximum time before which a worker - * processing a task of this type must report progress by calling - * RecordActivityTaskHeartbeat. If the timeout is exceeded, the - * activity task is automatically timed out. This default can be - * overridden when scheduling an activity task using the - * ScheduleActivityTask Decision. If the activity worker - * subsequently attempts to record a heartbeat or returns a result, - * the activity worker receives an UnknownResource fault. In this - * case, Amazon SWF no longer considers the activity task to be - * valid; the activity worker should clean up the activity task. - * * +defaultTaskList+ - (Object) If set, specifies the - * default task list to use for scheduling tasks of this activity - * type. This default task list is used if a task list is not - * provided when a task is scheduled through the - * ScheduleActivityTask Decision. + * @!method registerActivityType(params, callback) + * Calls the RegisterActivityType API operation. + * @param params [Object] + * * +domain+ - (*required*, String) + * * +name+ - (*required*, String) + * * +version+ - (*required*, String) + * * +description+ - (String) + * * +defaultTaskStartToCloseTimeout+ - (String) + * * +defaultTaskHeartbeatTimeout+ - (String) + * * +defaultTaskList+ - (Object) * * +name+ - (*required*, String) - * * +defaultTaskScheduleToStartTimeout+ - (String) If set, - * specifies the default maximum duration that a task of this - * activity type can wait before being assigned to a worker. This - * default can be overridden when scheduling an activity task using - * the ScheduleActivityTask Decision. - * * +defaultTaskScheduleToCloseTimeout+ - (String) If set, - * specifies the default maximum duration for a task of this - * activity type. This default can be overridden when scheduling an - * activity task using the ScheduleActivityTask Decision. - * @param [Object] options - * @return [AWS.AWSRequest] + * * +defaultTaskScheduleToStartTimeout+ - (String) + * * +defaultTaskScheduleToCloseTimeout+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method registerDomain(params, options) - * Registers a new domain. - * @param [Object] params - * * +name+ - (*required*, String) Name of the domain to - * register. The name must be unique. - * * +description+ - (String) Textual description of the - * domain. + * @!method registerDomain(params, callback) + * Calls the RegisterDomain API operation. + * @param params [Object] + * * +name+ - (*required*, String) + * * +description+ - (String) * * +workflowExecutionRetentionPeriodInDays+ - (*required*, - * String) Specifies the duration--in days--for which the - * record (including the history) of workflow executions in this - * domain should be kept by the service. After the retention - * period, the workflow execution will not be available in the - * results of visibility calls. If a duration of NONE is specified, - * the records for workflow executions in this domain are not - * retained at all. - * @param [Object] options - * @return [AWS.AWSRequest] + * String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method registerWorkflowType(params, options) - * Registers a new workflow type and its configuration settings in the - * specified domain. - * @param [Object] params - * * +domain+ - (*required*, String) The name of the domain - * in which to register the workflow type. - * * +name+ - (*required*, String) The name of the workflow - * type. - * * +version+ - (*required*, String) The version of the - * workflow type. - * * +description+ - (String) Textual description of the - * workflow type. - * * +defaultTaskStartToCloseTimeout+ - (String) If set, - * specifies the default maximum duration of decision tasks for - * this workflow type. This default can be overridden when starting - * a workflow execution using the StartWorkflowExecution action or - * the StartChildWorkflowExecution Decision. - * * +defaultExecutionStartToCloseTimeout+ - (String) If - * set, specifies the default maximum duration for executions of - * this workflow type. You can override this default when starting - * an execution through the StartWorkflowExecution Action or - * StartChildWorkflowExecution Decision. - * * +defaultTaskList+ - (Object) If set, specifies the - * default task list to use for scheduling decision tasks for - * executions of this workflow type. This default is used only if a - * task list is not provided when starting the execution through - * the StartWorkflowExecution Action or StartChildWorkflowExecution - * Decision. + * @!method registerWorkflowType(params, callback) + * Calls the RegisterWorkflowType API operation. + * @param params [Object] + * * +domain+ - (*required*, String) + * * +name+ - (*required*, String) + * * +version+ - (*required*, String) + * * +description+ - (String) + * * +defaultTaskStartToCloseTimeout+ - (String) + * * +defaultExecutionStartToCloseTimeout+ - (String) + * * +defaultTaskList+ - (Object) * * +name+ - (*required*, String) - * * +defaultChildPolicy+ - (String) If set, specifies the - * default policy to use for the child workflow executions when a - * workflow execution of this type is terminated, by calling the - * TerminateWorkflowExecution action explicitly or due to an - * expired timeout. This default can be overridden when starting a - * workflow execution using the StartWorkflowExecution action or - * the StartChildWorkflowExecution Decision. The supported child - * policies are: - * @param [Object] options - * @return [AWS.AWSRequest] + * * +defaultChildPolicy+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method requestCancelWorkflowExecution(params, options) - * Records a WorkflowExecutionCancelRequested event in the currently - * running workflow execution identified by the given domain, - * workflowId, and runId. This logically requests the cancellation of - * the workflow execution as a whole. It is up to the decider to take - * appropriate actions when it receives an execution history with this - * event. - * @param [Object] params - * * +domain+ - (*required*, String) The name of the domain - * containing the workflow execution to cancel. - * * +workflowId+ - (*required*, String) The workflowId of - * the workflow execution to cancel. - * * +runId+ - (String) The runId of the workflow execution - * to cancel. - * @param [Object] options - * @return [AWS.AWSRequest] + * @!method requestCancelWorkflowExecution(params, callback) + * Calls the RequestCancelWorkflowExecution API operation. + * @param params [Object] + * * +domain+ - (*required*, String) + * * +workflowId+ - (*required*, String) + * * +runId+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method respondActivityTaskCanceled(params, options) - * Used by workers to tell the service that the ActivityTask identified - * by the taskToken was successfully canceled. Additional details can - * be optionally provided using the details argument. - * @param [Object] params - * * +taskToken+ - (*required*, String) The taskToken of the - * ActivityTask. - * * +details+ - (String) Optional information about the - * cancellation. - * @param [Object] options - * @return [AWS.AWSRequest] + * @!method respondActivityTaskCanceled(params, callback) + * Calls the RespondActivityTaskCanceled API operation. + * @param params [Object] + * * +taskToken+ - (*required*, String) + * * +details+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method respondActivityTaskCompleted(params, options) - * Used by workers to tell the service that the ActivityTask identified - * by the taskToken completed successfully with a result (if provided). - * @param [Object] params - * * +taskToken+ - (*required*, String) The taskToken of the - * ActivityTask. - * * +result+ - (String) The result of the activity task. It - * is a free form string that is implementation specific. - * @param [Object] options - * @return [AWS.AWSRequest] + * @!method respondActivityTaskCompleted(params, callback) + * Calls the RespondActivityTaskCompleted API operation. + * @param params [Object] + * * +taskToken+ - (*required*, String) + * * +result+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method respondActivityTaskFailed(params, options) - * Used by workers to tell the service that the ActivityTask identified - * by the taskToken has failed with reason (if specified). - * @param [Object] params - * * +taskToken+ - (*required*, String) The taskToken of the - * ActivityTask. - * * +reason+ - (String) Description of the error that may - * assist in diagnostics. - * * +details+ - (String) Optional detailed information - * about the failure. - * @param [Object] options - * @return [AWS.AWSRequest] + * @!method respondActivityTaskFailed(params, callback) + * Calls the RespondActivityTaskFailed API operation. + * @param params [Object] + * * +taskToken+ - (*required*, String) + * * +reason+ - (String) + * * +details+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method respondDecisionTaskCompleted(params, options) - * Used by deciders to tell the service that the DecisionTask - * identified by the taskToken has successfully completed. The - * decisions argument specifies the list of decisions made while - * processing the task. - * @param [Object] params - * * +taskToken+ - (*required*, String) The taskToken from - * the DecisionTask. - * * +decisions+ - (Array) The list of decisions - * (possibly empty) made by the decider while processing this - * decision task. See the docs for the Decision structure for - * details. + * @!method respondDecisionTaskCompleted(params, callback) + * Calls the RespondDecisionTaskCompleted API operation. + * @param params [Object] + * * +taskToken+ - (*required*, String) + * * +decisions+ - (Array) * * +decisionType+ - (*required*, String) * * +scheduleActivityTaskDecisionAttributes+ - (Object) * * +activityType+ - (*required*, Object) @@ -1584,113 +1492,84 @@ AWS.SimpleWorkflow = inherit({}) * * +taskStartToCloseTimeout+ - (String) * * +childPolicy+ - (String) * * +tagList+ - (Array) - * * +executionContext+ - (String) User defined context to - * add to workflow execution. - * @param [Object] options - * @return [AWS.AWSRequest] + * * +executionContext+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method signalWorkflowExecution(params, options) - * Records a WorkflowExecutionSignaled event in the workflow execution - * history and creates a decision task for the workflow execution - * identified by the given domain, workflowId and runId. The event is - * recorded with the specified user defined signalName and input (if - * provided). - * @param [Object] params - * * +domain+ - (*required*, String) The name of the domain - * containing the workflow execution to signal. - * * +workflowId+ - (*required*, String) The workflowId of - * the workflow execution to signal. - * * +runId+ - (String) The runId of the workflow execution - * to signal. - * * +signalName+ - (*required*, String) The name of the - * signal. This name must be meaningful to the target workflow. - * * +input+ - (String) Data to attach to the - * WorkflowExecutionSignaled event in the target workflow - * execution's history. - * @param [Object] options - * @return [AWS.AWSRequest] + * @!method signalWorkflowExecution(params, callback) + * Calls the SignalWorkflowExecution API operation. + * @param params [Object] + * * +domain+ - (*required*, String) + * * +workflowId+ - (*required*, String) + * * +runId+ - (String) + * * +signalName+ - (*required*, String) + * * +input+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method startWorkflowExecution(params, options) - * Starts an execution of the workflow type in the specified domain - * using the provided workflowId and input data. - * @param [Object] params - * * +domain+ - (*required*, String) The name of the domain - * in which the workflow execution is created. - * * +workflowId+ - (*required*, String) The user defined - * identifier associated with the workflow execution. You can use - * this to associate a custom identifier with the workflow - * execution. You may specify the same identifier if a workflow - * execution is logically a restart of a previous execution. You - * cannot have two open workflow executions with the same - * workflowId at the same time. - * * +workflowType+ - (*required*, Object) The type of the - * workflow to start. + * @!method startWorkflowExecution(params, callback) + * Calls the StartWorkflowExecution API operation. + * @param params [Object] + * * +domain+ - (*required*, String) + * * +workflowId+ - (*required*, String) + * * +workflowType+ - (*required*, Object) * * +name+ - (*required*, String) * * +version+ - (*required*, String) - * * +taskList+ - (Object) The task list to use for the - * decision tasks generated for this workflow execution. This - * overrides the defaultTaskList specified when registering the - * workflow type. + * * +taskList+ - (Object) * * +name+ - (*required*, String) - * * +input+ - (String) The input for the workflow - * execution. This is a free form string which should be meaningful - * to the workflow you are starting. This input is made available - * to the new workflow execution in the WorkflowExecutionStarted - * history event. - * * +executionStartToCloseTimeout+ - (String) The total - * duration for this workflow execution. This overrides the - * defaultExecutionStartToCloseTimeout specified when registering - * the workflow type. - * * +tagList+ - (Array) The list of tags to - * associate with the workflow execution. You can specify a maximum - * of 5 tags. You can list workflow executions with a specific tag - * by calling ListOpenWorkflowExecutions or - * ListClosedWorkflowExecutions and specifying a TagFilter. - * * +taskStartToCloseTimeout+ - (String) Specifies the - * maximum duration of decision tasks for this workflow execution. - * This parameter overrides the defaultTaskStartToCloseTimout - * specified when registering the workflow type using - * RegisterWorkflowType. - * * +childPolicy+ - (String) If set, specifies the policy - * to use for the child workflow executions of this workflow - * execution if it is terminated, by calling the - * TerminateWorkflowExecution action explicitly or due to an - * expired timeout. This policy overrides the default child policy - * specified when registering the workflow type using - * RegisterWorkflowType. The supported child policies are: - * @param [Object] options - * @return [AWS.AWSRequest] The +data+ property of the AWS.AWSResponse - * object that is passed to the registered callbacks has the - * following properties: - * * +runId+ - (String) The runId of a workflow execution. - * This Id is generated by the service and can be used to uniquely - * identify the workflow execution within a domain. + * * +input+ - (String) + * * +executionStartToCloseTimeout+ - (String) + * * +tagList+ - (Array) + * * +taskStartToCloseTimeout+ - (String) + * * +childPolicy+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * The +data+ object has the following properties: + * * +runId+ - (String) + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * - * @!method terminateWorkflowExecution(params, options) - * Records a WorkflowExecutionTerminated event and forces closure of - * the workflow execution identified by the given domain, runId, and - * workflowId. The child policy, registered with the workflow type or - * specified when starting this execution, is applied to any open child - * workflow executions of this workflow execution. - * @param [Object] params - * * +domain+ - (*required*, String) The domain of the - * workflow execution to terminate. - * * +workflowId+ - (*required*, String) The workflowId of - * the workflow execution to terminate. - * * +runId+ - (String) The runId of the workflow execution - * to terminate. - * * +reason+ - (String) An optional descriptive reason for - * terminating the workflow execution. - * * +details+ - (String) Optional details for terminating - * the workflow execution. - * * +childPolicy+ - (String) If set, specifies the policy - * to use for the child workflow executions of the workflow - * execution being terminated. This policy overrides the child - * policy specified for the workflow execution at registration time - * or when starting the execution. The supported child policies - * are: - * @param [Object] options - * @return [AWS.AWSRequest] + * @!method terminateWorkflowExecution(params, callback) + * Calls the TerminateWorkflowExecution API operation. + * @param params [Object] + * * +domain+ - (*required*, String) + * * +workflowId+ - (*required*, String) + * * +runId+ - (String) + * * +reason+ - (String) + * * +details+ - (String) + * * +childPolicy+ - (String) + * @callback callback function(err, data) + * Called when a response from the service is returned. If a + * callback is not supplied, you must call {AWS.AWSRequest.send} + * on the returned request object to initiate the request. + * @param err [Object] the error object returned from the request. + * Set to +null+ if the request is successful. + * @param data [Object] the de-serialized data returned from + * the request. Set to +null+ if a request error occurs. + * @return [AWS.AWSRequest] a handle to the operation request for + * subsequent event callback registration. * * * @!method constructor(options)