modules/aws/README.txt

INTRODUCTION
--------------------------------------------
AWS is an Amazon Web Services API for module developers. 

It abstracts AWS requests allowing you to focus on consuming the service instead 
of the detail of communicating with the service.

There are many service modules written (or being written) that extend this module. 
Those extentions are most likely the ones you will want to interface with.

Please refer to the README files in the respective sub-module to learn more on how 
to use it.


TARGET
--------------------------------------------
End Users:
This is for module developers only. Do NOT install unless required by another 
module.

Module Developers:
This module is the base API module for the sub-modules that give easy access to 
Amazon Web Services. Unless you want to write a new AWS sub-module then you will 
want to use one of the sub-modules that matches the services you wish to consume.


REQUEST API
--------------------------------------------
aws_request()
This function is a wrapper for the rest_client module's rest_client_request. 
Please see the rest_client's README for full information on the API used.

The function currently adds certain headers by default including signing the 
header for you.
1	INTRODUCTION
2	--------------------------------------------
3	AWS is an Amazon Web Services API for module developers.
4
5	It abstracts AWS requests allowing you to focus on consuming the service instead
6	of the detail of communicating with the service.
7
8	There are many service modules written (or being written) that extend this module.
9	Those extentions are most likely the ones you will want to interface with.
10
11	Please refer to the README files in the respective sub-module to learn more on how
12	to use it.
13
14
15	TARGET
16	--------------------------------------------
17	End Users:
18	This is for module developers only. Do NOT install unless required by another
19	module.
20
21	Module Developers:
22	This module is the base API module for the sub-modules that give easy access to
23	Amazon Web Services. Unless you want to write a new AWS sub-module then you will
24	want to use one of the sub-modules that matches the services you wish to consume.
25
26
27	REQUEST API
28	--------------------------------------------
29	aws_request()
30	This function is a wrapper for the rest_client module's rest_client_request.
31	Please see the rest_client's README for full information on the API used.
32
33	The function currently adds certain headers by default including signing the
34	header for you.