Skip to content

Commit 35d7152

Browse files
oleiadeoleiade
authored
Merge pull request #1453 from grafana/fix/jslib-aws-signature
Fix jslib-aws links & general improvements to that specific section
2 parents 40eae76 + a6a6da0 commit 35d7152

File tree

140 files changed

+3433
-3507
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

140 files changed

+3433
-3507
lines changed

‎docs/sources/next/javascript-api/jslib/aws/EventBridgeClient/putEvents.md‎

Lines changed: 30 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,43 @@
11
---
2-
title: 'EventBridgeClient.putEvents'
2+
title: 'putEvents'
33
head_title: 'EventBridgeClient.putEvents'
4-
slug: 'eventbridgeclient-putevents'
54
description: 'EventBridgeClient.putEvents sends custom events to Amazon EventBridge'
65
excerpt: 'EventBridgeClient.putEvents sends custom events to Amazon EventBridge'
6+
weight: 10
77
---
88

9-
# EventBridgeClient.putEvents
9+
# putEvents
1010

1111
`EventBridgeClient.putEvents` sends custom events to Amazon EventBridge so that they can be matched to rules.
1212

1313
### Parameters
1414

15-
| Parameter | Type | Description |
16-
| :------------ | :-------------- | :----------------------------------------------------------------------------------------------------------------------- |
17-
| input | [PutEventsInput](#puteventsinput) | An array of objects representing events to be submitted. |
15+
| Parameter | Type | Description |
16+
| :-------- | :-------------------------------- | :------------------------------------------------------- |
17+
| input | [PutEventsInput](#puteventsinput) | An array of objects representing events to be submitted. |
1818

1919
#### PutEventsInput
2020

21-
| Parameter | Type | Description |
22-
| :-------- | :-------------- | :----------------------------------------------------------------------------------------------------------------------- |
23-
| Entries | [EventBridgeEntry](#eventbridgeentry)[] | An array of objects representing events to be submitted. |
24-
| EndpointId | string (optional) | The ID of the target to receive the event. |
21+
| Parameter | Type | Description |
22+
| :--------- | :-------------------------------------- | :------------------------------------------------------- |
23+
| Entries | [EventBridgeEntry](#eventbridgeentry)[] | An array of objects representing events to be submitted. |
24+
| EndpointId | string (optional) | The ID of the target to receive the event. |
2525

2626
#### EventBridgeEntry
2727

28-
| Parameter | Type | Description |
29-
| :-------- | :----- | :----------------------------------------------------------------------------------------------------------------------- |
30-
| Source | string | The source of the event. |
31-
| Detail | object | A JSON object containing event data. |
32-
| DetailType | string | Free-form string used to decide what fields to expect in the event detail. |
33-
| Resources | string[] (optional) | AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. |
34-
| EventBusName | string (optional) | The event bus that will receive the event. If you omit this, the default event bus is used. Only the AWS account that owns a bus can write to it. |
35-
28+
| Parameter | Type | Description |
29+
| :----------- | :------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------ |
30+
| Source | string | The source of the event. |
31+
| Detail | object | A JSON object containing event data. |
32+
| DetailType | string | Free-form string used to decide what fields to expect in the event detail. |
33+
| Resources | string[] (optional) | AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. |
34+
| EventBusName | string (optional) | The event bus that will receive the event. If you omit this, the default event bus is used. Only the AWS account that owns a bus can write to it. |
3635

3736
### Returns
3837

39-
| Type | Description |
40-
| :-------------- | :---------------------------------------------------------------------------------- |
41-
| `Promise<void>` | A Promise that fulfills when the events have been sent to Amazon EventBridge. |
38+
| Type | Description |
39+
| :-------------- | :---------------------------------------------------------------------------- |
40+
| `Promise<void>` | A Promise that fulfills when the events have been sent to Amazon EventBridge. |
4241

4342
### Example
4443

@@ -56,19 +55,19 @@ const awsConfig = new AWSConfig({
5655

5756
const eventBridge = new EventBridgeClient(awsConfig);
5857
const eventEntry = {
59-
Source: "my.source",
60-
Detail: {
61-
key: "value"
62-
},
63-
DetailType: "MyDetailType",
64-
Resources: ["resource-arn"],
58+
Source: 'my.source',
59+
Detail: {
60+
key: 'value',
61+
},
62+
DetailType: 'MyDetailType',
63+
Resources: ['resource-arn'],
6564
};
6665

6766
export default async function () {
68-
await eventBridge.putEvents({
69-
Entries: [eventEntry]
70-
});
67+
await eventBridge.putEvents({
68+
Entries: [eventEntry],
69+
});
7170
}
7271
```
7372

74-
{{< /code >}}
73+
{{< /code >}}

docs/sources/v0.48.x/javascript-api/jslib/aws/KMSClient/90 KMSDataKey.md renamed to docs/sources/next/javascript-api/jslib/aws/KMSClient/KMSDataKey.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ title: 'KMSDataKey'
33
slug: 'kmsdatakey'
44
head_title: 'KMSDataKey'
55
description: 'KMSDataKey is returned by the KMSClient.*DataKey methods that query KMS data keys'
6+
weight: 20
67
---
78

89
# KMSDataKey
@@ -11,10 +12,10 @@ description: 'KMSDataKey is returned by the KMSClient.*DataKey methods that quer
1112
The KMSDataKey object describes an Amazon Key Management Service data key.
1213
For instance, the [`generateDataKey`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/jslib/aws/kmsclient/kmsclient-generatedatakey/) returns the generated KMSDataKey object.
1314

14-
| Name | Type | Description |
15-
| :-------------------------- | :----- | :------------------------------------------------------------------------------------------------------------------------------ |
16-
| `KMSDataKey.id` | string | The identifier of the Key Management Service key that encrypted the data key. |
17-
| `KMSDataKey.ciphertextBlob` | string | The base64-encoded encrypted copy of the data key. |
15+
| Name | Type | Description |
16+
| :-------------------------- | :----- | :-------------------------------------------------------------------------------------------------------------------------------------------------- |
17+
| `KMSDataKey.id` | string | The identifier of the Key Management Service key that encrypted the data key. |
18+
| `KMSDataKey.ciphertextBlob` | string | The base64-encoded encrypted copy of the data key. |
1819
| `KMSDataKey.plaintext` | string | The plain text data key. Use this data key to encrypt your data outside of Key Management Service. Then, remove it from memory as soon as possible. |
1920

2021
### Example
@@ -53,4 +54,3 @@ export default async function () {
5354
_A k6 script that generating a data key from an AWS Key Management Service key_
5455

5556
{{< /code >}}
56-

docs/sources/v0.47.x/javascript-api/jslib/aws/KMSClient/90 KMSKey.md renamed to docs/sources/next/javascript-api/jslib/aws/KMSClient/KMSKey.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
title: 'KMSKey'
3-
slug: 'kmskey'
43
head_title: 'KMSKey'
54
description: 'KMSKey is returned by the KMSClient.* methods that query KMS keys'
65
excerpt: 'KMSKey is returned by the KMSClient.* methods that query KMS keys'
6+
weight: 20
77
---
88

99
# KMSKey
@@ -47,4 +47,4 @@ export default async function () {
4747

4848
_A k6 script querying the user's Key Management Service keys and verifying their test key exists_
4949

50-
{{< /code >}}
50+
{{< /code >}}

‎docs/sources/next/javascript-api/jslib/aws/KMSClient/_index.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ Both the dedicated `kms.js` jslib bundle and the all-encompassing `aws.js` bundl
1818

1919
### Methods
2020

21-
| Function | Description |
22-
| :-------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------- |
23-
| [listKeys](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/jslib/aws/kmsclient/00 listkeys) | List the all the Key Management Service keys in the caller's AWS account and region. |
24-
| [generateDataKey](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/jslib/aws/kmsclient/00 generateDataKey) | Generate a symmetric data key for use outside of the AWS Key Management Service. |
21+
| Function | Description |
22+
| :------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------- |
23+
| [listKeys](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/jslib/aws/kmsclient/listkeys) | List the all the Key Management Service keys in the caller's AWS account and region. |
24+
| [generateDataKey](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/jslib/aws/kmsclient/generatedatakey) | Generate a symmetric data key for use outside of the AWS Key Management Service. |
2525

2626
### Throws
2727

@@ -63,7 +63,7 @@ export default async function (data) {
6363

6464
export function handleSummary(data) {
6565
return {
66-
stdout: textSummary(data, { indent: ' ', enableColors: true }),
66+
'stdout': textSummary(data, { indent: ' ', enableColors: true }),
6767
'./test-run.key': data.dataKey,
6868
};
6969
}

docs/sources/next/javascript-api/jslib/aws/KMSClient/00 generateDataKey.md renamed to docs/sources/next/javascript-api/jslib/aws/KMSClient/generateDataKey.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
11
---
2-
title: 'KMSClient.generateDataKey'
2+
title: 'generateDataKey'
33
head_title: 'KMSClient.generateDataKey'
4-
slug: 'kmsclient-generatedatakey'
54
description: 'KMSClient.generateDataKey generates a symmetric data key for use outside of the AWS Key Management Service'
65
excerpt: 'KMSClient.generateDataKey generates a symmetric data key for use outside of the AWS Key Management Service'
6+
weight: 10
77
---
88

9-
# KMSClient.generateDataKey
9+
# generateDataKey
1010

1111
`KMSClient.generateDataKey` generates a symmetric data key for use outside of the AWS Key Management Service.
1212

1313
### Parameters
1414

15-
| Name | Type | Description |
16-
| :--- | :----- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15+
| Name | Type | Description |
16+
| :----- | :----- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1717
| `id` | string | The identifier of the key. This can be either the key ID or the Amazon Resource Name (ARN) of the key. |
1818
| `size` | number | The length of the data key. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For 256-bit (32-byte) data keys, use the value 32, instead. |
1919

2020
### Returns
2121

22-
| Type | Description |
23-
| :-------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------- |
22+
| Type | Description |
23+
| :------------------------------------------------------------------------------------------------------------ | :-------------------------------------------------------------------------------------------------------------------------------------- |
2424
| Promise<[KMSDataKey](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/jslib/aws/kmsclient/kmsdatakey)> | A Promise that fulfills with a [KMSDataKey](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/jslib/aws/kmsclient/kmskey) object. |
2525

2626
### Example
@@ -59,5 +59,3 @@ export default async function () {
5959
_A k6 script that generating a data key from an AWS Key Management Service key_
6060

6161
{{< /code >}}
62-
63-

docs/sources/v0.47.x/javascript-api/jslib/aws/KMSClient/00 listKeys.md renamed to docs/sources/next/javascript-api/jslib/aws/KMSClient/listKeys.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
---
2-
title: 'KMSClient.listKeys()'
2+
title: 'listKeys'
33
head_title: 'KMSClient.listKeys()'
4-
slug: 'kmsclient-listkeys'
54
description: "KMSClient.listKeys lists all the KMS keys in the caller's AWS account and region"
65
excerpt: "KMSClient.listKeys lists all the KMS keys in the caller's AWS account and region"
6+
weight: 10
77
---
88

9-
# KMSClient.listKeys()
9+
# listKeys
1010

1111
`KMSClient.listKeys()` lists all the Key Management Service keys in the caller's AWS account and region.
1212

1313
### Returns
1414

15-
| Type | Description |
16-
| :-------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------- |
15+
| Type | Description |
16+
| :------------------------------------------------------------------------------------------------------ | :----------------------------------------------------------------------------------------------------------------------------------------------- |
1717
| Promise<[KMSKey[]](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/jslib/aws/kmsclient/kmskey)> | A Promise that fulfills with an array of [`KMSKey`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/jslib/aws/kmsclient/kmskey) objects. |
1818

1919
### Example
@@ -49,5 +49,3 @@ export default async function () {
4949
_A k6 script querying the user's Key Management Service keys and verifying their test key exists_
5050

5151
{{< /code >}}
52-
53-

‎docs/sources/next/javascript-api/jslib/aws/S3Client/00 abortMultipartUpload(bucketName, objectKey, uploadId).md‎

Lines changed: 0 additions & 56 deletions
This file was deleted.

0 commit comments

Comments
 (0)