@aws-sdk/middleware-endpoint

What is @aws-sdk/middleware-endpoint?

The @aws-sdk/middleware-endpoint package is part of the AWS SDK for JavaScript v3. It is used to manage and resolve endpoints in AWS service calls. This middleware allows developers to customize endpoint resolution logic, which can be useful for directing requests to specific regions, using custom domain names, or working with mock endpoints for testing purposes.

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

Custom Endpoint Resolution

This code demonstrates how to use the @aws-sdk/middleware-endpoint package to customize the endpoint for an S3 client. It adds a middleware that resolves to a custom endpoint, which is useful for directing requests to a specific server or for testing with mock endpoints.

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

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

client.middlewareStack.add(endpointMiddleware({
  endpoint: () => ({
    protocol: 'https:',
    hostname: 'my-custom-s3-endpoint.com',
    path: '/',
    query: {}
  })
}), {
  step: 'build'
});

const command = new GetObjectCommand({ Bucket: 'example-bucket', Key: 'example-object' });
client.send(command);

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

@aws-sdk/middleware-retry

This package provides middleware for handling retries of requests in AWS SDK for JavaScript v3. It is similar to @aws-sdk/middleware-endpoint in that it modifies the request handling pipeline, but it focuses on retry logic rather than endpoint resolution.

@aws-sdk/middleware-logger

The @aws-sdk/middleware-logger package allows logging of requests and responses in the AWS SDK for JavaScript v3. Like @aws-sdk/middleware-endpoint, it enhances the SDK's capabilities by adding middleware that intercepts and logs all service interactions, although its primary focus is on logging rather than endpoint management.

README

@aws-sdk/middleware-endpoint

An internal package

Usage

You probably shouldn't, at least directly.

Changelog

3.325.0 (2023-05-02)

Features

• client-appflow: This release adds new API to cancel flow executions. (e139022)
• client-connect: Amazon Connect Service Rules API update: Added OnContactEvaluationSubmit event source to support user configuring evaluation form rules. (be236b1)
• client-kendra: AWS Kendra now supports configuring document fields/attributes via the GetQuerySuggestions API. You can now base query suggestions on the contents of document fields. (4e715d7)
• client-resiliencehub: This release will improve resource level transparency in applications by discovering previously hidden resources. (91006ef)
• client-sagemaker: Amazon Sagemaker Autopilot supports training models with sample weights and additional objective metrics. (52e716a)
• clients: update client endpoints as of 2023-05-02 (109fa1c)
• codegen: bump codegen version to 0.15.0 (#4678) (83421a1)

Reverts

• Revert "feat(codegen): bump codegen version to 0.15.0 (#4678)" (#4689) (f75bf2c), closes #4678 #4689