Skip to content

Commit 48bdb32

Browse files
authored
fix typos in readme generator (#222)
* fix typos in readme generator * update client READMEs
1 parent c4d1a61 commit 48bdb32

File tree

15 files changed

+105
-105
lines changed

15 files changed

+105
-105
lines changed

packages/client-codecommit-node/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ npm install @aws-sdk/client-codecommit-node
1616

1717
### Import
1818

19-
The AWS SDK is modulized by clients and commends in CommonJS modules. To send a request, you only need to import the client(`CodeCommitClient`) and the commands you need, for example `BatchGetRepositoriesCommand`:
19+
The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`CodeCommitClient`) and the commands you need, for example `BatchGetRepositoriesCommand`:
2020

2121
```javascript
2222
//javascript
@@ -34,9 +34,9 @@ const { BatchGetRepositoriesCommand } = import '@aws-sdk/client-codecommit-node/
3434

3535
To send a request, you:
3636

37-
* Initiate client with configurations.(credentials, region). For more information you can refer to the [API reference][].
37+
* Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].
3838
* Initiate command with input parameters.
39-
* Call `send` operation of client with command object as input.
39+
* Call `send` operation on client with command object as input.
4040
* If you are using a custom http handler, you may call `destroy()` to close open connections.
4141

4242
```javascript
@@ -53,7 +53,7 @@ codeCommit.send(batchGetRepositoriesCommand).then(data => {
5353
})
5454
```
5555

56-
Besides using promise style, there are 2 other ways to send a request:
56+
In addition to using promises, there are 2 other ways to send a request:
5757

5858
```javascript
5959
// async/await
@@ -72,7 +72,7 @@ codeCommit.send(batchGetRepositoriesCommand, (err, data) => {
7272
})
7373
```
7474

75-
Besides using `send()`, the SDK can also send requests using the simplified callback style in version 2 of the SDK.
75+
The SDK can also send requests using the simplified callback style from version 2 of the SDK.
7676

7777
```javascript
7878
import * as AWS from '@aws-sdk/@aws-sdk/client-codecommit-node/CodeCommit';
@@ -85,7 +85,7 @@ codeCommit.batchGetRepositories(params, (err, data) => {
8585

8686
### Troubleshooting
8787

88-
When the service returns an exception, inpecting the exceptions is always helpful. You can not only access the exception information but also response metadata(i.e request id).
88+
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
8989

9090
```javascript
9191
try {
@@ -99,7 +99,7 @@ cfId: ${metadata.cfId}
9999
extendedRequestId: ${metadata.extendedRequestId}`
100100
);
101101
/*
102-
The keys within exceptions are also parsed, you can access them by specifying exception names like below:
102+
The keys within exceptions are also parsed. You can access them by specifying exception names:
103103
if(error.name === 'SomeServiceException') {
104104
const value = error.specialKeyInException;
105105
}

packages/client-cognito-identity-browser/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ npm install @aws-sdk/client-cognito-identity-browser
1616

1717
### Import
1818

19-
The AWS SDK is modulized by clients and commends in CommonJS modules. To send a request, you only need to import the client(`CognitoIdentityClient`) and the commands you need, for example `CreateIdentityPoolCommand`:
19+
The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`CognitoIdentityClient`) and the commands you need, for example `CreateIdentityPoolCommand`:
2020

2121
```javascript
2222
//javascript
@@ -34,9 +34,9 @@ const { CreateIdentityPoolCommand } = import '@aws-sdk/client-cognito-identity-b
3434

3535
To send a request, you:
3636

37-
* Initiate client with configurations.(credentials, region). For more information you can refer to the [API reference][].
37+
* Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].
3838
* Initiate command with input parameters.
39-
* Call `send` operation of client with command object as input.
39+
* Call `send` operation on client with command object as input.
4040
* If you are using a custom http handler, you may call `destroy()` to close open connections.
4141

4242
```javascript
@@ -54,7 +54,7 @@ cognitoIdentity.send(createIdentityPoolCommand).then(data => {
5454
})
5555
```
5656

57-
Besides using promise style, there are 2 other ways to send a request:
57+
In addition to using promises, there are 2 other ways to send a request:
5858

5959
```javascript
6060
// async/await
@@ -73,7 +73,7 @@ cognitoIdentity.send(createIdentityPoolCommand, (err, data) => {
7373
})
7474
```
7575

76-
Besides using `send()`, the SDK can also send requests using the simplified callback style in version 2 of the SDK.
76+
The SDK can also send requests using the simplified callback style from version 2 of the SDK.
7777

7878
```javascript
7979
import * as AWS from '@aws-sdk/@aws-sdk/client-cognito-identity-browser/CognitoIdentity';
@@ -86,7 +86,7 @@ cognitoIdentity.createIdentityPool(params, (err, data) => {
8686

8787
### Troubleshooting
8888

89-
When the service returns an exception, inpecting the exceptions is always helpful. You can not only access the exception information but also response metadata(i.e request id).
89+
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
9090

9191
```javascript
9292
try {
@@ -100,7 +100,7 @@ cfId: ${metadata.cfId}
100100
extendedRequestId: ${metadata.extendedRequestId}`
101101
);
102102
/*
103-
The keys within exceptions are also parsed, you can access them by specifying exception names like below:
103+
The keys within exceptions are also parsed. You can access them by specifying exception names:
104104
if(error.name === 'SomeServiceException') {
105105
const value = error.specialKeyInException;
106106
}

packages/client-dynamodb-browser/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ npm install @aws-sdk/client-dynamodb-browser
1616

1717
### Import
1818

19-
The AWS SDK is modulized by clients and commends in CommonJS modules. To send a request, you only need to import the client(`DynamoDBClient`) and the commands you need, for example `BatchGetItemCommand`:
19+
The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`DynamoDBClient`) and the commands you need, for example `BatchGetItemCommand`:
2020

2121
```javascript
2222
//javascript
@@ -34,9 +34,9 @@ const { BatchGetItemCommand } = import '@aws-sdk/client-dynamodb-browser/command
3434

3535
To send a request, you:
3636

37-
* Initiate client with configurations.(credentials, region). For more information you can refer to the [API reference][].
37+
* Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].
3838
* Initiate command with input parameters.
39-
* Call `send` operation of client with command object as input.
39+
* Call `send` operation on client with command object as input.
4040
* If you are using a custom http handler, you may call `destroy()` to close open connections.
4141

4242
```javascript
@@ -53,7 +53,7 @@ dynamoDB.send(batchGetItemCommand).then(data => {
5353
})
5454
```
5555

56-
Besides using promise style, there are 2 other ways to send a request:
56+
In addition to using promises, there are 2 other ways to send a request:
5757

5858
```javascript
5959
// async/await
@@ -72,7 +72,7 @@ dynamoDB.send(batchGetItemCommand, (err, data) => {
7272
})
7373
```
7474

75-
Besides using `send()`, the SDK can also send requests using the simplified callback style in version 2 of the SDK.
75+
The SDK can also send requests using the simplified callback style from version 2 of the SDK.
7676

7777
```javascript
7878
import * as AWS from '@aws-sdk/@aws-sdk/client-dynamodb-browser/DynamoDB';
@@ -85,7 +85,7 @@ dynamoDB.batchGetItem(params, (err, data) => {
8585

8686
### Troubleshooting
8787

88-
When the service returns an exception, inpecting the exceptions is always helpful. You can not only access the exception information but also response metadata(i.e request id).
88+
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
8989

9090
```javascript
9191
try {
@@ -99,7 +99,7 @@ cfId: ${metadata.cfId}
9999
extendedRequestId: ${metadata.extendedRequestId}`
100100
);
101101
/*
102-
The keys within exceptions are also parsed, you can access them by specifying exception names like below:
102+
The keys within exceptions are also parsed. You can access them by specifying exception names:
103103
if(error.name === 'SomeServiceException') {
104104
const value = error.specialKeyInException;
105105
}

packages/client-dynamodb-node/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ npm install @aws-sdk/client-dynamodb-node
1616

1717
### Import
1818

19-
The AWS SDK is modulized by clients and commends in CommonJS modules. To send a request, you only need to import the client(`DynamoDBClient`) and the commands you need, for example `BatchGetItemCommand`:
19+
The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`DynamoDBClient`) and the commands you need, for example `BatchGetItemCommand`:
2020

2121
```javascript
2222
//javascript
@@ -34,9 +34,9 @@ const { BatchGetItemCommand } = import '@aws-sdk/client-dynamodb-node/commands/B
3434

3535
To send a request, you:
3636

37-
* Initiate client with configurations.(credentials, region). For more information you can refer to the [API reference][].
37+
* Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].
3838
* Initiate command with input parameters.
39-
* Call `send` operation of client with command object as input.
39+
* Call `send` operation on client with command object as input.
4040
* If you are using a custom http handler, you may call `destroy()` to close open connections.
4141

4242
```javascript
@@ -53,7 +53,7 @@ dynamoDB.send(batchGetItemCommand).then(data => {
5353
})
5454
```
5555

56-
Besides using promise style, there are 2 other ways to send a request:
56+
In addition to using promises, there are 2 other ways to send a request:
5757

5858
```javascript
5959
// async/await
@@ -72,7 +72,7 @@ dynamoDB.send(batchGetItemCommand, (err, data) => {
7272
})
7373
```
7474

75-
Besides using `send()`, the SDK can also send requests using the simplified callback style in version 2 of the SDK.
75+
The SDK can also send requests using the simplified callback style from version 2 of the SDK.
7676

7777
```javascript
7878
import * as AWS from '@aws-sdk/@aws-sdk/client-dynamodb-node/DynamoDB';
@@ -85,7 +85,7 @@ dynamoDB.batchGetItem(params, (err, data) => {
8585

8686
### Troubleshooting
8787

88-
When the service returns an exception, inpecting the exceptions is always helpful. You can not only access the exception information but also response metadata(i.e request id).
88+
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
8989

9090
```javascript
9191
try {
@@ -99,7 +99,7 @@ cfId: ${metadata.cfId}
9999
extendedRequestId: ${metadata.extendedRequestId}`
100100
);
101101
/*
102-
The keys within exceptions are also parsed, you can access them by specifying exception names like below:
102+
The keys within exceptions are also parsed. You can access them by specifying exception names:
103103
if(error.name === 'SomeServiceException') {
104104
const value = error.specialKeyInException;
105105
}

packages/client-glacier-node/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ npm install @aws-sdk/client-glacier-node
1616

1717
### Import
1818

19-
The AWS SDK is modulized by clients and commends in CommonJS modules. To send a request, you only need to import the client(`GlacierClient`) and the commands you need, for example `UploadArchiveCommand`:
19+
The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`GlacierClient`) and the commands you need, for example `UploadArchiveCommand`:
2020

2121
```javascript
2222
//javascript
@@ -34,9 +34,9 @@ const { UploadArchiveCommand } = import '@aws-sdk/client-glacier-node/commands/U
3434

3535
To send a request, you:
3636

37-
* Initiate client with configurations.(credentials, region). For more information you can refer to the [API reference][].
37+
* Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].
3838
* Initiate command with input parameters.
39-
* Call `send` operation of client with command object as input.
39+
* Call `send` operation on client with command object as input.
4040
* If you are using a custom http handler, you may call `destroy()` to close open connections.
4141

4242
```javascript
@@ -56,7 +56,7 @@ glacier.send(uploadArchiveCommand).then(data => {
5656
})
5757
```
5858

59-
Besides using promise style, there are 2 other ways to send a request:
59+
In addition to using promises, there are 2 other ways to send a request:
6060

6161
```javascript
6262
// async/await
@@ -75,7 +75,7 @@ glacier.send(uploadArchiveCommand, (err, data) => {
7575
})
7676
```
7777

78-
Besides using `send()`, the SDK can also send requests using the simplified callback style in version 2 of the SDK.
78+
The SDK can also send requests using the simplified callback style from version 2 of the SDK.
7979

8080
```javascript
8181
import * as AWS from '@aws-sdk/@aws-sdk/client-glacier-node/Glacier';
@@ -90,7 +90,7 @@ For operations containing stream response like `GetJobOutput()`, you can get res
9090

9191
### Troubleshooting
9292

93-
When the service returns an exception, inpecting the exceptions is always helpful. You can not only access the exception information but also response metadata(i.e request id).
93+
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
9494

9595
```javascript
9696
try {
@@ -104,7 +104,7 @@ cfId: ${metadata.cfId}
104104
extendedRequestId: ${metadata.extendedRequestId}`
105105
);
106106
/*
107-
The keys within exceptions are also parsed, you can access them by specifying exception names like below:
107+
The keys within exceptions are also parsed. You can access them by specifying exception names:
108108
if(error.name === 'SomeServiceException') {
109109
const value = error.specialKeyInException;
110110
}

packages/client-kinesis-browser/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ npm install @aws-sdk/client-kinesis-browser
1616

1717
### Import
1818

19-
The AWS SDK is modulized by clients and commends in CommonJS modules. To send a request, you only need to import the client(`KinesisClient`) and the commands you need, for example `AddTagsToStreamCommand`:
19+
The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`KinesisClient`) and the commands you need, for example `AddTagsToStreamCommand`:
2020

2121
```javascript
2222
//javascript
@@ -34,9 +34,9 @@ const { AddTagsToStreamCommand } = import '@aws-sdk/client-kinesis-browser/comma
3434

3535
To send a request, you:
3636

37-
* Initiate client with configurations.(credentials, region). For more information you can refer to the [API reference][].
37+
* Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].
3838
* Initiate command with input parameters.
39-
* Call `send` operation of client with command object as input.
39+
* Call `send` operation on client with command object as input.
4040
* If you are using a custom http handler, you may call `destroy()` to close open connections.
4141

4242
```javascript
@@ -54,7 +54,7 @@ kinesis.send(addTagsToStreamCommand).then(data => {
5454
})
5555
```
5656

57-
Besides using promise style, there are 2 other ways to send a request:
57+
In addition to using promises, there are 2 other ways to send a request:
5858

5959
```javascript
6060
// async/await
@@ -73,7 +73,7 @@ kinesis.send(addTagsToStreamCommand, (err, data) => {
7373
})
7474
```
7575

76-
Besides using `send()`, the SDK can also send requests using the simplified callback style in version 2 of the SDK.
76+
The SDK can also send requests using the simplified callback style from version 2 of the SDK.
7777

7878
```javascript
7979
import * as AWS from '@aws-sdk/@aws-sdk/client-kinesis-browser/Kinesis';
@@ -86,7 +86,7 @@ kinesis.addTagsToStream(params, (err, data) => {
8686

8787
### Troubleshooting
8888

89-
When the service returns an exception, inpecting the exceptions is always helpful. You can not only access the exception information but also response metadata(i.e request id).
89+
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
9090

9191
```javascript
9292
try {
@@ -100,7 +100,7 @@ cfId: ${metadata.cfId}
100100
extendedRequestId: ${metadata.extendedRequestId}`
101101
);
102102
/*
103-
The keys within exceptions are also parsed, you can access them by specifying exception names like below:
103+
The keys within exceptions are also parsed. You can access them by specifying exception names:
104104
if(error.name === 'SomeServiceException') {
105105
const value = error.specialKeyInException;
106106
}

packages/client-kms-browser/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ npm install @aws-sdk/client-kms-browser
1616

1717
### Import
1818

19-
The AWS SDK is modulized by clients and commends in CommonJS modules. To send a request, you only need to import the client(`KMSClient`) and the commands you need, for example `CancelKeyDeletionCommand`:
19+
The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`KMSClient`) and the commands you need, for example `CancelKeyDeletionCommand`:
2020

2121
```javascript
2222
//javascript
@@ -34,9 +34,9 @@ const { CancelKeyDeletionCommand } = import '@aws-sdk/client-kms-browser/command
3434

3535
To send a request, you:
3636

37-
* Initiate client with configurations.(credentials, region). For more information you can refer to the [API reference][].
37+
* Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].
3838
* Initiate command with input parameters.
39-
* Call `send` operation of client with command object as input.
39+
* Call `send` operation on client with command object as input.
4040
* If you are using a custom http handler, you may call `destroy()` to close open connections.
4141

4242
```javascript
@@ -53,7 +53,7 @@ kMS.send(cancelKeyDeletionCommand).then(data => {
5353
})
5454
```
5555

56-
Besides using promise style, there are 2 other ways to send a request:
56+
In addition to using promises, there are 2 other ways to send a request:
5757

5858
```javascript
5959
// async/await
@@ -72,7 +72,7 @@ kMS.send(cancelKeyDeletionCommand, (err, data) => {
7272
})
7373
```
7474

75-
Besides using `send()`, the SDK can also send requests using the simplified callback style in version 2 of the SDK.
75+
The SDK can also send requests using the simplified callback style from version 2 of the SDK.
7676

7777
```javascript
7878
import * as AWS from '@aws-sdk/@aws-sdk/client-kms-browser/KMS';
@@ -85,7 +85,7 @@ kMS.cancelKeyDeletion(params, (err, data) => {
8585

8686
### Troubleshooting
8787

88-
When the service returns an exception, inpecting the exceptions is always helpful. You can not only access the exception information but also response metadata(i.e request id).
88+
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
8989

9090
```javascript
9191
try {
@@ -99,7 +99,7 @@ cfId: ${metadata.cfId}
9999
extendedRequestId: ${metadata.extendedRequestId}`
100100
);
101101
/*
102-
The keys within exceptions are also parsed, you can access them by specifying exception names like below:
102+
The keys within exceptions are also parsed. You can access them by specifying exception names:
103103
if(error.name === 'SomeServiceException') {
104104
const value = error.specialKeyInException;
105105
}

0 commit comments

Comments
 (0)