Skip to content

Commit 8462240

Browse files
committed
docs: fix typos
1 parent a0ea3c6 commit 8462240

File tree

13 files changed

+258
-226
lines changed

13 files changed

+258
-226
lines changed

UPGRADING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@ Load credentials from Cognito Identity service, normally used in browsers.
270270
const client = new FooClient({
271271
region: "us-east-1",
272272
credentials: fromCognitoIdentityPool({
273-
clientConfig: cognitoIdentityClientConfig // Optional
273+
clientConfig: cognitoIdentityClientConfig, // Optional
274274
identityPoolId: "us-east-1:1699ebc0-7900-4099-b910-2df94f52a030",
275275
customRoleArn: "arn:aws:iam::1234567890:role/MYAPP-CognitoIdentity", // Optional
276276
logins: {
@@ -401,10 +401,10 @@ Retrieves credentials using OIDC token from a file on disk. It's commonly used i
401401

402402
const client = new FooClient({
403403
credentials: fromTokenFile({
404-
roleArn: "arn:xxxx" // Optional. Otherwise read from `AWS_ROLE_ARN` environmental variable
404+
roleArn: "arn:xxxx", // Optional. Otherwise read from `AWS_ROLE_ARN` environmental variable
405405
roleSessionName: "session:a", // Optional. Otherwise read from `AWS_ROLE_SESSION_NAME` environmental variable
406-
clientConfig: { region } // // Optional. STS client config to make the assume role request.
407-
})
406+
clientConfig: { region }, // // Optional. STS client config to make the assume role request.
407+
}),
408408
});
409409
```
410410

@@ -421,10 +421,10 @@ Retrieves credentials from STS web identity federation support.
421421

422422
const client = new FooClient({
423423
credentials: fromWebToken({
424-
roleArn: "arn:xxxx" // Otherwise read from `AWS_ROLE_ARN` environmental variable
424+
roleArn: "arn:xxxx", // Otherwise read from `AWS_ROLE_ARN` environmental variable
425425
roleSessionName: "session:a", // Otherwise read from `AWS_ROLE_SESSION_NAME` environmental variable
426-
clientConfig: { region } // // Optional. STS client config to make the assume role request.
427-
})
426+
clientConfig: { region }, // // Optional. STS client config to make the assume role request.
427+
}),
428428
});
429429
```
430430

packages/credential-providers/README.md

Lines changed: 229 additions & 197 deletions
Large diffs are not rendered by default.

packages/credential-providers/src/fromCognitoIdentity.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ export type CognitoIdentityCredentialProvider = _CognitoIdentityCredentialProvid
2121
* Results from this function call are not cached internally.
2222
*
2323
* ```javascript
24-
* import { fromCognitoIdentity } from "@aws-sdk/credential-providers"; // ES6 example
25-
* // const { fromCognitoIdentity } = require("@aws-sdk/credential-providers"); // CommonJS example
24+
* import { fromCognitoIdentity } from "@aws-sdk/credential-providers"; // ES6 import
25+
* // const { fromCognitoIdentity } = require("@aws-sdk/credential-providers"); // CommonJS import
2626
*
2727
* const client = new FooClient({
2828
* region,

packages/credential-providers/src/fromCognitoIdentityPool.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ export interface FromCognitoIdentityPoolParameters extends Omit<_FromCognitoIden
1616
* Results from `GetId` are cached internally, but results from `GetCredentialsForIdentity` are not.
1717
*
1818
* ```javascript
19-
* import { fromCognitoIdentityPool } from "@aws-sdk/credential-providers"; // ES6 example
20-
* // const { fromCognitoIdentityPool } = require("@aws-sdk/credential-providers"); // CommonJS example
19+
* import { fromCognitoIdentityPool } from "@aws-sdk/credential-providers"; // ES6 import
20+
* // const { fromCognitoIdentityPool } = require("@aws-sdk/credential-providers"); // CommonJS import
2121
*
2222
* const client = new FooClient({
2323
* region,

packages/credential-providers/src/fromContainerMetadata.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ export interface RemoteProviderInit extends _RemoteProviderInit {}
1010
* Create a credential provider function that reads from ECS container metadata service.
1111
*
1212
* ```javascript
13-
* import { fromContainerMetadata } from "@aws-sdk/credential-providers"; // ES6 example
14-
* // const { fromContainerMetadata } = require("@aws-sdk/credential-providers"); // CommonJS example
13+
* import { fromContainerMetadata } from "@aws-sdk/credential-providers"; // ES6 import
14+
* // const { fromContainerMetadata } = require("@aws-sdk/credential-providers"); // CommonJS import
1515
*
1616
* const foo = new FooClient({
1717
* credentials: fromInstanceMetadata({

packages/credential-providers/src/fromEnv.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ import { CredentialProvider } from "@aws-sdk/types";
1717
* value, the promise returned by the `fromEnv` function will be rejected.
1818
*
1919
* ```javascript
20-
* import { fromEnv } from "@aws-sdk/credential-providers"; // ES6 example
21-
* // const { fromEnv } = require("@aws-sdk/credential-providers"); // CommonJS example
20+
* import { fromEnv } from "@aws-sdk/credential-providers"; // ES6 import
21+
* // const { fromEnv } = require("@aws-sdk/credential-providers"); // CommonJS import
2222
*
2323
* const client = new DynamoDBClient({
2424
* credentials: fromEnv(),

packages/credential-providers/src/fromIni.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ export interface FromIniInit extends _FromIniInit {
1616
* given precedence over the profile found in the config file.
1717
*
1818
* ```javascript
19-
* import { fromIni } from "@aws-sdk/credential-providers"; // ES6 example
20-
* // const { fromIni } = require("@aws-sdk/credential-providers"); // CommonJS example
19+
* import { fromIni } from "@aws-sdk/credential-providers"; // ES6 import
20+
* // const { fromIni } = require("@aws-sdk/credential-providers"); // CommonJS import
2121
*
2222
* const client = new FooClient({
2323
* credentials: fromIni({

packages/credential-providers/src/fromInstanceMetadata.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ import { CredentialProvider } from "@aws-sdk/types";
88
* Creates a credential provider function that reads from the EC2 instance metadata service.
99
*
1010
* ```javascript
11-
* import { fromInstanceMetadata } from "@aws-sdk/credential-providers"; // ES6 example
12-
* // const { fromInstanceMetadata } = require("@aws-sdk/credential-providers"); // CommonJS example
11+
* import { fromInstanceMetadata } from "@aws-sdk/credential-providers"; // ES6 import
12+
* // const { fromInstanceMetadata } = require("@aws-sdk/credential-providers"); // CommonJS import
1313
*
1414
* const client = new DynamoDBClient({
1515
* credentials: fromInstanceMetadata({

packages/credential-providers/src/fromProcess.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ export interface FromProcessInit extends _FromProcessInit {}
88
* receive a JSON payload containing the credentials.
99
*
1010
* ```javascript
11-
* import { fromProcess } from "@aws-sdk/credential-providers"; // ES6 example
12-
* // const { fromProcess } = require("@aws-sdk/credential-providers"); // CommonJS example
11+
* import { fromProcess } from "@aws-sdk/credential-providers"; // ES6 import
12+
* // const { fromProcess } = require("@aws-sdk/credential-providers"); // CommonJS import
1313
*
1414
* const client = new FooClient({
1515
* credentials: fromProcess({

packages/credential-providers/src/fromSSO.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ export interface FromSSOInit extends Omit<_FromSSOInit, "client"> {
1515
* Profiles in the `credentials` file are given precedence over profiles in the `config` file.
1616
*
1717
* ```javascript
18-
* import { fromSSO } from "@aws-sdk/credential-providers"; // ES6 example
19-
* // const { fromSSO } = require(@aws-sdk/credential-providers") // CommonJS example
18+
* import { fromSSO } from "@aws-sdk/credential-providers"; // ES6 import
19+
* // const { fromSSO } = require(@aws-sdk/credential-providers") // CommonJS import
2020
*
2121
* const client = new FooClient({
2222
* credentials: fromSSO({

0 commit comments

Comments
 (0)