How to configure timeouts in v3?

[davidtheclark]

Confirm by changing [ ] to [x] below:

• I've gone through Developer Guide and API reference
• I've checked AWS Forums and StackOverflow for answers

Describe the question

I'm trying to understand timeouts in v3. So far, I haven't managed to find any documentation that answers these questions:

• What are the default timeouts?
• How do I configure the timeouts, if I want settings other than the defaults?

Is there documentation about this? If not, can you please help with these questions?

(I saw aws/aws-sdk-js#3611, but since it was focused on v2 I thought I'd open a new issue.)

[davidtheclark]

I realized now that I should have opened this issue over in https://github.com/aws/aws-sdk-js-v3. Please transfer this issue, or let me know if you'd prefer I create a duplicate over there.

[AllanZhengYP]

Hi @davidtheclark

The http options in v3 is configured differently in v3. You can refer to our Upgrading Guide and go to the httpOptions section to see how each of the V2 options migrated to the V3 options.

[davidtheclark]

@AllanZhengYP Those must be the bullet points you're indicating:

connectionTimeout

v2: Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds.
v3: connectionTimeout is available in NodeHttpHandler options.
timeout

v2: The number of milliseconds a request can take before automatically being terminated.
v3: Hard request timeout is not available in NodeHttpHandler, but available as requestTimeout in FetchHttphandler in browsers

Does this mean you can no longer set the equivalent of timeout in Node.js? You have to use connectTimeout via a custom NodeHttpHandler?

The NodeHttpHandler docs are extremely sparse. Is there more information somewhere about what it's for and how it works? If I only want to set connectionTimeout, can I just create a NodeHttpHandler with that setting, or do I also need to configure other settings for it to work correctly?

[AllanZhengYP]

Hey @davidtheclark

Does this mean you can no longer set the equivalent of timeout in Node.js? You have to use connectTimeout via a custom NodeHttpHandler?

The timeout config in v2 SDK equals to NodeHttpHandler's socketTimeout config, whereas connectTimeout config n v2 SDK equals to the NodeHttpHandler's connectionTimeout. You need to set them via a custom NodeHttpHandler. The related section is not up-to-date, I will update the UPGRADING.md to clarify it.

The NodeHttpHandler docs are extremely sparse. Is there more information somewhere about what it's for and how it works?

I'm working on improving the our API reference experience in the API Reference Improvement project. I plan to move the examples in the UPGRADING.md into the API reference page.

Please let me know if you have more suggestions.

[github-actions]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread.