Class AWS::Core::Http::Request
In: lib/aws/core/http/request.rb
Parent: Object

Base class for all service reqeusts.

Methods

Classes and Modules

Class AWS::Core::Http::Request::CaseInsensitiveHash
Class AWS::Core::Http::Request::Param

Attributes

access_key_id  [RW]  @return [String] the AWS access key ID used to authorize the
  request
headers  [RW]  @return [CaseInsensitiveHash] request headers
host  [RW]  @return [String] hostname of the request
http_method  [RW]  @return [String] GET, PUT POST, HEAD or DELETE, defaults to POST
params  [RW]  @return [Array] An array of request params, each param responds to
  #name and #value.
path  [RW]  @return [String] path of the request URI, defaults to /
proxy_uri  [RW]  @return [nil, URI] The URI to the proxy server requests are
  sent through if configured.  Returns nil if there is no proxy.
read_timeout  [RW]  @return [Integer] The number of seconds the service has to respond
  before a timeout error is raised on the request.  Defaults to
  60 seconds.
region  [RW]  @return [String] The region name this request is for. Only needs
  to be populated for requests against signature v4 endpoints.
service_ruby_name  [RW]  @return [String] The snake-cased ruby name for the service
  (e.g. 's3', 'iam', 'dynamo_db', etc).

Public Class methods

Returns a new empty http request object.

Public Instance methods

[]=(name_or_param, value = nil)

Alias for add_param

Adds a request param.

@overload add_param(param_name, param_value = nil)

  Add a param (name/value)
  @param [String] param_name
  @param [String] param_value Leave blank for sub resources

@overload add_param(param_obj)

  Add a param (object)
  @param [Param] param_obj

@return [String, nil] Returns the request body.

@return [Integer] Returns the port the request will be made over.

  Defaults to 443 for SSL requests and 80 for non-SSL requests.

Override the default port (443 or 80). If you pass nil then the default port will take precedence. @param [Integer,nil] port_number

@return [String, nil] Returns the requesty querystring.

@return [String] Path to a bundle of CA certs in PEM format;

  the HTTP handler should use this to verify all HTTPS
  requests if {#ssl_verify_peer?} is true.

@param [String] ca_file Path to a bundle of CA certs in PEM

  format; the HTTP handler should use this to verify all HTTPS
  requests if {#ssl_verify_peer?} is true.

@return [String] Path to a bundle of CA certs in PEM format;

  the HTTP handler should use this to verify all HTTPS
  requests if {#ssl_verify_peer?} is true.

@param [String] ca_path Path to a bundle of CA certs in PEM

  format; the HTTP handler should use this to verify all HTTPS
  requests if {#ssl_verify_peer?} is true.

@param [Boolean] verify_peer If the client should verify the

  peer certificate or not.

@return [Boolean] If the client should verify the peer

  certificate or not.

@return [String] the request uri

@return [String] Returns the request params url encoded, or nil if

  this request has no params.

@param [Boolean] ssl If the request should be sent over ssl or not.

@return [Boolean] If this request should be sent over ssl or not.

[Validate]