From afee763b3a8d3b7738dee3800043fb638d9201fe Mon Sep 17 00:00:00 2001 From: George Fu Date: Wed, 15 Feb 2023 13:24:34 -0500 Subject: [PATCH] chore(types): add deprecation explanation to SdkError (#4437) --- packages/types/src/shapes.ts | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/packages/types/src/shapes.ts b/packages/types/src/shapes.ts index c0335836fcc2..95963466fa55 100644 --- a/packages/types/src/shapes.ts +++ b/packages/types/src/shapes.ts @@ -56,5 +56,16 @@ export interface SmithyException { /** * @deprecated + * @see https://aws.amazon.com/blogs/developer/service-error-handling-modular-aws-sdk-js/ + * + * This type should not be used in your application. + * Users of the AWS SDK for JavaScript v3 service clients should prefer to + * use the specific Exception classes corresponding to each operation. + * These can be found as code in the deserializer for the operation's Command class, + * or as declarations in the service model file in codegen/sdk-codegen/aws-models. + * + * If no exceptions are enumerated by a particular Command operation, + * the base exception for the service should be used. Each client exports + * a base ServiceException prefixed with the service name. */ export type SdkError = Error & Partial & Partial;