@aws-sdk/middleware-bucket-endpoint

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

The @aws-sdk/middleware-bucket-endpoint package is part of the AWS SDK for JavaScript (v3). It provides middleware that automatically configures the endpoint for S3 bucket operations, allowing users to interact with different S3 bucket configurations and regions more seamlessly. This package is particularly useful for managing requests to S3 buckets by modifying the endpoint based on the operation and the provided bucket parameters.

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

Automatic Endpoint Resolution

This code sample demonstrates how to integrate the bucketEndpointMiddleware into an S3 client instance. It automatically resolves the correct endpoint for the bucket specified in the command.

import { S3Client, GetObjectCommand } from '@aws-sdk/client-s3';
import { bucketEndpointMiddleware } from '@aws-sdk/middleware-bucket-endpoint';

const client = new S3Client({
  region: 'us-west-2',
  middlewareStack: {
    add: (middleware) => middleware(bucketEndpointMiddleware())
  }
});

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

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

@aws-sdk/middleware-sdk-s3

This package includes various middleware utilities for S3 operations within the AWS SDK for JavaScript. It offers functionalities similar to @aws-sdk/middleware-bucket-endpoint but is broader in scope, covering more aspects of S3 interactions beyond just endpoint resolution.

@aws-sdk/s3-request-presigner

While primarily focused on generating pre-signed URLs for S3 requests, this package interacts with S3 endpoints in a manner that complements the functionalities provided by @aws-sdk/middleware-bucket-endpoint. It handles endpoint resolution implicitly when generating URLs.

README

@aws-sdk/middleware-bucket-endpoint

Changelog

3.692.0 (2024-11-14)

Features

• client-accessanalyzer: Expand analyzer configuration capabilities for unused access analyzers. Unused access analyzer configurations now support the ability to exclude accounts and resource tags from analysis providing more granular control over the scope of analysis. (b2df1e1)
• client-cloudcontrol: Added support for CloudFormation Hooks with Cloud Control API. The GetResourceRequestStatus API response now includes an optional HooksProgressEvent and HooksRequestToken parameter for Hooks Invocation Progress as part of resource operation with Cloud Control. (e90cde2)
• client-deadline: Adds support for select GPU accelerated instance types when creating new service-managed fleets. (ac3309b)
• client-iam: This release includes support for five new APIs and changes to existing APIs that give AWS Organizations customers the ability to use temporary root credentials, targeted to member accounts in the organization. (c9dfef1)
• client-iot-wireless: New FuotaTask resource type to enable logging for your FUOTA tasks. A ParticipatingGatewaysforMulticast parameter to choose the list of gateways to receive the multicast downlink message and the transmission interval between them. Descriptor field which will be sent to devices during FUOTA transfer. (69415e0)
• client-ivs: IVS now offers customers the ability to stream multitrack video to Channels. (84b6f4c)
• client-license-manager-user-subscriptions: New and updated API operations to support License Included User-based Subscription of Microsoft Remote Desktop Services (RDS). (5c7c349)
• client-partnercentral-selling: Announcing AWS Partner Central API for Selling: This service launch Introduces new APIs for co-selling opportunity management and related functions. Key features include notifications, a dynamic sandbox for testing, and streamlined validations. (07b84d2)
• client-quicksight: This release adds APIs for Custom Permissions management in QuickSight, and APIs to support QuickSight Branding. (81b1f8c)
• client-redshift: Adds support for Amazon Redshift S3AccessGrants (bf85814)
• client-s3: This release updates the ListBuckets API Reference documentation in support of the new 10,000 general purpose bucket default quota on all AWS accounts. To increase your bucket quota from 10,000 to up to 1 million buckets, simply request a quota increase via Service Quotas. (1e42456)
• client-sagemaker: Add support for Neuron instance types [ trn1/trn1n/inf2 ] on SageMaker Notebook Instances Platform. (dd44e8a)
• client-sts: This release introduces the new API 'AssumeRoot', which returns short-term credentials that you can use to perform privileged tasks. (5528f54)
• clients: update client endpoints as of 2024-11-14 (87df5bd)