Class: Amazon::AWS::Help

Inherits:

Operation

Object
Operation
Amazon::AWS::Help

show all

Defined in:: lib/amazon/aws.rb

Overview

This class of operation aids in finding out about AWS operations and response groups.

Constant Summary

Constants inherited from Operation

Operation::OPERATIONS

Instance Attribute Summary

Attributes inherited from Operation

#kind, #params, #response_group

Instance Method Summary collapse

#initialize(help_type, about, parameters = {}) ⇒ Help constructor

Return information on AWS operations and response groups.

Methods inherited from Operation

#batch, #batch_parameters

Constructor Details

#initialize(help_type, about, parameters = {}) ⇒ `Help`

Return information on AWS operations and response groups.

For operations, required and optional parameters are returned, along with information about which response groups the operation can use.

For response groups, The list of operations that can use that group is returned, as well as the list of response tags returned by the group.

help_type is the type of object for which help is being sought, such as Operation or ResponseGroup. about is the name of the operation or response group you need help with, and parameters is an optional hash of parameters that further refine the request for help.

# File 'lib/amazon/aws.rb', line 880

def initialize(help_type, about, parameters={})
	super( { 'HelpType' => help_type,
		 'About'    => about
  }.merge( parameters ) )
end