S3Client parameter type doesn't accept documented values

[gcb]

Checkboxes for prior research

• I've gone through Developer Guide and API reference
• I've checked AWS Forums and StackOverflow.
• I've searched for previous similar issues and didn't find any solution.

Describe the bug

Documentation tells to pass a single obj

const client = new S3Client({ region });

which causes error:

... is not assignable to parameter of type '[] | [S3ClientConfig]'.

It seems to be expecting a list of configs, which I tried and then it fails saying "Error: Region is missing", which led me to believe the code doesn't actually expect a list, so i did not debug any further.

Regression Issue

• Select this option if this issue appears to be a regression.

SDK version number

@aws-sdk/client-s3@3.779.0

Which JavaScript Runtime is this issue in?

Node.js

Details of the browser/Node.js/ReactNative version

node v23.9.0

Reproduction Steps

follow https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/javascript_s3_code_examples.html

Observed Behavior

type error

Expected Behavior

no type error

Possible Solution

No response

Additional Information/Context

No response

[aBurmeseDev]

Hi @gcb - you may want to check out this docs on client configuration for each service. You can pass in many options in client config, including specifying the region and setting up credential providers. If you've already configured your credentials, you can simply pass an empty object instead.

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

Hope that helps!

[gcb]

Hi @gcb - you may want to check out this docs on client configuration for each service. You can pass in many options in client config, including specifying the region and setting up credential providers. If you've already configured your credentials, you can simply pass an empty object instead.

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

Hope that helps!

thanks. Did you check it out on the version mentioned with typescript? the error i got is that the type expects an array of objects, not an object

[zshzbh]

@gcb What value did you assign to region? I tried to use put a string into the region and it didn't have any error pop up.

[gcb]

it seems to be something with my env processing.

const client = new S3Client(
	{
		endpoint: process.env.S3_ENDPOINT,
		region: process.env.S3_REGION,
		credentials: {
			accessKeyId: process.env.S3_ACCESS_KEY,
			secretAccessKey: process.env.S3_SECRET_KEY,
		},
	}
);

Shows the type error. but

const client = new S3Client(
	{
		endpoint: 'https://s3.eu-central-003.backblazeb2.com',
		region: 'eu-central-003',
		credentials: {
			accessKeyId: 'abc',
			secretAccessKey: 'abc',
		},
	}
);

Matches the type just fine.

The way it showed a list in is not assignable to parameter of type '[] | [S3ClientConfig]' threw me off.