You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.HttpRequest

Inherits:
Object
  • Object
show all
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 collapse

Method Summary collapse

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:

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