@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.687.0 (2024-11-07)

Features

• client-auto-scaling: Auto Scaling groups now support the ability to strictly balance instances across Availability Zones by configuring the AvailabilityZoneDistribution parameter. If balanced-only is configured for a group, launches will always be attempted in the under scaled Availability Zone even if it is unhealthy. (3589a0f)
• client-bedrock-agent: Add prompt support for chat template configuration and agent generative AI resource. Add support for configuring an optional guardrail in Prompt and Knowledge Base nodes in Prompt Flows. Add API to validate flow definition (7f72a17)
• client-bedrock-runtime: Add Prompt management support to Bedrock runtime APIs: Converse, ConverseStream, InvokeModel, InvokeModelWithStreamingResponse (6607253)
• client-cleanroomsml: This release introduces support for Custom Models in AWS Clean Rooms ML. (188d601)
• client-cleanrooms: This release introduces support for Custom Models in AWS Clean Rooms ML. (ef8b258)
• client-quicksight: Add Client Credentials based OAuth support for Snowflake and Starburst (3d8d0bb)
• client-resource-explorer-2: Add GetManagedView, ListManagedViews APIs. (362a7bd)
• client-synthetics: Add support to toggle if a canary will automatically delete provisioned canary resources such as Lambda functions and layers when a canary is deleted. This behavior can be controlled via the new ProvisionedResourceCleanup property exposed in the CreateCanary and UpdateCanary APIs. (b06511c)
• clients: update client endpoints as of 2024-11-07 (dbf853a)