Note: You are viewing the documentation for an older major version of the AWS SDK for JavaScript (v2).

The modular AWS SDK for JavaScript (v3) is now General Available. For more information see the Developer Guide or 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

bodyString (readwrite)

Returns the request body payload

Returns:

  • (String)

    the request body payload

endpointAWS.Endpoint (readwrite)

Returns the endpoint for the request

Returns:

headersmap<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

methodString (readwrite)

Returns the HTTP method of the request

Returns:

  • (String)

    the HTTP method of the request

pathString (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