@aws-sdk/middleware-endpoint-discovery

What is @aws-sdk/middleware-endpoint-discovery?

@aws-sdk/middleware-endpoint-discovery is a middleware package for the AWS SDK for JavaScript. It provides functionality to automatically discover and cache endpoints for AWS services that support endpoint discovery. This can help improve performance and reliability by reducing the need to repeatedly look up endpoints.

What are @aws-sdk/middleware-endpoint-discovery's main functionalities?

Automatic Endpoint Discovery

This feature enables automatic endpoint discovery for AWS services. In this example, the S3Client is configured to enable endpoint discovery. When the ListBucketsCommand is sent, the middleware will automatically discover and cache the appropriate endpoint.

const { EndpointDiscoveryMiddleware } = require('@aws-sdk/middleware-endpoint-discovery');
const { S3Client, ListBucketsCommand } = require('@aws-sdk/client-s3');

const client = new S3Client({
  region: 'us-west-2',
  endpointDiscoveryEnabled: true
});

const command = new ListBucketsCommand({});

client.send(command).then((data) => {
  console.log(data);
}).catch((error) => {
  console.error(error);
});

Manual Endpoint Discovery

This feature allows for manual configuration of endpoint discovery. In this example, the EndpointDiscoveryMiddleware is manually added to the middleware stack of the S3Client. The middleware is configured to require a discovered endpoint.

const { EndpointDiscoveryMiddleware } = require('@aws-sdk/middleware-endpoint-discovery');
const { S3Client, ListBucketsCommand } = require('@aws-sdk/client-s3');

const client = new S3Client({
  region: 'us-west-2'
});

const command = new ListBucketsCommand({});

client.middlewareStack.add(EndpointDiscoveryMiddleware({
  isDiscoveredEndpointRequired: true
}), {
  step: 'build',
  priority: 'high'
});

client.send(command).then((data) => {
  console.log(data);
}).catch((error) => {
  console.error(error);
});

Other packages similar to @aws-sdk/middleware-endpoint-discovery

@aws-sdk/middleware-retry

@aws-sdk/middleware-retry provides retry logic for AWS SDK requests. It is similar to @aws-sdk/middleware-endpoint-discovery in that it enhances the reliability of AWS SDK operations, but it focuses on retrying failed requests rather than discovering endpoints.

@aws-sdk/middleware-signing

@aws-sdk/middleware-signing handles the signing of AWS SDK requests. While @aws-sdk/middleware-endpoint-discovery focuses on discovering and caching endpoints, @aws-sdk/middleware-signing ensures that requests are properly authenticated and authorized.

@aws-sdk/middleware-logger

@aws-sdk/middleware-logger provides logging capabilities for AWS SDK requests and responses. It is similar in that it adds additional functionality to the AWS SDK middleware stack, but it focuses on logging rather than endpoint discovery.

README

@aws-sdk/middleware-endpoint-discovery

Changelog

3.428.0 (2023-10-12)

Bug Fixes

• lib-dynamodb: add e2e suite and bug fixes for lib-dynamodb (#5306) (2fe0a88)
• middleware-flexible-checksums: skip checksum validation for s3 whole-object multipart GET (#5345) (6a6a75e)

Features

• client-auditmanager: This release introduces a new limit to the awsAccounts parameter. When you create or update an assessment, there is now a limit of 200 AWS accounts that can be specified in the assessment scope. (af41764)
• client-auto-scaling: Update the NotificationMetadata field to only allow visible ascii characters. Add paginators to DescribeInstanceRefreshes, DescribeLoadBalancers, and DescribeLoadBalancerTargetGroups (6727085)
• client-config-service: Add enums for resource types supported by Config (1cdcf43)
• client-controltower: Added new EnabledControl resource details to ListEnabledControls API and added new GetEnabledControl API. (784c6fb)
• client-customer-profiles: Adds sensitive trait to various shapes in Customer Profiles Calculated Attribute API model. (73c9229)
• client-ec2: This release adds Ubuntu Pro as a supported platform for On-Demand Capacity Reservations and adds support for setting an Amazon Machine Image (AMI) to disabled state. Disabling the AMI makes it private if it was previously shared, and prevents new EC2 instance launches from it. (9c57ae3)
• client-glue: Extending version control support to GitLab and Bitbucket from AWSGlue (b683df3)
• client-inspector2: Add MacOs ec2 platform support (2964c2f)
• client-ivs-realtime: Update GetParticipant to return additional metadata. (4adb626)
• client-lambda: Adds support for Lambda functions to access Dual-Stack subnets over IPv6, via an opt-in flag in CreateFunction and UpdateFunctionConfiguration APIs (2bb63a0)
• client-location: This release adds endpoint updates for all AWS Location resource operations. (f71b216)
• client-machine-learning: This release marks Password field as sensitive (4d5eac6)
• client-rds: This release adds support for adding a dedicated log volume to open-source RDS instances. (634a983)
• client-rekognition: Amazon Rekognition introduces support for Custom Moderation. This allows the enhancement of accuracy for detect moderation labels operations by creating custom adapters tuned on customer data. (87763f3)
• client-sagemaker: Amazon SageMaker Canvas adds KendraSettings and DirectDeploySettings support for CanvasAppSettings (685916c)
• client-textract: This release adds 9 new APIs for adapter and adapter version management, 3 new APIs for tagging, and updates AnalyzeDocument and StartDocumentAnalysis API parameters for using adapters. (4ce1e29)
• client-transcribe: This release is to enable m4a format to customers (8c24c28)
• clients: update client endpoints as of 2023-10-12 (3476339)