docs(document_client): update doc on input service instance (#4119)

aws · Jun 24, 2022 · 121de49 · 121de49
1 parent d089bd1
commit 121de49
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/lib/dynamodb/document_client.d.ts b/lib/dynamodb/document_client.d.ts
@@ -88,7 +88,11 @@ export namespace DocumentClient {
          */
         params?: {[key: string]: any}
         /**
-         * An optional pre-configured instance of the AWS.DynamoDB service object to use for requests. The object may bound parameters used by the document client.
+         * An optional pre-configured instance
+         * of the AWS.DynamoDB service object. This instance's config will be
+         * copied to a new instance used by this client. You should not need to
+         * retain a reference to the input object, and may destroy it or allow it
+         * to be garbage collected.
          */
         service?: DynamoDB
     }

diff --git a/lib/dynamodb/document_client.js b/lib/dynamodb/document_client.js
@@ -46,8 +46,10 @@ AWS.DynamoDB.DocumentClient = AWS.util.inherit({
    * @option options params [map] An optional map of parameters to bind to every
    *   request sent by this service object.
    * @option options service [AWS.DynamoDB] An optional pre-configured instance
-   *  of the AWS.DynamoDB service object to use for requests. The object may
-   *  bound parameters used by the document client.
+   *  of the AWS.DynamoDB service object. This instance's config will be
+   *  copied to a new instance used by this client. You should not need to
+   *  retain a reference to the input object, and may destroy it or allow it
+   *  to be garbage collected.
    * @option options convertEmptyValues [Boolean] set to true if you would like
    *  the document client to convert empty values (0-length strings, binary
    *  buffers, and sets) to be converted to NULL types when persisting to