@@ -43,6 +43,7 @@ visit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests).
43431 . [ Install from Source] ( #install-from-source )
44441 . [ Giving feedback and contributing] ( #giving-feedback-and-contributing )
45451 . [ Known Issues] ( #known-issues )
46+ 1 . [ Functionality requiring AWS Common Runtime (CRT)] ( #functionality-requiring-aws-common-runtime-crt )
4647
4748## Getting Started
4849
@@ -468,4 +469,41 @@ For a full middleware stack deep dive please check out our [blog post](https://a
468469
469470## Known Issues
470471
472+ ### Functionality requiring AWS Common Runtime (CRT)
473+
474+ This SDK has optional functionality that requires the [ AWS Common Runtime (CRT)] ( https://docs.aws.amazon.com/sdkref/latest/guide/common-runtime.html )
475+ bindings to be included as a dependency with your application. This functionality includes:
476+
477+ - [ Amazon S3 Multi-Region Access Points] ( https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPoints.html )
478+ - [ Amazon S3 Object Integrity] ( https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html )
479+
480+ If the required AWS Common Runtime components are not installed you will receive an error like:
481+
482+ ``` console
483+ Cannot find module '@aws-sdk/signature-v4-crt'
484+ ...
485+ Please check if you have installed "@aws-sdk/signature-v4-crt" package explicitly.
486+ For more information please go to https://github.com/aws/aws-sdk-js-v3#known-issues
487+ ```
488+
489+ indicating that the required dependency is missing to use the associated functionality. To install this dependency follow
490+ the provided [ instructions] ( #installing-the-aws-common-runtime-crt-dependency ) .
491+
492+ #### Installing the AWS Common Runtime (CRT) Dependency
493+
494+ You can install the CRT dependency with different commands depending on the package management tool you are using.
495+ If you are using NPM:
496+
497+ ``` console
498+ npm install @aws-sdk/signature-v4-crt
499+ ```
500+
501+ If you are using Yarn:
502+
503+ ``` console
504+ yarn add @aws-sdk/signature-v4-crt
505+ ```
506+
507+ #### Related issues
508+
4715091 . [ S3 Multi-Region Access Point(MRAP) is not available unless with additional dependency] ( https://github.com/aws/aws-sdk-js-v3/issues/2822 )
0 commit comments