Class: AWS.HttpRequest

Inherits:

Object

• Object
• AWS.HttpRequest

Defined in:

lib/http.js

Overview

The low level HTTP request object, encapsulating all HTTP header and body data sent by a service request.

Property Summary

• body ⇒ String readwrite

  The request body payload.

• endpoint ⇒ AWS.Endpoint readwrite

  The endpoint for the request.

• headers ⇒ map<String,String> readwrite

  A map of header keys and their respective values.

• method ⇒ String readwrite

  The HTTP method of the request.

• path ⇒ String readwrite

  The path portion of the URI, e.g., "/list/?start=5&num=10".

Method Summary

• getUserAgentHeaderName() ⇒ void
• pathname() ⇒ String

  The part of the path excluding the query string.

• search() ⇒ String

  The query string portion of the path.

Property Details

body ⇒ String (readwrite)

Returns the request body payload

Returns:

• (String) —

  the request body payload

endpoint ⇒ AWS.Endpoint (readwrite)

Returns the endpoint for the request

Returns:

• (AWS.Endpoint) —

  the endpoint for the request

headers ⇒ map<String,String> (readwrite)

Returns a map of header keys and their respective values

Returns:

• (map<String,String>) —

  a map of header keys and their respective values

method ⇒ String (readwrite)

Returns the HTTP method of the request

Returns:

• (String) —

  the HTTP method of the request

path ⇒ String (readwrite)

Returns the path portion of the URI, e.g., "/list/?start=5&num=10"

Returns:

• (String) —

  the path portion of the URI, e.g., "/list/?start=5&num=10"

Method Details

getUserAgentHeaderName() ⇒ void

pathname() ⇒ String

Returns the part of the path excluding the query string

Returns:

• (String) —

  the part of the path excluding the query string

search() ⇒ String

Returns the query string portion of the path

Returns:

• (String) —

  the query string portion of the path