@aws-sdk/protocol-http

What is @aws-sdk/protocol-http?

@aws-sdk/protocol-http is a package within the AWS SDK for JavaScript that provides HTTP request and response handling functionalities. It is designed to facilitate communication with AWS services by creating and managing HTTP requests and responses.

What are @aws-sdk/protocol-http's main functionalities?

Creating HTTP Requests

This feature allows you to create an HTTP request object with specified hostname, method, path, and headers. This is useful for setting up requests to AWS services or other endpoints.

const { HttpRequest } = require('@aws-sdk/protocol-http');

const request = new HttpRequest({
  hostname: 'example.com',
  method: 'GET',
  path: '/path',
  headers: {
    'Content-Type': 'application/json'
  }
});

console.log(request);

Handling HTTP Responses

This feature allows you to create an HTTP response object with specified status code, headers, and body. This is useful for handling responses from AWS services or other endpoints.

const { HttpResponse } = require('@aws-sdk/protocol-http');

const response = new HttpResponse({
  statusCode: 200,
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ message: 'Success' })
});

console.log(response);

Middleware Integration

This feature demonstrates how to integrate middleware into the request/response lifecycle. Middleware can be used to add custom logic, such as logging or modifying requests and responses.

const { HttpRequest, HttpResponse } = require('@aws-sdk/protocol-http');
const { middlewareStack } = require('@aws-sdk/middleware-stack');

const stack = middlewareStack();

stack.add(
  (next, context) => async (args) => {
    console.log('Request:', args.request);
    const result = await next(args);
    console.log('Response:', result.response);
    return result;
  },
  {
    step: 'initialize',
    name: 'loggingMiddleware',
    priority: 'high'
  }
);

const request = new HttpRequest({
  hostname: 'example.com',
  method: 'GET',
  path: '/path'
});

stack.resolve(
  (handler) => handler({ request }),
  { request }
).then((result) => console.log(result));

Other packages similar to @aws-sdk/protocol-http

axios

Axios is a popular promise-based HTTP client for the browser and Node.js. It provides a simple API for making HTTP requests and handling responses. Compared to @aws-sdk/protocol-http, Axios is more general-purpose and widely used for various web development tasks, not specifically tailored for AWS services.

node-fetch

Node-fetch is a lightweight module that brings `window.fetch` to Node.js. It allows you to make HTTP requests in a similar way to the Fetch API in the browser. While node-fetch is simpler and more lightweight, @aws-sdk/protocol-http offers more advanced features and integrations specifically for AWS services.

request

Request is a simplified HTTP client for Node.js with a user-friendly API. It has been widely used for making HTTP requests but is now deprecated. Compared to @aws-sdk/protocol-http, Request was more general-purpose and not specifically designed for AWS services.

README

@aws-sdk/protocol-http

Changelog

3.110.0 (2022-06-14)

Bug Fixes

• client-lex-runtime-v2: serialize eventstream payload properly (#3655) (757f883)
• shared-ini-file-loader: update ini parsing (#3682) (9536104)

Features

• client-budgets: Add a budgets ThrottlingException. Update the CostFilters value pattern. (3f98cfc)
• client-lookoutmetrics: Adding filters to Alert and adding new UpdateAlert API. (d52f9aa)
• client-mediaconvert: AWS Elemental MediaConvert SDK has added support for rules that constrain Automatic-ABR rendition selection when generating ABR package ladders. (9c9825e)