chore(tracer): mark captureAWS & captureAWSClient methods as depr…

…ecated (#2508)
aws-powertools · May 12, 2024 · e5cf50e · e5cf50e
1 parent 00ebc11
commit e5cf50e
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/packages/tracer/src/Tracer.ts b/packages/tracer/src/Tracer.ts
@@ -253,6 +253,7 @@ class Tracer extends Utility implements TracerInterface {
    * }
    * ```
    *
+   * @deprecated Use {@link captureAWSv3Client} instead.
    * @param aws - AWS SDK v2 import
    * @returns AWS - Instrumented AWS SDK
    */
@@ -281,7 +282,7 @@ class Tracer extends Utility implements TracerInterface {
    *   ...
    * }
    * ```
-   *
+   * @deprecated Use {@link captureAWSv3Client} instead.
    * @param service - AWS SDK v2 client
    * @returns service - Instrumented AWS SDK v2 client
    */

diff --git a/packages/tracer/src/provider/ProviderService.ts b/packages/tracer/src/provider/ProviderService.ts
@@ -31,10 +31,16 @@ import {
 import type { DiagnosticsChannel } from 'undici-types';
 
 class ProviderService implements ProviderServiceInterface {
+  /**
+   * @deprecated
+   */
   public captureAWS<T>(awssdk: T): T {
     return captureAWS(awssdk);
   }
 
+  /**
+   * @deprecated
+   */
   public captureAWSClient<T>(service: T): T {
     return captureAWSClient(service);
   }