@aws-sdk/types

What is @aws-sdk/types?

The @aws-sdk/types package provides TypeScript definitions for the AWS SDK for JavaScript v3. These types define the shapes of AWS service clients, commands, input and output parameters, and other utility types that are used across the AWS SDK. This package is essential for TypeScript developers using the AWS SDK as it enables type checking and IntelliSense support in IDEs.

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

Service Client Interface

Defines the configuration interface for an AWS service client, such as the S3 client. It extends from a base client configuration and includes service-specific options.

{"interface S3ClientConfig extends SmithyClientConfig {endpoint?: HttpEndpoint, forcePathStyle?: boolean, useAccelerateEndpoint?: boolean, ...}}

Command Interface

Represents a command interface that defines input and output types for a specific operation. It also includes methods for resolving middleware in the command's execution stack.

{"interface Command<InputType extends object, OutputType extends object, ResolvedClientConfiguration, ClientInput extends InputType = InputType, ClientOutput extends OutputType = OutputType> {resolveMiddleware(stack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ResolvedClientConfiguration): Handler<ClientInput, ClientOutput>; ...}}

Middleware Stack

Defines the middleware stack interface used in the AWS SDK. Middleware are functions that can modify requests and responses or handle specific tasks like logging or error handling.

{"interface MiddlewareStack<Input extends object, Output extends object> {add(middleware: MiddlewareType<Input, Output>, options?: MiddlewareStackOptions): void; addRelativeTo(middleware: MiddlewareType<Input, Output>, options: RelativeMiddlewareOptions): void; ...}}

Other packages similar to @aws-sdk/types

@google-cloud/common

Provides types and utility functions for Google Cloud client libraries for Node.js. Similar to @aws-sdk/types, it offers TypeScript definitions but for Google Cloud services.

azure-sdk-for-js

The Azure SDK for JavaScript provides TypeScript type definitions for Azure services. It is analogous to @aws-sdk/types but tailored for Microsoft Azure's cloud services.

@types/node

This package contains type definitions for Node.js. While not specific to a cloud provider, it serves a similar purpose by providing TypeScript types for Node.js core modules, much like @aws-sdk/types does for AWS SDK.

README

@aws-sdk/types

Changelog

3.713.0 (2024-12-16)

Features

• client-dlm: This release adds support for Local Zones in Amazon Data Lifecycle Manager EBS snapshot lifecycle policies. (36c9b5a)
• client-ec2: This release adds support for EBS local snapshots in AWS Dedicated Local Zones, which allows you to store snapshots of EBS volumes locally in Dedicated Local Zones. (0a3b2ac)
• client-greengrassv2: Add support for runtime in GetCoreDevice and ListCoreDevices APIs. (8ea87b4)
• client-medialive: AWS Elemental MediaLive adds three new features: MediaPackage v2 endpoint support for live stream delivery, KLV metadata passthrough in CMAF Ingest output groups, and Metadata Name Modifier in CMAF Ingest output groups for customizing metadata track names in output streams. (7567d64)
• client-rds: This release adds support for the "MYSQL_CACHING_SHA2_PASSWORD" enum value for RDS Proxy ClientPasswordAuthType. (8afc56c)
• clients: update command documentation examples as of 2024-12-16 (fbec847)
• credential-providers: make credential providers aware of caller client region (#6726) (a65995f)