@aws-sdk/util-user-agent-node

What is @aws-sdk/util-user-agent-node?

@aws-sdk/util-user-agent-node is a utility package from the AWS SDK for JavaScript. It is used to construct and manage user-agent strings for AWS SDK clients running in Node.js environments. This helps in identifying the SDK version, environment, and other relevant information when making requests to AWS services.

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

Constructing User-Agent String

This feature allows you to construct a default user-agent string that includes information about the SDK version and the runtime environment.

const { defaultUserAgent } = require('@aws-sdk/util-user-agent-node');
const userAgent = defaultUserAgent();
console.log(userAgent);

Customizing User-Agent String

This feature allows you to customize the user-agent string by adding additional information, such as application-specific details.

const { defaultUserAgent } = require('@aws-sdk/util-user-agent-node');
const customUserAgent = defaultUserAgent({ custom: 'myApp/1.0.0' });
console.log(customUserAgent);

Other packages similar to @aws-sdk/util-user-agent-node

useragent

The 'useragent' package is a comprehensive library for parsing user-agent strings in Node.js. It provides detailed information about the browser, operating system, and device. Unlike @aws-sdk/util-user-agent-node, which is focused on constructing user-agent strings for AWS SDK clients, 'useragent' is more general-purpose and can be used in a variety of applications.

ua-parser-js

The 'ua-parser-js' package is a JavaScript library for parsing user-agent strings and extracting detailed information about the browser, engine, OS, CPU, and device. It is similar to 'useragent' but is designed to be lightweight and fast. While @aws-sdk/util-user-agent-node is specialized for AWS SDK clients, 'ua-parser-js' is suitable for broader use cases.

README

@aws-sdk/util-user-agent-node

An internal package

Usage

You probably shouldn't, at least directly.

Changelog

3.816.0 (2025-05-22)

Features

• client-amp: Add QueryLoggingConfiguration APIs for Amazon Managed Prometheus (b889c42)
• client-auditmanager: With this release, the AssessmentControl description field has been deprecated, as of May 19, 2025. Additionally, the UpdateAssessment API can now return a ServiceQuotaExceededException when applicable service quotas are exceeded. (4d7233a)
• client-dsql: Features: support for customer managed encryption keys (f5e3e09)
• client-glue: This release supports additional ConversionSpec parameter as part of IntegrationPartition Structure in CreateIntegrationTableProperty API. This parameter is referred to apply appropriate column transformation for columns that are used for timestamp based partitioning (eeecd10)