Add jslib/aws version variable (#1636)

grafana · Jun 26, 2024 · e4d9c60 · e4d9c60
1 parent 2581401
commit e4d9c60
Show file tree

Hide file tree

Showing 79 changed files with 313 additions and 80 deletions.
diff --git a/docs/sources/_index.md b/docs/sources/_index.md
@@ -19,6 +19,7 @@ cascade:
   github_branch: main
   github_dir: /docs/sources
   replace_dir: docs/k6/
+  JSLIB_AWS_VERSION: 0.12.3
 versioned: true
 versioned_next: true
 ---
diff --git a/docs/sources/next/examples/http-authentication.md b/docs/sources/next/examples/http-authentication.md
@@ -123,7 +123,10 @@ Here's an example script to demonstrate how to sign a request to fetch an object
 
 ```javascript
 import http from 'k6/http';
-import { AWSConfig, SignatureV4 } from 'https://jslib.k6.io/aws/0.12.3/signature.js';
+import {
+  AWSConfig,
+  SignatureV4,
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/signature.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

diff --git a/docs/sources/next/javascript-api/jslib/aws/EventBridgeClient/_index.md b/docs/sources/next/javascript-api/jslib/aws/EventBridgeClient/_index.md
@@ -34,7 +34,10 @@ EventBridgeClient methods will throw errors in case of failure.
 {{< code >}}
 
 ```javascript
-import { AWSConfig, EventBridgeClient } from 'https://jslib.k6.io/aws/0.12.3/event-bridge.js';
+import {
+  AWSConfig,
+  EventBridgeClient,
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/event-bridge.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

diff --git a/docs/sources/next/javascript-api/jslib/aws/EventBridgeClient/putEvents.md b/docs/sources/next/javascript-api/jslib/aws/EventBridgeClient/putEvents.md
@@ -44,7 +44,10 @@ weight: 10
 {{< code >}}
 
 ```javascript
-import { AWSConfig, EventBridgeClient } from 'https://jslib.k6.io/aws/0.12.3/event-bridge.js';
+import {
+  AWSConfig,
+  EventBridgeClient,
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/event-bridge.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

diff --git a/docs/sources/next/javascript-api/jslib/aws/KMSClient/KMSDataKey.md b/docs/sources/next/javascript-api/jslib/aws/KMSClient/KMSDataKey.md
@@ -25,7 +25,10 @@ For instance, the [`generateDataKey`](https://grafana.com/docs/k6/<K6_VERSION>/j
 ```javascript
 import exec from 'k6/execution';
 
-import { AWSConfig, KMSClient } from 'https://jslib.k6.io/aws/0.12.3/kms.js';
+import {
+  AWSConfig,
+  KMSClient,
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/kms.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

diff --git a/docs/sources/next/javascript-api/jslib/aws/KMSClient/KMSKey.md b/docs/sources/next/javascript-api/jslib/aws/KMSClient/KMSKey.md
@@ -22,7 +22,10 @@ weight: 20
 ```javascript
 import exec from 'k6/execution';
 
-import { AWSConfig, KMSClient } from 'https://jslib.k6.io/aws/0.12.3/kms.js';
+import {
+  AWSConfig,
+  KMSClient,
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/kms.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

diff --git a/docs/sources/next/javascript-api/jslib/aws/KMSClient/_index.md b/docs/sources/next/javascript-api/jslib/aws/KMSClient/_index.md
@@ -39,7 +39,10 @@ Both the dedicated `kms.js` jslib bundle and the all-encompassing `aws.js` bundl
 ```javascript
 import { textSummary } from 'https://jslib.k6.io/k6-summary/0.0.2/index.js';
 
-import { AWSConfig, KMSClient } from 'https://jslib.k6.io/aws/0.12.3/kms.js';
+import {
+  AWSConfig,
+  KMSClient,
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/kms.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

diff --git a/docs/sources/next/javascript-api/jslib/aws/KMSClient/generateDataKey.md b/docs/sources/next/javascript-api/jslib/aws/KMSClient/generateDataKey.md
@@ -30,7 +30,10 @@ weight: 10
 ```javascript
 import exec from 'k6/execution';
 
-import { AWSConfig, KMSClient } from 'https://jslib.k6.io/aws/0.12.3/kms.js';
+import {
+  AWSConfig,
+  KMSClient,
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/kms.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

diff --git a/docs/sources/next/javascript-api/jslib/aws/LambdaClient/_index.md b/docs/sources/next/javascript-api/jslib/aws/LambdaClient/_index.md
@@ -33,7 +33,10 @@ Both the dedicated `lambda.js` jslib bundle and the all-encompassing `aws.js` bu
 {{< code >}}
 
 ```javascript
-import { AWSConfig, LambdaClient } from 'https://jslib.k6.io/aws/0.12.3/lambda.js';
+import {
+  AWSConfig,
+  LambdaClient,
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/lambda.js';
 import { check } from 'k6';
 
 const awsConfig = new AWSConfig({

diff --git a/docs/sources/next/javascript-api/jslib/aws/LambdaClient/invoke.md b/docs/sources/next/javascript-api/jslib/aws/LambdaClient/invoke.md
@@ -51,7 +51,10 @@ InvocationResponse is an object that represents the response of an invocation. I
 {{< code >}}
 
 ```javascript
-import { AWSConfig, LambdaClient } from 'https://jslib.k6.io/aws/0.12.3/lambda.js';
+import {
+  AWSConfig,
+  LambdaClient,
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/lambda.js';
 import { check } from 'k6';
 
 const awsConfig = new AWSConfig({

diff --git a/docs/sources/next/javascript-api/jslib/aws/S3Client/Object.md b/docs/sources/next/javascript-api/jslib/aws/S3Client/Object.md
@@ -30,7 +30,7 @@ import {
   // listBuckets,
   AWSConfig,
   S3Client,
-} from 'https://jslib.k6.io/aws/0.12.3/s3.js';
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/s3.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

diff --git a/docs/sources/next/javascript-api/jslib/aws/S3Client/S3MultipartUpload.md b/docs/sources/next/javascript-api/jslib/aws/S3Client/S3MultipartUpload.md
@@ -18,7 +18,10 @@ S3MultipartUpload is returned by the [`createMultipartUpload(bucketName, objectK
 {{< code >}}
 
 ```javascript
-import { AWSConfig, S3Client } from 'https://jslib.k6.io/aws/0.12.3/s3.js';
+import {
+  AWSConfig,
+  S3Client,
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/s3.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

diff --git a/docs/sources/next/javascript-api/jslib/aws/S3Client/S3Part.md b/docs/sources/next/javascript-api/jslib/aws/S3Client/S3Part.md
@@ -23,7 +23,10 @@ S3Part is returned by the [`uploadPart(bucketName, objectKey, uploadId, partNumb
 import crypto from 'k6/crypto';
 import exec from 'k6/execution';
 
-import { AWSConfig, S3Client } from 'https://jslib.k6.io/aws/0.12.3/s3.js';
+import {
+  AWSConfig,
+  S3Client,
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/s3.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

diff --git a/docs/sources/next/javascript-api/jslib/aws/S3Client/_index.md b/docs/sources/next/javascript-api/jslib/aws/S3Client/_index.md
@@ -49,7 +49,10 @@ import { check } from 'k6';
 import exec from 'k6/execution';
 import http from 'k6/http';
 
-import { AWSConfig, S3Client } from 'https://jslib.k6.io/aws/0.12.3/s3.js';
+import {
+  AWSConfig,
+  S3Client,
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/s3.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,
@@ -111,7 +114,10 @@ export async function handleSummary(data) {
 import crypto from 'k6/crypto';
 import exec from 'k6/execution';
 
-import { AWSConfig, S3Client } from 'https://jslib.k6.io/aws/0.12.3/s3.js';
+import {
+  AWSConfig,
+  S3Client,
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/s3.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

diff --git a/docs/sources/next/javascript-api/jslib/aws/S3Client/completeMultipartUpload.md b/docs/sources/next/javascript-api/jslib/aws/S3Client/completeMultipartUpload.md
@@ -32,7 +32,10 @@ weight: 10
 import crypto from 'k6/crypto';
 import exec from 'k6/execution';
 
-import { AWSConfig, S3Client } from 'https://jslib.k6.io/aws/0.12.3/s3.js';
+import {
+  AWSConfig,
+  S3Client,
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/s3.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

diff --git a/docs/sources/next/javascript-api/jslib/aws/S3Client/copyObject.md b/docs/sources/next/javascript-api/jslib/aws/S3Client/copyObject.md
@@ -31,7 +31,10 @@ weight: 10
 ```javascript
 import exec from 'k6/execution';
 
-import { AWSConfig, S3Client } from 'https://jslib.k6.io/aws/0.12.3/s3.js';
+import {
+  AWSConfig,
+  S3Client,
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/s3.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

diff --git a/docs/sources/next/javascript-api/jslib/aws/S3Client/createMultipartUpload.md b/docs/sources/next/javascript-api/jslib/aws/S3Client/createMultipartUpload.md
@@ -25,7 +25,10 @@ weight: 10
 {{< code >}}
 
 ```javascript
-import { AWSConfig, S3Client } from 'https://jslib.k6.io/aws/0.12.3/s3.js';
+import {
+  AWSConfig,
+  S3Client,
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/s3.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

diff --git a/docs/sources/next/javascript-api/jslib/aws/S3Client/deleteObject.md b/docs/sources/next/javascript-api/jslib/aws/S3Client/deleteObject.md
@@ -29,7 +29,10 @@ weight: 10
 ```javascript
 import exec from 'k6/execution';
 
-import { AWSConfig, S3Client } from 'https://jslib.k6.io/aws/0.12.3/s3.js';
+import {
+  AWSConfig,
+  S3Client,
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/s3.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

diff --git a/docs/sources/next/javascript-api/jslib/aws/S3Client/getObject.md b/docs/sources/next/javascript-api/jslib/aws/S3Client/getObject.md
@@ -29,7 +29,10 @@ weight: 10
 ```javascript
 import exec from 'k6/execution';
 
-import { AWSConfig, S3Client } from 'https://jslib.k6.io/aws/0.12.3/s3.js';
+import {
+  AWSConfig,
+  S3Client,
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/s3.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

diff --git a/docs/sources/next/javascript-api/jslib/aws/S3Client/listBuckets.md b/docs/sources/next/javascript-api/jslib/aws/S3Client/listBuckets.md
@@ -22,7 +22,10 @@ weight: 10
 ```javascript
 import exec from 'k6/execution';
 
-import { AWSConfig, S3Client } from 'https://jslib.k6.io/aws/0.12.3/s3.js';
+import {
+  AWSConfig,
+  S3Client,
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/s3.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

diff --git a/docs/sources/next/javascript-api/jslib/aws/S3Client/listObjects.md b/docs/sources/next/javascript-api/jslib/aws/S3Client/listObjects.md
@@ -29,7 +29,10 @@ weight: 10
 ```javascript
 import exec from 'k6/execution';
 
-import { AWSConfig, S3Client } from 'https://jslib.k6.io/aws/0.12.3/s3.js';
+import {
+  AWSConfig,
+  S3Client,
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/s3.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

diff --git a/docs/sources/next/javascript-api/jslib/aws/S3Client/putObject.md b/docs/sources/next/javascript-api/jslib/aws/S3Client/putObject.md
@@ -39,7 +39,10 @@ weight: 10
 {{< code >}}
 
 ```javascript
-import { AWSConfig, S3Client } from 'https://jslib.k6.io/aws/0.12.3/s3.js';
+import {
+  AWSConfig,
+  S3Client,
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/s3.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

diff --git a/docs/sources/next/javascript-api/jslib/aws/S3Client/uploadPart.md b/docs/sources/next/javascript-api/jslib/aws/S3Client/uploadPart.md
@@ -31,7 +31,10 @@ weight: 10
 import crypto from 'k6/crypto';
 import exec from 'k6/execution';
 
-import { AWSConfig, S3Client } from 'https://jslib.k6.io/aws/0.12.3/s3.js';
+import {
+  AWSConfig,
+  S3Client,
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/s3.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

diff --git a/docs/sources/next/javascript-api/jslib/aws/SQSClient/_index.md b/docs/sources/next/javascript-api/jslib/aws/SQSClient/_index.md
@@ -37,7 +37,10 @@ With it, the user can send messages to specified queues and list available queue
 ```javascript
 import exec from 'k6/execution';
 
-import { AWSConfig, SQSClient } from 'https://jslib.k6.io/aws/0.12.3/sqs.js';
+import {
+  AWSConfig,
+  SQSClient,
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/sqs.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

diff --git a/docs/sources/next/javascript-api/jslib/aws/SQSClient/listQueues.md b/docs/sources/next/javascript-api/jslib/aws/SQSClient/listQueues.md
@@ -29,7 +29,10 @@ weight: 10
 ```javascript
 import exec from 'k6/execution';
 
-import { AWSConfig, SQSClient } from 'https://jslib.k6.io/aws/0.12.3/sqs.js';
+import {
+  AWSConfig,
+  SQSClient,
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/sqs.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

diff --git a/docs/sources/next/javascript-api/jslib/aws/SQSClient/sendMessage.md b/docs/sources/next/javascript-api/jslib/aws/SQSClient/sendMessage.md
@@ -40,7 +40,10 @@ weight: 10
 ```javascript
 import exec from 'k6/execution';
 
-import { AWSConfig, SQSClient } from 'https://jslib.k6.io/aws/0.12.3/sqs.js';
+import {
+  AWSConfig,
+  SQSClient,
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/sqs.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

diff --git a/docs/sources/next/javascript-api/jslib/aws/SecretsManagerClient/Secret.md b/docs/sources/next/javascript-api/jslib/aws/SecretsManagerClient/Secret.md
@@ -28,7 +28,10 @@ Secret is returned by the SecretsManagerClient.\* methods that query secrets. Na
 ```javascript
 import exec from 'k6/execution';
 
-import { AWSConfig, SecretsManagerClient } from 'https://jslib.k6.io/aws/0.12.3/secrets-manager.js';
+import {
+  AWSConfig,
+  SecretsManagerClient,
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/secrets-manager.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

diff --git a/docs/sources/next/javascript-api/jslib/aws/SecretsManagerClient/_index.md b/docs/sources/next/javascript-api/jslib/aws/SecretsManagerClient/_index.md
@@ -39,7 +39,10 @@ S3 Client methods will throw errors in case of failure.
 ```javascript
 import exec from 'k6/execution';
 
-import { AWSConfig, SecretsManagerClient } from 'https://jslib.k6.io/aws/0.12.3/secrets-manager.js';
+import {
+  AWSConfig,
+  SecretsManagerClient,
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/secrets-manager.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

diff --git a/docs/sources/next/javascript-api/jslib/aws/SecretsManagerClient/createSecret.md b/docs/sources/next/javascript-api/jslib/aws/SecretsManagerClient/createSecret.md
@@ -30,7 +30,10 @@ weight: 10
 {{< code >}}
 
 ```javascript
-import { AWSConfig, SecretsManagerClient } from 'https://jslib.k6.io/aws/0.12.3/secrets-manager.js';
+import {
+  AWSConfig,
+  SecretsManagerClient,
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/secrets-manager.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

diff --git a/docs/sources/next/javascript-api/jslib/aws/SecretsManagerClient/deleteSecret.md b/docs/sources/next/javascript-api/jslib/aws/SecretsManagerClient/deleteSecret.md
@@ -27,7 +27,10 @@ weight: 10
 {{< code >}}
 
 ```javascript
-import { AWSConfig, SecretsManagerClient } from 'https://jslib.k6.io/aws/0.12.3/secrets-manager.js';
+import {
+  AWSConfig,
+  SecretsManagerClient,
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/secrets-manager.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

diff --git a/docs/sources/next/javascript-api/jslib/aws/SecretsManagerClient/getSecret.md b/docs/sources/next/javascript-api/jslib/aws/SecretsManagerClient/getSecret.md
@@ -26,7 +26,10 @@ weight: 10
 ```javascript
 import exec from 'k6/execution';
 
-import { AWSConfig, SecretsManagerClient } from 'https://jslib.k6.io/aws/0.12.3/secrets-manager.js';
+import {
+  AWSConfig,
+  SecretsManagerClient,
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/secrets-manager.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

diff --git a/docs/sources/next/javascript-api/jslib/aws/SecretsManagerClient/listSecrets.md b/docs/sources/next/javascript-api/jslib/aws/SecretsManagerClient/listSecrets.md
@@ -22,7 +22,10 @@ weight: 10
 ```javascript
 import exec from 'k6/execution';
 
-import { AWSConfig, SecretsManagerClient } from 'https://jslib.k6.io/aws/0.12.3/secrets-manager.js';
+import {
+  AWSConfig,
+  SecretsManagerClient,
+} from 'https://jslib.k6.io/aws/{{< param "JSLIB_AWS_VERSION" >}}/secrets-manager.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,