Skip to content

Commit

Permalink
docs: fix typos (#5972)
Browse files Browse the repository at this point in the history
  • Loading branch information
grjan7 committed Apr 8, 2024
1 parent 2beec6c commit 8493608
Show file tree
Hide file tree
Showing 17 changed files with 37 additions and 37 deletions.
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
@@ -1,5 +1,5 @@
## Code of Conduct

This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
For more information, see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
opensource-codeofconduct@amazon.com with any additional questions or comments.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Expand Up @@ -201,7 +201,7 @@ the generated code change to your PR. Here's how to generate clients:
There are optional CLI helpers.
The CLI helpers assist in the dispatch of commands to package or subfolder contexts.

To activate the default aliases run:
To activate the default aliases, run:

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

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.
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.

Additional options:
--dry (dry run), --c (confirm before execution), --help
Expand Down
18 changes: 9 additions & 9 deletions README.md
Expand Up @@ -187,7 +187,7 @@ we have them listed in [UPGRADING.md](https://github.com/aws/aws-sdk-js-v3/blob/

### General Info

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).
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).
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/).

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/)
Expand Down Expand Up @@ -344,7 +344,7 @@ The v3 codebase is generated from internal AWS models that AWS services expose.

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.

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).
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).

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.
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`.
Expand Down Expand Up @@ -394,7 +394,7 @@ on a stream.

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.

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

- 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.
- await expressions and `for await (x of y)` statements are allowed.
Expand Down Expand Up @@ -489,7 +489,7 @@ abortController.abort();
await requestPromise;
```

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/).
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/).

#### AbortController Example

Expand Down Expand Up @@ -523,7 +523,7 @@ const uploadObject = async (file) => {
}
```

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/).
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/).

### Middleware Stack

Expand Down Expand Up @@ -568,7 +568,7 @@ The example above adds middleware to `build` step of middleware stack. The middl
- 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.
- 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.
- 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`.
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`.
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`.

```javascript
client.middlewareStack.add(middleware, {
Expand All @@ -579,7 +579,7 @@ client.middlewareStack.add(middleware, {
});
```

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/).
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/).

## Release Cadence

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

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

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

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

#### Installing the AWS Common Runtime (CRT) Dependency
Expand Down
6 changes: 3 additions & 3 deletions UPGRADING.md
Expand Up @@ -3,7 +3,7 @@
This document captures notable changes from AWS SDK for JavaScript v2 to v3.
The v3 is also known as modular AWS SDK for JavaScript.

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

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

### `undefined` values in when marshalling

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

- 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.

Expand Down
2 changes: 1 addition & 1 deletion deprecated/packages/middleware-stack/README.md
Expand Up @@ -36,7 +36,7 @@ stack.add(middleware, {
});
```

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`:
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`:

```javascript
stack.add(middleware, {
Expand Down
2 changes: 1 addition & 1 deletion lib/lib-dynamodb/README.md
Expand Up @@ -50,7 +50,7 @@ both input and output:

## Usage

To create document client you need to create DynamoDB client first as follows:
To create document client, you need to create DynamoDB client first as follows:

```js
import { DynamoDBClient } from "@aws-sdk/client-dynamodb"; // ES6 import
Expand Down
2 changes: 1 addition & 1 deletion packages/chunked-stream-reader-node/README.md
Expand Up @@ -3,7 +3,7 @@
[![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)
[![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)

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.
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.

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

Expand Down
2 changes: 1 addition & 1 deletion packages/credential-provider-node/README.md
Expand Up @@ -28,7 +28,7 @@ that does not exist), then the chained provider will be rejected with an error
and will not invoke the next provider in the list.

_IMPORTANT_: if you intend to acquire credentials using EKS
[IAM Roles for Service Accounts](https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html)
[IAM Roles for Service Accounts](https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html),
then you must explicitly specify a value for `roleAssumerWithWebIdentity`. There is a
default function available in `@aws-sdk/client-sts` package. An example of using
this:
Expand Down
8 changes: 4 additions & 4 deletions packages/credential-providers/README.md
Expand Up @@ -501,7 +501,7 @@ role_arn=arn:aws:iam::123456789012:role/example-role

#### profile with sso credentials

See [`fromSSO()`](#fromsso) fro more information
See [`fromSSO()`](#fromsso) for more information

## `fromEnv()`

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

```javascript
//...
const client = new FooClient({ credentials: fromSSO({ profile: "my-sso-profile" });
const client = new FooClient({ credentials: fromSSO({ profile: "my-sso-profile" })});
```

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

```javascript
//...
const client = new FooClient({ credentials: fromIni({ profile: "my-sso-profile" });
const client = new FooClient({ credentials: fromIni({ profile: "my-sso-profile" })});
```

3. To log out from the current SSO session, use the AWS CLI:
Expand Down
4 changes: 2 additions & 2 deletions packages/ec2-metadata-service/README.md
Expand Up @@ -11,7 +11,7 @@ The basic usage of EC2 IMDS utils in the AWS SDK for JavaScript v3 is as follows

JavaScript example

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

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

ES6 example

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

const metadataService = new MetadataService({});
Expand Down
2 changes: 1 addition & 1 deletion packages/util-create-request/README.md
Expand Up @@ -65,7 +65,7 @@ const request = await createRequest<any, GetObjectCommandInput, GetObjectCommand
```

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

```typescript
Expand Down
4 changes: 2 additions & 2 deletions scripts/benchmark-size/README.md
Expand Up @@ -56,7 +56,7 @@ Options:
The maintainers only need to test the packages that is public for customer to
consume publicly like all service clients and some utility packages like
presigner. The other internal packages are tested as dependencies of those
public packages. There are 2 config files that maintainers need to update update
public packages. There are 2 config files that maintainers need to update
to make sure the tool runs on all packages it suppose to run and validate them
with reasonable limit:

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

Expand Down
4 changes: 2 additions & 2 deletions scripts/cli-dispatcher/readme.md
@@ -1,9 +1,9 @@
## CLI dispatcher

These scripts provides CLI helpers to send shorthand commands to a matching package.
These scripts provide CLI helpers to send shorthand commands to a matching package.

### Usage

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

Then run the script with the new alias `b` with no arguments to see the help message detailing usage.
Then, run the script with the new alias `b` with no arguments to see the help message detailing usage.
4 changes: 2 additions & 2 deletions supplemental-docs/CLIENTS.md
Expand Up @@ -158,7 +158,7 @@ described by the service model.

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

At runtime many sources of data are read to resolve the final endpoint.
At runtime, many sources of data are read to resolve the final endpoint.

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

0 comments on commit 8493608

Please sign in to comment.