32 const ProviderInfo = <DataProviderInfo>{
33 "type":
"AwsRestClientDataProvider",
34 "constructor_options": ConstructorOptions,
35 "supports_children": True,
36 "children_can_support_apis": True,
37 "children_can_support_records": False,
38 "children_can_support_observers": False,
42 const ConstructorOptions = RestClientDataProvider::ConstructorOptions + {
43 "data": <DataProviderOptionInfo>{
44 "type": AbstractDataProviderType::get(StringType),
45 "desc":
"Data serialization options are limited to `json` with this object",
49 "desc":
"use JSON serialization",
52 "default_value":
"json",
54 "aws_keyid": <DataProviderOptionInfo>{
55 "type": AbstractDataProviderType::get(StringType),
58 "aws_secret": <DataProviderOptionInfo>{
59 "type": AbstractDataProviderType::get(StringType),
60 "desc":
"The AWS secret access key value",
63 "aws_region": <DataProviderOptionInfo>{
64 "type": AbstractDataProviderType::get(StringType),
65 "desc":
"The AWS region to use (ex: `us-east-1`)",
67 "aws_service": <DataProviderOptionInfo>{
68 "type": AbstractDataProviderType::get(StringType),
69 "desc":
"The AWS service to use (ex: `iam`)",
71 "aws_s3": <DataProviderOptionInfo>{
72 "type": AbstractDataProviderType::get(BoolType),
73 "desc":
"Set to `True` to flag this object for use with AWS S3, which requires special "
75 "default_value": False,
77 "aws_token": <DataProviderOptionInfo>{
78 "type": AbstractDataProviderType::get(StringType),
79 "desc":
"A temporary session token from AWS Security Token Service for this HTTP session",
87 "call": Class::forName(
"AwsRestClientDataProvider::AwsRestClientCallDataProvider"),
88 "delete": Class::forName(
"AwsRestClientDataProvider::AwsRestClientDeleteDataProvider"),
89 "get": Class::forName(
"AwsRestClientDataProvider::AwsRestClientGetDataProvider"),
90 "head": Class::forName(
"AwsRestClientDataProvider::AwsRestClientHeadDataProvider"),
91 "options": Class::forName(
"AwsRestClientDataProvider::AwsRestClientOptionsDataProvider"),
92 "path": Class::forName(
"AwsRestClientDataProvider::AwsRestClientPatchDataProvider"),
93 "post": Class::forName(
"AwsRestClientDataProvider::AwsRestClientPostDataProvider"),
94 "put": Class::forName(
"AwsRestClientDataProvider::AwsRestClientPutDataProvider"),
static AwsRestClient getAwsRestConnection(hash< auto > options)
Returns a REST connection.
constructor(AwsRestClient rest)
Creates the object from a REST connection.
string getName()
Returns the data provider name.
constructor(*hash< auto > options)
Creates the object from constructor options.
*AbstractDataProvider getChildProviderImpl(string name)
Returns the given child provider or NOTHING if the given child is unknown.
*list< string > getChildProviderNamesImpl()
Returns a list of child data provider names, if any.
*list< hash< DataProviderSummaryInfo > > getChildProviderSummaryInfo()
Return data provider summary info.
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
*string getDesc()
Returns the data provider description.
Qore AwsRestClientDataProvider module definition.
Definition: AwsRestClientCallDataProvider.qc.dox.h:26