Merge pull request #1140 from grafana/aws/v0.7.2

Update documentation to reflect changes in aws v0.7.2

Author: oleiade

src/data/markdown/docs/20 jslib/01 jslib/01 aws.md

@@ -4,25 +4,26 @@ excerpt: "aws is a library implementing APIs for accessing a selection of AWS se
 description: "aws is a library implementing APIs for accessing a selection of AWS servicese"
 ---
 
-The `aws` module is a JavaScript library that wraps around some Amazon AWS services API. 
+The `aws` module is a JavaScript library that wraps around some Amazon AWS services API.
 
 The library exposes a couple of configuration and client classes allowing to interact with a subset of AWS services in the context of k6 load test scripts:
 - [S3Client](/javascript-api/jslib/aws/s3client): a class to list S3 buckets and the objects they contain, as well as uploading, downloading and deleting objects from them.
 - [SecretsManagerClient](/javascript-api/jslib/aws/secretsmanagerclient): a class to list, get, create, update, and delete secrets from the AWS secrets manager service.
 - [KMSClient](/javascript-api/jslib/aws/kmsclient): a class to list and generate keys from the AWS Key Management Service.
 - [SystemsManagerClient](/javascript-api/jslib/aws/systemsmanagerclient): a class to fetch parameters from the AWS Systems Manager Service.
+- [SQSClient](/javascript-api/jslib/aws/sqsclient): a class to list and send messages to SQS queues.
 - [SignatureV4](/javascript-api/jslib/aws/signaturev4): a class to sign and pre-sign requests to AWS services using the [Signature V4](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) algorithm.
 - [AWSConfig](/javascript-api/jslib/aws/awsconfig/): a class is used by each client classes to provide them access to AWS credentials as well as configuration.
 
-> ⭐️ Source code available on [GitHub](https://github.com/grafana/k6-jslib-aws). 
+> ⭐️ Source code available on [GitHub](https://github.com/grafana/k6-jslib-aws).
 > Please request features and report bugs through [GitHub issues](https://github.com/grafana/k6-jslib-aws/issues).
 
 
 <Blockquote mod='info'>
 
 #### This library is in active development
 
-This library is stable enough to be useful, but pay attention to the new versions released on [jslib.k6.io](https://jslib.k6.io) and [k6-jslib-aws/releases](https://github.com/grafana/k6-jslib-aws/releases).   
+This library is stable enough to be useful, but pay attention to the new versions released on [jslib.k6.io](https://jslib.k6.io) and [k6-jslib-aws/releases](https://github.com/grafana/k6-jslib-aws/releases).
 
 This documentation is for the last version only. If you discover that some code below does not work, it most likely means that you are using an older version.
 
@@ -35,5 +36,6 @@ This documentation is for the last version only. If you discover that some code
 | [S3Client](/javascript-api/jslib/aws/s3client)                         | Client class to interact with AWS S3 buckets and objects.            |
 | [SecretsManager](/javascript-api/jslib/aws/secretsmanagerclient)       | Client class to interact with AWS secrets stored in Secrets Manager. |
 | [KMSClient](/javascript-api/jslib/aws/kmsclient)                       | Client class to interact with AWS Key Management Service.            |
+| [SQSClient](/javascript-api/jslib/aws/sqsclient)                       | Client class to interact with AWS Simple Queue Service.              |
 | [SystemsManagerClient](/javascript-api/jslib/aws/systemsmanagerclient) | Client class to interact with AWS Systems Manager Service.           |
 | [AWSConfig](/javascript-api/jslib/aws/awsconfig)                       | Class to configure AWS client classes.                               |

src/data/markdown/docs/20 jslib/01 jslib/01 aws/01 S3Client.md

@@ -37,7 +37,7 @@ import { check } from 'k6';
 import exec from 'k6/execution';
 import http from 'k6/http';
 
-import { AWSConfig, S3Client } from 'https://jslib.k6.io/aws/0.7.1/s3.js';
+import { AWSConfig, S3Client } from 'https://jslib.k6.io/aws/0.7.2/s3.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

src/data/markdown/docs/20 jslib/01 jslib/01 aws/02 SecretsManagerClient.md

@@ -35,7 +35,7 @@ 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.7.1/secrets-manager.js';
+import { AWSConfig, SecretsManagerClient } from 'https://jslib.k6.io/aws/0.7.2/secrets-manager.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

src/data/markdown/docs/20 jslib/01 jslib/01 aws/03 KMSClient.md

@@ -8,7 +8,7 @@ excerpt: 'KMSClient allows interacting with the AWS Key Management Service'
 `KMSClient` interacts with the AWS Key Management Service.
 With it, the user can list all the Key Management Service keys in the caller's AWS account and region. They can also generate symmetric data keys to use outside of AWS Key Management Service. `KMSClient` operations are blocking. k6 recommends reserving their use to the [`setup`](/using-k6/test-lifecycle/) and [`teardown`](/using-k6/test-lifecycle/) stages as much as possible.
 
-Both the dedicated `kms.js` jslib bundle and the all-encompassing `aws.js` bundle include the `KMSClient`. 
+Both the dedicated `kms.js` jslib bundle and the all-encompassing `aws.js` bundle include the `KMSClient`.
 
 ### Methods
 
@@ -33,7 +33,7 @@ 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.7.1/kms.js';
+import { AWSConfig, KMSClient } from 'https://jslib.k6.io/aws/0.7.2/kms.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

src/data/markdown/docs/20 jslib/01 jslib/01 aws/04 SystemsManagerClient.md

@@ -8,7 +8,7 @@ excerpt: 'SystemsManagerClient allows interacting with the AWS Systems Manager S
 `SystemsManagerClient` interacts with the AWS Systems Manager Service.
 With it, the user can get parameters from the Systems Manager Service in the caller's AWS account and region. `SystemsManagerClient` operations are blocking. k6 recommends reserving their use to the [`setup`](/using-k6/test-lifecycle/) and [`teardown`](/using-k6/test-lifecycle/) stages as much as possible.
 
-Both the dedicated `ssm.js` jslib bundle and the all-encompassing `aws.js` bundle include the `SystemsManagerClient`. 
+Both the dedicated `ssm.js` jslib bundle and the all-encompassing `aws.js` bundle include the `SystemsManagerClient`.
 
 ### Methods
 
@@ -32,7 +32,7 @@ Both the dedicated `ssm.js` jslib bundle and the all-encompassing `aws.js` bundl
 ```javascript
 import exec from 'k6/execution';
 
-import { AWSConfig, SystemsManagerClient } from 'https://jslib.k6.io/aws/0.7.1/ssm.js';
+import { AWSConfig, SystemsManagerClient } from 'https://jslib.k6.io/aws/0.7.2/ssm.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

src/data/markdown/docs/20 jslib/01 jslib/01 aws/05 AwsConfig.md

@@ -18,6 +18,12 @@ It takes an options object as its single parameter, with the following propertie
 | secretAccessKey            | string | The AWS secret access credential to use for authentication.                                                               |
 | sessionToken (optional)    | string | The AWS secret access token to use for authentication.                                                               |
 
+### Methods
+
+| Name                | Description                                                                                                                                |
+| :------------------ | :----------------------------------------------------------------------------------------------------------------------------------------- |
+| `fromEnvironment()` | Creates an `AWSConfig` using the `AWS_REGION`, `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_SESSION_TOKEN` environment variables. |
+
 ### Throws
 
 S3 Client methods will throw errors in case of failure.
@@ -35,7 +41,7 @@ import exec from 'k6/execution';
 
 // Note that you AWSConfig is also included in the dedicated service
 // client bundles such as `s3.js` and `secrets-manager.js`
-import { AWSConfig, SecretsManagerClient } from 'https://jslib.k6.io/aws/0.7.1/aws.js';
+import { AWSConfig, SecretsManagerClient } from 'https://jslib.k6.io/aws/0.7.2/aws.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

src/data/markdown/docs/20 jslib/01 jslib/01 aws/06 SignatureV4.md

@@ -10,7 +10,7 @@ The `presign` operation produces a pre-signed request with authorization informa
 
 SignatureV4 is included in both the dedicated jslib `signature.js` bundle and the `aws.js` one, containing all the service's clients.
 
-Instantiating a new `SignatureV4` requires a single options object argument with the following properties: 
+Instantiating a new `SignatureV4` requires a single options object argument with the following properties:
 
 | Property      | Type                                                                                      | Description                                                                                                                                                                                                                                                             |
 | :------------ | :---------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -44,7 +44,7 @@ SignatureV4 methods throw errors on failure.
 ```javascript
 import http from 'k6/http.js'
 
-import { AWSConfig, SignatureV4 } from 'https://jslib.k6.io/aws/0.7.1/aws.js'
+import { AWSConfig, SignatureV4 } from 'https://jslib.k6.io/aws/0.7.2/aws.js'
 
 const awsConfig = new AWSConfig({
     region: __ENV.AWS_REGION,

src/data/markdown/docs/20 jslib/01 jslib/01 aws/07 SQSClient.md

@@ -0,0 +1,59 @@
+---
+title: 'SQSClient'
+head_title: 'SQSClient'
+description: 'SQSClient enables interaction with the AWS Simple Queue Service (SQS)'
+excerpt: 'SQSClient allows interacting with the AWS Simple Queue Service (SQS)'
+---
+
+`SQSClient` interacts with the AWS Simple Queue Service (SQS). With it, the user can send messages to specified queues and list available queues in the current region. `SQSClient` operations are blocking. k6 recommends reserving their use for the [`setup`](/using-k6/test-lifecycle/) and [`teardown`](/using-k6/test-lifecycle/) stages as much as possible.
+
+Both the dedicated `sqs.js` jslib bundle and the all-encompassing `aws.js` bundle include the `SQSClient`.
+
+### Methods
+
+| Function                                                         | Description                                          |
+| :--------------------------------------------------------------- | :--------------------------------------------------- |
+| [`sendMessage`](/javascript-api/jslib/aws/sqsclient/sqsclient-sendmessage) | Delivers a message to the specified queue.           |
+| [`listQueues`](/javascript-api/jslib/aws/sqsclient/sqsclient-listqueues)   | Returns a list of your queues in the current region. |
+
+### Throws
+
+`SQSClient` methods throw errors in case of failure.
+
+| Error                   | Condition                                                 |
+| :---------------------- | :-------------------------------------------------------- |
+| `InvalidSignatureError` | when using invalid credentials                            |
+| `SQSServiceError`       | when AWS replied to the requested operation with an error |
+
+### Example
+
+<CodeGroup labels={[]}>
+
+```javascript
+import exec from 'k6/execution'
+
+import { AWSConfig, SQSClient } from 'https://jslib.k6.io/aws/0.7.2/sqs.js'
+
+const awsConfig = new AWSConfig({
+    region: __ENV.AWS_REGION,
+    accessKeyId: __ENV.AWS_ACCESS_KEY_ID,
+    secretAccessKey: __ENV.AWS_SECRET_ACCESS_KEY,
+    sessionToken: __ENV.AWS_SESSION_TOKEN,
+})
+
+const sqs = new SQSClient(awsConfig)
+const testQueue = 'https://sqs.us-east-1.amazonaws.com/000000000/test-queue'
+
+export default function () {
+    // If our test queue does not exist, abort the execution.
+    const queuesResponse = sqs.listQueues()
+    if (queuesResponse.queueUrls.filter((q) => q === testQueue).length == 0) {
+        exec.test.abort()
+    }
+
+    // Send message to test queue
+    sqs.sendMessage(testQueue, JSON.stringify({value: '123'}));
+}
+```
+
+</CodeGroup>

src/data/markdown/docs/20 jslib/01 jslib/01 aws/KMSClient/01 listKeys.md

@@ -19,7 +19,7 @@ excerpt: "KMSClient.listKeys lists all the KMS keys in the caller's AWS account
 ```javascript
 import exec from 'k6/execution';
 
-import { AWSConfig, KMSClient } from 'https://jslib.k6.io/aws/0.7.1/kms.js';
+import { AWSConfig, KMSClient } from 'https://jslib.k6.io/aws/0.7.2/kms.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,

src/data/markdown/docs/20 jslib/01 jslib/01 aws/KMSClient/02 generateDataKey.md

@@ -26,7 +26,7 @@ excerpt: 'KMSClient.generateDataKey generates a symmetric data key for use outsi
 ```javascript
 import exec from 'k6/execution';
 
-import { AWSConfig, KMSClient } from 'https://jslib.k6.io/aws/0.7.1/kms.js';
+import { AWSConfig, KMSClient } from 'https://jslib.k6.io/aws/0.7.2/kms.js';
 
 const awsConfig = new AWSConfig({
   region: __ENV.AWS_REGION,