@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.525.0 (2024-02-29)

Bug Fixes

• middleware-sdk-s3: restore bucketEndpoint configurability (#5840) (f05b540)

Features

• client-docdb-elastic: Launched Elastic Clusters Readable Secondaries, Start/Stop, Configurable Shard Instance count, Automatic Backups and Snapshot Copying (c995dd7)
• client-eks: Added support for new AL2023 AMIs to the supported AMITypes. (dc85f33)
• client-lex-models-v2: This release makes AMAZON.QnAIntent generally available in Amazon Lex. This generative AI feature leverages large language models available through Amazon Bedrock to automate frequently asked questions (FAQ) experience for end-users. (19c93a4)
• client-migrationhuborchestrator: Adds new CreateTemplate, UpdateTemplate and DeleteTemplate APIs. (86ce4d1)
• client-quicksight: TooltipTarget for Combo chart visuals; ColumnConfiguration limit increase to 2000; Documentation Update (eddad24)
• client-sagemaker: Adds support for ModelDataSource in Model Packages to support unzipped models. Adds support to specify SourceUri for models which allows registration of models without mandating a container for hosting. Using SourceUri, customers can decouple the model from hosting information during registration. (06093eb)
• client-securitylake: Add capability to update the Data Lake's MetaStoreManager Role in order to perform required data lake updates to use Iceberg table format in their data lake or update the role for any other reason. (29c5d21)
• clients: update client endpoints as of 2024-02-29 (f46a723)