Skip to content

Commit 4c57921

Browse files
committed
Document AWS synchronous behavior and performance considerations
1 parent 8405f48 commit 4c57921

File tree

5 files changed

+11
-1
lines changed

5 files changed

+11
-1
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: 'KMSClient allows interacting with the AWS Key Management Service'
55
excerpt: 'KMSClient allows interacting with the AWS Key Management Service'
66
---
77

8+
<BlockingAwsBlockquote />
9+
810
`KMSClient` interacts with the AWS Key Management Service.
911
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.
1012

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: 'S3Client allows interacting with AWS S3 buckets and objects'
55
excerpt: 'S3Client class allows interacting with AWS S3 buckets and objects'
66
---
77

8+
<BlockingAwsBlockquote />
9+
810
S3Client allows interacting with AWS S3's buckets and objects. Namely, it allows the user to list buckets and the objects they contain, as well as download, uploading, and deleting objects. The S3Client operations are blocking, and we recommend reserving their usage to the [`setup`](/using-k6/test-lifecycle/) and [`teardown`](/using-k6/test-lifecycle/) functions as much as possible.
911

1012
S3Client is included in both the dedicated jslib `s3.js` bundle, and the `aws.js` one, containing all the services clients.

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ description: 'SQSClient enables interaction with the AWS Simple Queue Service (S
55
excerpt: 'SQSClient allows interacting with the AWS Simple Queue Service (SQS)'
66
---
77

8-
`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.
8+
<BlockingAwsBlockquote />
9+
10+
`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.
911

1012
Both the dedicated `sqs.js` jslib bundle and the all-encompassing `aws.js` bundle include the `SQSClient`.
1113

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: 'SecretsManagerClient allows interacting with AWS secrets stored in
55
excerpt: 'SecretsManagerClient allows interacting with AWS secrets stored in Secrets Manager'
66
---
77

8+
<BlockingAwsBlockquote />
9+
810
SecretsManagerClient allows interacting with secrets stored in AWS's Secrets Manager. Namely, it allows the user to list, download, create, modify and delete secrets. Note that the SecretsManagerClient operations are blocking, and we recommend reserving their usage to the [`setup`](/using-k6/test-lifecycle/) and [`teardown`](/using-k6/test-lifecycle/) functions as much as possible.
911

1012
SecretsManagerClient is included in both the dedicated jslib `secrets-manager.js` bundle, and the `aws.js` one, containing all the services clients.

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: 'SystemsManagerClient allows interacting with the AWS Systems Manag
55
excerpt: 'SystemsManagerClient allows interacting with the AWS Systems Manager Service'
66
---
77

8+
<BlockingAwsBlockquote />
9+
810
`SystemsManagerClient` interacts with the AWS Systems Manager Service.
911
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.
1012

0 commit comments

Comments
 (0)