AwsRestClient::AwsRestConnection Class Reference

class for AWS REST connections; returns AwsRestClient::AwsRestClient objects More...

Inheritance diagram for AwsRestClient::AwsRestConnection:

Public Member Methods
deprecated	constructor (string name, string desc, string url, bool monitor, *hash< auto > opts, hash< auto > urlh)
	DEPRECATED: creates the AwsRestConnection object. More...
	constructor (string name, string description, string url, hash< auto > attributes={}, hash< auto > options={})
	creates the AwsRestConnection object More...
*hash< auto >	getDefaultOptions ()
	returns default options
hash< auto >	getOptions ()
	gets options More...
string	getType ()
	returns "awsrest"

Static Public Member Methods
static deprecated AwsRestConnection	make (string name, string desc, string url, bool monitor, *hash< auto > opts, hash< auto > urlh)
	DEPRECATED: static constructor. More...

Public Attributes
const	Options
	AwsRestConnection object connection options.

Private Member Methods
AwsRestClient	getImpl (bool connect=True, *hash< auto > rtopts)
	returns a AwsRestClient::AwsRestClient object More...

Detailed Description

class for AWS REST connections; returns AwsRestClient::AwsRestClient objects

supports the following options:

• "aws_keyid": (required) AWS key ID
• "aws_region": (required) the AWS region to use (ex: "us-east-1")
• "aws_s3": (optional) set to True to flag this object for use with AWS S3, which requires special message encoding
• "aws_secret": (required) the AWS secret access key value
• "aws_service": (required) the AWS service to use (ex: "iam")
• "aws_token": (optional) a temporary session token from AWS Security Token Service for this HTTP session
• "connect_timeout": connection timeout to use in milliseconds
• "content_encoding": this sets the send encoding (if the "send_encoding" option is not set) and the requested response encoding; for possible values, see EncodingSupport
• "error_passthru": if True then HTTP status codes indicating errors will not cause a REST-RESPONSE-ERROR exception to be raised, rather such responses will be passed through to the caller like any other response
• "http_version": HTTP version to use ("1.0" or "1.1", defaults to "1.1")
• "max_redirects": maximum redirects to support
• "proxy": proxy URL to use
• "redirect_passthru": if True then redirect responses will be passed to the caller instead of processed
• "send_encoding": a send data encoding option or the value "auto" which means to use automatic encoding; if not present defaults to no content-encoding on sent message bodies
• "timeout": transfer timeout to use in milliseconds

Note

the data option is always set to "json"

See also

AwsRestClient::constructor() for more information on the above options

Member Function Documentation

constructor() [1/2]

deprecated AwsRestClient::AwsRestConnection::constructor	(	string	name,
		string	desc,
		string	url,
		bool	monitor,
		*hash< auto >	opts,
		hash< auto >	urlh
	)

DEPRECATED: creates the AwsRestConnection object.

Parameters

name	the name of the connection
desc	connection description
url	connection URL (potentially with password info)
monitor	monitoring flag
opts	connection options
urlh	broken down URL hash (as returned by Qore::parse_url())

Exceptions

AWSRESTCONNECTION-ERROR

missing apikey option

Deprecated:

since Qore 0.9

constructor() [2/2]

AwsRestClient::AwsRestConnection::constructor	(	string	name,
		string	description,
		string	url,
		hash< auto >	attributes = {},
		hash< auto >	options = {}
	)

creates the AwsRestConnection object

Parameters

name	the name of the connection
description	connection description
url	connection URL (potentially with password info)
attributes	various attributes. See below
options	connection options

See AbstractConnection::constructor() for attributes and options reference.

Exceptions

AWSRESTCONNECTION-ERROR

missing apikey option

getImpl()

AwsRestClient AwsRestClient::AwsRestConnection::getImpl ( bool  connect = True, *hash< auto >  rtopts  )

privatevirtual

returns a AwsRestClient::AwsRestClient object

Parameters

connect	if True, then the connection is returned already connected
rtopts	this connection type does not accept any runtime options, so this parameter is ignored

Returns

a AwsRestClient object

Reimplemented from RestClient::RestConnection.

getOptions()

hash<auto> AwsRestClient::AwsRestConnection::getOptions

(

)

gets options

Returns

returns a hash with the following supported options:

• "aws_keyid": (required) AWS key ID
• "aws_region": (required) the AWS region to use (ex: "us-east-1")
• "aws_s3": (optional) set to True to flag this object for use with AWS S3, which requires special message encoding
• "aws_secret": (required) the AWS secret access key value
• "aws_service": (required) the AWS service to use (ex: "iam")
• "aws_token": (optional) a temporary session token from AWS Security Token Service for this HTTP session
• "connect_timeout": connection timeout to use in milliseconds
• "content_encoding": this sets the send encoding (if the "send_encoding" option is not set) and the requested response encoding; for possible values, see EncodingSupport
• "error_passthru": if True then HTTP status codes indicating errors will not cause a REST-RESPONSE-ERROR exception to be raised, rather such responses will be passed through to the caller like any other response
• "http_version": HTTP version to use ("1.0" or "1.1", defaults to "1.1")
• "max_redirects": maximum redirects to support
• "proxy": proxy URL to use
• "redirect_passthru": if True then redirect responses will be passed to the caller instead of processed
• "send_encoding": a send data encoding option or the value "auto" which means to use automatic encoding; if not present defaults to no content-encoding on sent message bodies
• "timeout": transfer timeout to use in milliseconds

See also

AwsRestClient::constructor() for more information on the above options

make()

static deprecated AwsRestConnection AwsRestClient::AwsRestConnection::make ( string  name, string  desc, string  url, bool  monitor, *hash< auto >  opts, hash< auto >  urlh  )

static

DEPRECATED: static constructor.

Deprecated:

since Qore 0.9 in favor of new constructor and Qore::Reflection