Permalink
Browse files

Updated service and client docs with examples.

  • Loading branch information...
1 parent 8d32fd9 commit 900fe07019f680a05fc35bcb4d5b736503a8d075 @trevorrowe trevorrowe committed Dec 4, 2012
Showing with 116 additions and 4 deletions.
  1. +29 −1 doc-src/dynamodb.docs.js
  2. +29 −1 doc-src/ec2.docs.js
  3. +29 −1 doc-src/s3.docs.js
  4. +29 −1 doc-src/simpleworkflow.docs.js
View
@@ -17,6 +17,32 @@
AWS = {};
/**
+ * Constructs a service interface and a low-level {Client}. Use the +client+
+ * property to make API calls. Each API operation is exposed as a function on
+ * the +client+.
+ *
+ * === Sending a Request Using DynamoDB
+ *
+ * svc = new AWS.DynamoDB();
+ * svc.client.OPERATION_NAME(params).always(function (resp) {
+ * console.log(resp.data, resp.error);
+ * });
+ *
+ * @!method constructor(options)
+ * Constructs a service interface. The returned service will have a {client}
+ * property that provides access to the API operations.
+ * @option (see AWS.DynamoDB.Client.constructor)
+ *
+ * @!attribute client
+ * @return [AWS.DynamoDB.Client] A client that provides one method for each
+ * API operation.
+ *
+ * @see AWS.DynamoDB.Client
+ *
+ */
+AWS.DynamoDB = inherit({})
+
+/**
* @!method batchGetItem(params, options)
* Retrieves the attributes for multiple items from multiple tables
* using their primary keys.
@@ -1092,7 +1118,9 @@ AWS = {};
*
*
* @!method constructor(options)
- * @option options [String] endpoint The HTTP(s) endpoint to send requests
+ * Constructs a service client object. This client has one method for
+ * each API operation.
+ * @option options [String] endpoint The endpoint URI to send requests
* to. The default endpoint is built from the configured +region+.
* The endpoint should be a string like <tt>'https://s3.amazonaws.com'</tt>.
* @option (see AWS.Config.constructor)
View
@@ -17,6 +17,32 @@
AWS = {};
/**
+ * Constructs a service interface and a low-level {Client}. Use the +client+
+ * property to make API calls. Each API operation is exposed as a function on
+ * the +client+.
+ *
+ * === Sending a Request Using EC2
+ *
+ * svc = new AWS.EC2();
+ * svc.client.OPERATION_NAME(params).always(function (resp) {
+ * console.log(resp.data, resp.error);
+ * });
+ *
+ * @!method constructor(options)
+ * Constructs a service interface. The returned service will have a {client}
+ * property that provides access to the API operations.
+ * @option (see AWS.EC2.Client.constructor)
+ *
+ * @!attribute client
+ * @return [AWS.EC2.Client] A client that provides one method for each
+ * API operation.
+ *
+ * @see AWS.EC2.Client
+ *
+ */
+AWS.EC2 = inherit({})
+
+/**
* @!method activateLicense(params, options)
* Activates a specific number of licenses for a 90-day period.
* Activations can be done against a specific license ID.
@@ -4546,7 +4572,9 @@ AWS = {};
*
*
* @!method constructor(options)
- * @option options [String] endpoint The HTTP(s) endpoint to send requests
+ * Constructs a service client object. This client has one method for
+ * each API operation.
+ * @option options [String] endpoint The endpoint URI to send requests
* to. The default endpoint is built from the configured +region+.
* The endpoint should be a string like <tt>'https://s3.amazonaws.com'</tt>.
* @option (see AWS.Config.constructor)
View
@@ -17,6 +17,32 @@
AWS = {};
/**
+ * Constructs a service interface and a low-level {Client}. Use the +client+
+ * property to make API calls. Each API operation is exposed as a function on
+ * the +client+.
+ *
+ * === Sending a Request Using S3
+ *
+ * svc = new AWS.S3();
+ * svc.client.OPERATION_NAME(params).always(function (resp) {
+ * console.log(resp.data, resp.error);
+ * });
+ *
+ * @!method constructor(options)
+ * Constructs a service interface. The returned service will have a {client}
+ * property that provides access to the API operations.
+ * @option (see AWS.S3.Client.constructor)
+ *
+ * @!attribute client
+ * @return [AWS.S3.Client] A client that provides one method for each
+ * API operation.
+ *
+ * @see AWS.S3.Client
+ *
+ */
+AWS.S3 = inherit({})
+
+/**
* @!method abortMultipartUpload(params, options)
* Aborts a multipart upload.
* @param [Object] params
@@ -1255,7 +1281,9 @@ AWS = {};
*
*
* @!method constructor(options)
- * @option options [String] endpoint The HTTP(s) endpoint to send requests
+ * Constructs a service client object. This client has one method for
+ * each API operation.
+ * @option options [String] endpoint The endpoint URI to send requests
* to. The default endpoint is built from the configured +region+.
* The endpoint should be a string like <tt>'https://s3.amazonaws.com'</tt>.
* @option (see AWS.Config.constructor)
@@ -17,6 +17,32 @@
AWS = {};
/**
+ * Constructs a service interface and a low-level {Client}. Use the +client+
+ * property to make API calls. Each API operation is exposed as a function on
+ * the +client+.
+ *
+ * === Sending a Request Using SimpleWorkflow
+ *
+ * svc = new AWS.SimpleWorkflow();
+ * svc.client.OPERATION_NAME(params).always(function (resp) {
+ * console.log(resp.data, resp.error);
+ * });
+ *
+ * @!method constructor(options)
+ * Constructs a service interface. The returned service will have a {client}
+ * property that provides access to the API operations.
+ * @option (see AWS.SimpleWorkflow.Client.constructor)
+ *
+ * @!attribute client
+ * @return [AWS.SimpleWorkflow.Client] A client that provides one method for each
+ * API operation.
+ *
+ * @see AWS.SimpleWorkflow.Client
+ *
+ */
+AWS.SimpleWorkflow = inherit({})
+
+/**
* @!method countClosedWorkflowExecutions(params, options)
* Calls the CountClosedWorkflowExecutions API operation.
* @param [Object] params
@@ -1310,7 +1336,9 @@ AWS = {};
*
*
* @!method constructor(options)
- * @option options [String] endpoint The HTTP(s) endpoint to send requests
+ * Constructs a service client object. This client has one method for
+ * each API operation.
+ * @option options [String] endpoint The endpoint URI to send requests
* to. The default endpoint is built from the configured +region+.
* The endpoint should be a string like <tt>'https://s3.amazonaws.com'</tt>.
* @option (see AWS.Config.constructor)

0 comments on commit 900fe07

Please sign in to comment.