Skip to content

Commit 8493608

Browse files
authored
docs: fix typos (#5972)
1 parent 2beec6c commit 8493608

File tree

17 files changed

+37
-37
lines changed

17 files changed

+37
-37
lines changed

Diff for: CODE_OF_CONDUCT.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Code of Conduct
22

33
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
4-
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
4+
For more information, see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
55
[email protected] with any additional questions or comments.

Diff for: CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ the generated code change to your PR. Here's how to generate clients:
201201
There are optional CLI helpers.
202202
The CLI helpers assist in the dispatch of commands to package or subfolder contexts.
203203

204-
To activate the default aliases run:
204+
To activate the default aliases, run:
205205

206206
```
207207
. ./scripts/cli-dispatcher/set-alias.sh
@@ -260,7 +260,7 @@ matches to: yarn **t**est in packages/**m**iddleware-**sign**ing
260260
The package name query is used to find the package within clients, lib, or packages, and the npm script query is used to
261261
find a command to execute from within `package.json` `scripts`.
262262

263-
In both queries, you can use space-separated substrings. They must occur in the matching package or command in linear order. Priority is given to whole-word matches, initial word matches, and shorter strings. If your instructions are ambiguous the first priority match will be executed. Use the dry-run or confirm options to check your command before execution.
263+
In both queries, you can use space-separated substrings. They must occur in the matching package or command in linear order. Priority is given to whole-word matches, initial word matches, and shorter strings. If your instructions are ambiguous, the first priority match will be executed. Use the dry-run or confirm options to check your command before execution.
264264

265265
Additional options:
266266
--dry (dry run), --c (confirm before execution), --help

Diff for: README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ we have them listed in [UPGRADING.md](https://github.com/aws/aws-sdk-js-v3/blob/
187187

188188
### General Info
189189

190-
The Lambda provided AWS SDK is set to a specific minor version, and **NOT** the latest version. To check the minor version used by Lambda please refer to [Lambda runtimes doc page](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html).
190+
The Lambda provided AWS SDK is set to a specific minor version, and **NOT** the latest version. To check the minor version used by Lambda, please refer to [Lambda runtimes doc page](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html).
191191
If you wish to use the latest / different version of the SDK from the one provided by lambda, we recommend that you [bundle and minify](https://aws.amazon.com/blogs/compute/optimizing-node-js-dependencies-in-aws-lambda/) your project, or [upload it as a Lambda layer](https://aws.amazon.com/blogs/compute/using-lambda-layers-to-simplify-your-development-process/).
192192

193193
The performance of the AWS SDK for JavaScript v3 on node 18 has improved from v2 as seen in the [performance benchmarking](https://aws.amazon.com/blogs/developer/reduce-lambda-cold-start-times-migrate-to-aws-sdk-for-javascript-v3/)
@@ -344,7 +344,7 @@ The v3 codebase is generated from internal AWS models that AWS services expose.
344344

345345
Clients depend on common "utility" code in `/packages`. The code in `/packages` is manually written and outside of special cases (like credentials or abort controller) is generally not very useful alone.
346346

347-
Lastly we have higher level libraries in `/lib`. These are javascript specific libraries that wrap client operations to make them easier to work with. Popular examples are `@aws-sdk/lib-dynamodb` which [simplifies working with items in Amazon DynamoDB](https://github.com/aws/aws-sdk-js-v3/blob/main/lib/lib-dynamodb/README.md) or `@aws-sdk/lib-storage` which exposes the `Upload` function and [simplifies parallel uploads in S3's multipartUpload](https://github.com/aws/aws-sdk-js-v3/blob/main/lib/lib-storage/README.md).
347+
Lastly, we have higher level libraries in `/lib`. These are javascript specific libraries that wrap client operations to make them easier to work with. Popular examples are `@aws-sdk/lib-dynamodb` which [simplifies working with items in Amazon DynamoDB](https://github.com/aws/aws-sdk-js-v3/blob/main/lib/lib-dynamodb/README.md) or `@aws-sdk/lib-storage` which exposes the `Upload` function and [simplifies parallel uploads in S3's multipartUpload](https://github.com/aws/aws-sdk-js-v3/blob/main/lib/lib-storage/README.md).
348348

349349
1. `/packages`. This sub directory is where most manual code updates are done. These are published to NPM under `@aws-sdk/XXXX` and have no special prefix.
350350
1. `/clients`. This sub directory is code generated and depends on code published from `/packages` . It is 1:1 with AWS services and operations. Manual edits should generally not occur here. These are published to NPM under `@aws-sdk/client-XXXX`.
@@ -394,7 +394,7 @@ on a stream.
394394

395395
Many AWS operations return paginated results when the response object is too large to return in a single response. In AWS SDK for JavaScript v2, the response contains a token you can use to retrieve the next page of results. You then need to write additional functions to process pages of results.
396396

397-
In AWS SDK for JavaScript v3 we’ve improved pagination using async generator functions, which are similar to generator functions, with the following differences:
397+
In AWS SDK for JavaScript v3, we’ve improved pagination using async generator functions, which are similar to generator functions, with the following differences:
398398

399399
- When called, async generator functions return an object, an async generator whose methods (`next`, `throw`, and `return`) return promises for `{ `value`, `done` }`, instead of directly returning `{ `value`, `done` }`. This automatically makes the returned async generator objects async iterators.
400400
- await expressions and `for await (x of y)` statements are allowed.
@@ -489,7 +489,7 @@ abortController.abort();
489489
await requestPromise;
490490
```
491491

492-
For a full pagination deep dive please check out our [blog post](https://aws.amazon.com/blogs/developer/pagination-using-async-iterators-in-modular-aws-sdk-for-javascript/).
492+
For a full pagination deep dive, please check out our [blog post](https://aws.amazon.com/blogs/developer/pagination-using-async-iterators-in-modular-aws-sdk-for-javascript/).
493493

494494
#### AbortController Example
495495

@@ -523,7 +523,7 @@ const uploadObject = async (file) => {
523523
}
524524
```
525525

526-
For a full abort controller deep dive please check out our [blog post](https://aws.amazon.com/blogs/developer/abortcontroller-in-modular-aws-sdk-for-javascript/).
526+
For a full abort controller deep dive, please check out our [blog post](https://aws.amazon.com/blogs/developer/abortcontroller-in-modular-aws-sdk-for-javascript/).
527527

528528
### Middleware Stack
529529

@@ -568,7 +568,7 @@ The example above adds middleware to `build` step of middleware stack. The middl
568568
- The **build** lifecycle step builds on top of serialized HTTP request. Examples of typical build tasks include injecting HTTP headers that describe a stable aspect of the request, such as `Content-Length` or a body checksum. Any request alterations will be applied to all retries.
569569
- The **finalizeRequest** lifecycle step prepares the request to be sent over the wire. The request in this stage is semantically complete and should therefore only be altered to match the recipient’s expectations. Examples of typical finalization tasks include request signing, performing retries and injecting hop-by-hop headers.
570570
- The **deserialize** lifecycle step deserializes the raw response object to a structured response. The upstream middleware have access to deserialized data in next callbacks return value: `result.output`.
571-
Each middleware must be added to a specific step. By default each middleware in the same step has undifferentiated order. In some cases, you might want to execute a middleware before or after another middleware in the same step. You can achieve it by specifying its `priority`.
571+
Each middleware must be added to a specific step. By default, each middleware in the same step has undifferentiated order. In some cases, you might want to execute a middleware before or after another middleware in the same step. You can achieve it by specifying its `priority`.
572572

573573
```javascript
574574
client.middlewareStack.add(middleware, {
@@ -579,7 +579,7 @@ client.middlewareStack.add(middleware, {
579579
});
580580
```
581581

582-
For a full middleware stack deep dive please check out our [blog post](https://aws.amazon.com/blogs/developer/middleware-stack-modular-aws-sdk-js/).
582+
For a full middleware stack deep dive, please check out our [blog post](https://aws.amazon.com/blogs/developer/middleware-stack-modular-aws-sdk-js/).
583583

584584
## Release Cadence
585585

@@ -639,7 +639,7 @@ bindings to be included as a dependency with your application. This functionalit
639639
- [Amazon S3 Multi-Region Access Points](https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPoints.html)
640640
- [Amazon S3 Object Integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
641641

642-
If the required AWS Common Runtime components are not installed you will receive an error like:
642+
If the required AWS Common Runtime components are not installed, you will receive an error like:
643643

644644
```console
645645
Cannot find module '@aws-sdk/signature-v4-crt'
@@ -651,7 +651,7 @@ For more information please go to
651651
https://github.com/aws/aws-sdk-js-v3#functionality-requiring-aws-common-runtime-crt"
652652
```
653653

654-
indicating that the required dependency is missing to use the associated functionality. To install this dependency follow
654+
indicating that the required dependency is missing to use the associated functionality. To install this dependency, follow
655655
the provided [instructions](#installing-the-aws-common-runtime-crt-dependency).
656656

657657
#### Installing the AWS Common Runtime (CRT) Dependency

Diff for: UPGRADING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
This document captures notable changes from AWS SDK for JavaScript v2 to v3.
44
The v3 is also known as modular AWS SDK for JavaScript.
55

6-
Because v3 is a modular rewrite of v2, some basic conceptions are different between v2 and v3. You can learn about
6+
Because, v3 is a modular rewrite of v2, some basic conceptions are different between v2 and v3. You can learn about
77
these changes in our [blog posts](https://aws.amazon.com/blogs/developer/category/developer-tools/aws-sdk-for-javascript-in-node-js/).
88
The following blog posts will get you up to speed:
99

@@ -65,7 +65,7 @@ This list is indexed by [v2 config parameters](https://docs.aws.amazon.com/AWSJa
6565
httpsAgent: new Agent({
6666
/*params*/
6767
}),
68-
connectionTimeout: /*number in milliseconds*/
68+
connectionTimeout: /*number in milliseconds*/,
6969
socketTimeout: /*number in milliseconds*/
7070
}),
7171
});
@@ -496,7 +496,7 @@ await ddbDocClient.send(
496496

497497
### `undefined` values in when marshalling
498498

499-
- In v2 `undefined` values in objects were automatically omitted during the marshalling process to DynamoDB.
499+
- In v2, `undefined` values in objects were automatically omitted during the marshalling process to DynamoDB.
500500

501501
- In v3, the default marshalling behavior in @aws-sdk/lib-dynamodb has changed: objects with `undefined` values are no longer omitted. To align with v2's functionality, developers must explicitly set the `removeUndefinedValues` to `true` in the `marshallOptions` of the DynamoDBDocumentClient.
502502

Diff for: deprecated/packages/middleware-stack/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ stack.add(middleware, {
3636
});
3737
```
3838

39-
This approach works for most cases. Sometimes you want your middleware to be executed in the front of the `Step`, you can set the `Priority` to `high`. Set the `Priority` to `low` then this middleware will be executed at the end of `Step`:
39+
This approach works for most cases. Sometimes you want your middleware to be executed in the front of the `Step`, you can set the `Priority` to `high`. Set the `Priority` to `low`, then this middleware will be executed at the end of `Step`:
4040

4141
```javascript
4242
stack.add(middleware, {

Diff for: lib/lib-dynamodb/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ both input and output:
5050

5151
## Usage
5252

53-
To create document client you need to create DynamoDB client first as follows:
53+
To create document client, you need to create DynamoDB client first as follows:
5454

5555
```js
5656
import { DynamoDBClient } from "@aws-sdk/client-dynamodb"; // ES6 import

Diff for: packages/chunked-stream-reader-node/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/chunked-stream-reader-node/latest.svg)](https://www.npmjs.com/package/@aws-sdk/chunked-stream-reader-node)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/chunked-stream-reader-node.svg)](https://www.npmjs.com/package/@aws-sdk/chunked-stream-reader-node)
55

6-
Exports a streamReader function that accepts a readable stream, a function to call on each chunk, and a chunk size in bytes to buffer interally before calling the supplied function.
6+
Exports a streamReader function that accepts a readable stream, a function to call on each chunk, and a chunk size in bytes to buffer internally before calling the supplied function.
77

88
This package is meant for the AWS SDK for JavaScript to enable reading a stream with consistent chunk sizes.
99

Diff for: packages/credential-provider-node/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ that does not exist), then the chained provider will be rejected with an error
2828
and will not invoke the next provider in the list.
2929

3030
_IMPORTANT_: if you intend to acquire credentials using EKS
31-
[IAM Roles for Service Accounts](https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html)
31+
[IAM Roles for Service Accounts](https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html),
3232
then you must explicitly specify a value for `roleAssumerWithWebIdentity`. There is a
3333
default function available in `@aws-sdk/client-sts` package. An example of using
3434
this:

Diff for: packages/credential-providers/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -501,7 +501,7 @@ role_arn=arn:aws:iam::123456789012:role/example-role
501501

502502
#### profile with sso credentials
503503

504-
See [`fromSSO()`](#fromsso) fro more information
504+
See [`fromSSO()`](#fromsso) for more information
505505

506506
## `fromEnv()`
507507

@@ -522,7 +522,7 @@ environment variables:
522522
- `AWS_ACCESS_KEY_ID` - The access key for your AWS account.
523523
- `AWS_SECRET_ACCESS_KEY` - The secret key for your AWS account.
524524
- `AWS_SESSION_TOKEN` - The session key for your AWS account. This is only needed when you are using
525-
temporarycredentials.
525+
temporary credentials.
526526
- `AWS_CREDENTIAL_EXPIRATION` - The expiration time of the credentials contained in the environment
527527
variables described above. This value must be in a format compatible with the
528528
[ISO-8601 standard][iso8601_standard] and is only needed when you are using temporary credentials.
@@ -704,14 +704,14 @@ CLI profile name [123456789011_ReadOnly]: my-sso-profile<ENTER>
704704

705705
```javascript
706706
//...
707-
const client = new FooClient({ credentials: fromSSO({ profile: "my-sso-profile" });
707+
const client = new FooClient({ credentials: fromSSO({ profile: "my-sso-profile" })});
708708
```
709709

710710
Alternatively, the SSO credential provider is supported in shared INI credentials provider
711711

712712
```javascript
713713
//...
714-
const client = new FooClient({ credentials: fromIni({ profile: "my-sso-profile" });
714+
const client = new FooClient({ credentials: fromIni({ profile: "my-sso-profile" })});
715715
```
716716

717717
3. To log out from the current SSO session, use the AWS CLI:

Diff for: packages/ec2-metadata-service/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The basic usage of EC2 IMDS utils in the AWS SDK for JavaScript v3 is as follows
1111

1212
JavaScript example
1313

14-
```
14+
```JavaScript
1515
const { MetadataService } = require("@aws-sdk/ec2-metadata-service");
1616

1717
const metadataService = new MetadataService({});
@@ -21,7 +21,7 @@ const metadata = await metadataService.request("/latest/meta-data/", {}); // req
2121

2222
ES6 example
2323

24-
```
24+
```JavaScript
2525
import { MetadataService } from "@aws-sdk/ec2-metadata-service";
2626

2727
const metadataService = new MetadataService({});

Diff for: packages/util-create-request/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ const request = await createRequest<any, GetObjectCommandInput, GetObjectCommand
6565
```
6666

6767
You can omit the generics in this function and rely on the type inference. In this
68-
way you will lose the type safety for insuring client and command comes from the same
68+
way, you will lose the type safety for insuring client and command comes from the same
6969
service.
7070

7171
```typescript

Diff for: scripts/benchmark-size/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Options:
5656
The maintainers only need to test the packages that is public for customer to
5757
consume publicly like all service clients and some utility packages like
5858
presigner. The other internal packages are tested as dependencies of those
59-
public packages. There are 2 config files that maintainers need to update update
59+
public packages. There are 2 config files that maintainers need to update
6060
to make sure the tool runs on all packages it suppose to run and validate them
6161
with reasonable limit:
6262

@@ -66,7 +66,7 @@ with reasonable limit:
6666
`dependencies` list. You can skip running the browser bundlers test if the package
6767
is Node.js runtime only by setting the `skipBundlerTests` boolean entry.
6868
- [`limit.json`][limit-json]: Define how to validate the packages' size. For each
69-
package you can validate either of the metrics the tool generates: `publishSize`
69+
package, you can validate either of the metrics the tool generates: `publishSize`
7070
and `publishFiles`. For each metrics, you can validate them by `limit` -- the
7171
absolute value, or `hike` -- the percentage of increase since recent value.
7272

Diff for: scripts/cli-dispatcher/readme.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
## CLI dispatcher
22

3-
These scripts provides CLI helpers to send shorthand commands to a matching package.
3+
These scripts provide CLI helpers to send shorthand commands to a matching package.
44

55
### Usage
66

77
First, alias the script entry point. An example is provided in `./set-alias.sh`.
88

9-
Then run the script with the new alias `b` with no arguments to see the help message detailing usage.
9+
Then, run the script with the new alias `b` with no arguments to see the help message detailing usage.

Diff for: supplemental-docs/CLIENTS.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ described by the service model.
158158

159159
- Refer to https://smithy.io/2.0/additional-specs/rules-engine/specification.html
160160

161-
At runtime many sources of data are read to resolve the final endpoint.
161+
At runtime, many sources of data are read to resolve the final endpoint.
162162

163163
Sources include the region, FIPS/dual-stack options as mentioned further below,
164164
the operation, and in some cases even request-specific parameters.
@@ -470,7 +470,7 @@ new S3Client({
470470
```
471471
472472
The `AdaptiveRetryStrategy` is similar to the `StandardRetryStrategy`, but
473-
contains an additional `RateLimiter`. For details inspect the source code at
473+
contains an additional `RateLimiter`. For details, inspect the source code at
474474
https://github.com/smithy-lang/smithy-typescript/blob/main/packages/util-retry/src/AdaptiveRetryStrategy.ts.
475475
476476
### Logger `logger`

0 commit comments

Comments
 (0)