AWS.HttpResponse — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Inherits:

Object

• Object
• AWS.HttpResponse show all

Defined in:

lib/http.js

Overview

The low level HTTP response object, encapsulating all HTTP header and body data returned from the request.

Property Summarycollapse

• body ⇒ String readwrite
  The response body payload.
• headers ⇒ map<String,String> readwrite
  A map of response header keys and their respective values.
• statusCode ⇒ Integer readwrite
  The HTTP status code of the response (e.g., 200, 404).
• streaming ⇒ Boolean readwrite
  Whether this response is being streamed at a low-level.

Method Summarycollapse

• createUnbufferedStream() ⇒ Stream, ...
  Disables buffering on the HTTP response and returns the stream for reading.

Property Details

body ⇒ String

Returns the response body payload.

Returns a map of response header keys and their respective values.

statusCode ⇒ Integer

Returns the HTTP status code of the response (e.g., 200, 404).

streaming ⇒ Boolean

Returns whether this response is being streamed at a low-level. Defaults to false (buffered reads). Do not modify this manually, usecreateUnbufferedStream() to convert the stream to unbuffered mode instead.

Method Details

createUnbufferedStream() ⇒ Stream, ...

Disables buffering on the HTTP response and returns the stream for reading.