@aws-sdk/middleware-user-agent

What is @aws-sdk/middleware-user-agent?

The @aws-sdk/middleware-user-agent package is part of the AWS SDK for JavaScript (v3). It is used to manage and customize the User-Agent header sent in requests made to AWS services. This middleware allows developers to append additional information to the User-Agent header, which can be useful for debugging, tracking, and analytics purposes.

What are @aws-sdk/middleware-user-agent's main functionalities?

Customizing User-Agent

This code demonstrates how to customize the User-Agent header when creating an S3 client instance. It appends 'MyApp/1.0.0' to the default User-Agent string provided by AWS SDK.

const { S3Client } = require('@aws-sdk/client-s3');
const { defaultUserAgent } = require('@aws-sdk/util-user-agent-node');
const { addUserAgent } = require('@aws-sdk/middleware-user-agent');

const client = new S3Client({
  region: 'us-west-2',
  customUserAgent: 'MyApp/1.0.0'
});

addUserAgent(client, defaultUserAgent({ serviceId: 'S3', clientVersion: '3.0.0' }));

Other packages similar to @aws-sdk/middleware-user-agent

useragent

The 'useragent' package is used to parse user agent strings. It can detect browser, engine, OS, CPU, and device type/model from parsed user agent strings. Unlike @aws-sdk/middleware-user-agent, which is specifically designed for AWS SDKs to manipulate User-Agent headers, 'useragent' provides broader parsing capabilities for any user agent string.

express-useragent

This is a simple Express.js middleware for exposing user-agent details to your application. It parses the user-agent string and adds an object with the details to the request object. While it serves a different context (web servers rather than AWS SDK clients), it shares the concept of processing user-agent information.

README

@aws-sdk/middleware-user-agent

Changelog

3.521.0 (2024-02-23)

Features

• client-rds: Add pattern and length based validations for DBShardGroupIdentifier (089edf3)
• requestHandler ctor param pass-through (#5820) (9fec71d)