Skip to content

Commit f945178

Browse files
oleiadeoleiade
committed
Fix v0.48.x aws links
1 parent 31ca32e commit f945178

Some content is hidden

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

47 files changed

+1101
-1170
lines changed

‎docs/sources/v0.48.x/javascript-api/jslib/aws/EventBridgeClient/putEvents.md‎

Lines changed: 28 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
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'
76
---
@@ -12,33 +11,32 @@ excerpt: 'EventBridgeClient.putEvents sends custom events to Amazon EventBridge'
1211

1312
### Parameters
1413

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

1918
#### PutEventsInput
2019

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. |
20+
| Parameter | Type | Description |
21+
| :--------- | :-------------------------------------- | :------------------------------------------------------- |
22+
| Entries | [EventBridgeEntry](#eventbridgeentry)[] | An array of objects representing events to be submitted. |
23+
| EndpointId | string (optional) | The ID of the target to receive the event. |
2524

2625
#### EventBridgeEntry
2726

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-
27+
| Parameter | Type | Description |
28+
| :----------- | :------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------ |
29+
| Source | string | The source of the event. |
30+
| Detail | object | A JSON object containing event data. |
31+
| DetailType | string | Free-form string used to decide what fields to expect in the event detail. |
32+
| Resources | string[] (optional) | AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. |
33+
| 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. |
3634

3735
### Returns
3836

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

4341
### Example
4442

@@ -56,19 +54,19 @@ const awsConfig = new AWSConfig({
5654

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

6765
export default async function () {
68-
await eventBridge.putEvents({
69-
Entries: [eventEntry]
70-
});
66+
await eventBridge.putEvents({
67+
Entries: [eventEntry],
68+
});
7169
}
7270
```
7371

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

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ description: 'KMSDataKey is returned by the KMSClient.*DataKey methods that quer
1111
The KMSDataKey object describes an Amazon Key Management Service data key.
1212
For instance, the [`generateDataKey`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/jslib/aws/kmsclient/kmsclient-generatedatakey/) returns the generated KMSDataKey object.
1313

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. |
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. |
1818
| `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. |
1919

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

5555
{{< /code >}}
56-

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
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'
@@ -47,4 +46,4 @@ export default async function () {
4746

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

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

‎docs/sources/v0.48.x/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/v0.48.x/javascript-api/jslib/aws/KMSClient/00 generateDataKey.md‎ renamed to ‎docs/sources/v0.48.x/javascript-api/jslib/aws/KMSClient/generateDataKey.md‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
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'
76
---
@@ -12,15 +11,15 @@ excerpt: 'KMSClient.generateDataKey generates a symmetric data key for use outsi
1211

1312
### Parameters
1413

15-
| Name | Type | Description |
16-
| :--- | :----- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
14+
| Name | Type | Description |
15+
| :----- | :----- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1716
| `id` | string | The identifier of the key. This can be either the key ID or the Amazon Resource Name (ARN) of the key. |
1817
| `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. |
1918

2019
### Returns
2120

22-
| Type | Description |
23-
| :-------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------- |
21+
| Type | Description |
22+
| :------------------------------------------------------------------------------------------------------------ | :-------------------------------------------------------------------------------------------------------------------------------------- |
2423
| 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. |
2524

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

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

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

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
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"
76
---
@@ -12,8 +11,8 @@ excerpt: "KMSClient.listKeys lists all the KMS keys in the caller's AWS account
1211

1312
### Returns
1413

15-
| Type | Description |
16-
| :-------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------- |
14+
| Type | Description |
15+
| :------------------------------------------------------------------------------------------------------ | :----------------------------------------------------------------------------------------------------------------------------------------------- |
1716
| 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. |
1817

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

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

‎docs/sources/v0.48.x/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)