Types in example syntax for GetStatementResultCommand appear to be incorrect

[DevonStern]

Describe the issue

The syntax example for GetStatementResultCommand shows GetStatementResultRequest as the type for the input GetStatementResultResponse as the type for the output. However, below the example it shows GetStatementResultCommandInput as the input type and GetStatementResultCommandOutput as the output type.

Links

https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/redshift-data/command/GetStatementResultCommand/

[aBurmeseDev]

Hi @DevonStern - thanks for reaching out and sorry about the confusion around this.

The behavior you're seeing is by design in AWS SDK for JavaScript v3, which differs from v2 in its modular structure. Each AWS service package in v3 comes with its own set of specific commands.

Let's break down your example:

• The actual service API is called GetStatementResult
• This API has its own request/response structure defined by the AWS service team GetStatementResultRequest/GetStatementResultResponse
• The AWS JavaScript SDK v3 then wraps this API into a command pattern with its own input/output interface (client+command) GetStatementResultCommandInput/GetStatementResultCommandOutput
• This pattern is consistent across all AWS services in SDK v3 docs. For instance, you'll see the same structure in other services like S3's PutObjectCommand.

The modular approach in v3 provides better organization and more precise control over service operations compared to the previous version. You can learn more details in this blog: https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/

Hope it helps!
John

[DevonStern]

Thank you for the clarification, @aBurmeseDev

In that case, it might be that some other pages need to have their examples updated to match that pattern. For example, on the pages for ExecuteStatementCommand and BatchExecuteStatementCommand it shows input/output as the types in the example rather than request/response. Is that correct?

[aBurmeseDev]

Every command page contains input/request and output/response which is consistent across. If we missed something, please open a new issue. Closing issue.

[github-actions]

This issue is now closed. Comments on closed issues are hard for our team to see.
If you need more assistance, please open a new issue that references this one.

[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.