Skip to content

Commit 0f6548e

Browse files
authored
docs(credential-provider-sso): English fixes, clarification (#2488)
1 parent 019292b commit 0f6548e

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

packages/credential-provider-sso/README.md

+18-15
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,15 @@
55

66
## AWS Credential Provider for Node.js - AWS Single Sign-On (SSO)
77

8-
This module provides a function, `fromSSO` that will create `CredentialProvider`
9-
functions that read from [AWS SDKs and Tools shared configuration and credentials files](https://docs.aws.amazon.com/credref/latest/refdocs/creds-config-files.html)(Profile appears
10-
in the credentials file will be given precedence over the profile found in the
11-
config file). This provider will load the _resolved_ access token on local disk,
12-
and then request temporary AWS credentials. For the guidance over AWS Single
13-
Sign-On service, please refer to [the service document](https://aws.amazon.com/single-sign-on/).
8+
This module provides a function, `fromSSO`, that creates
9+
`CredentialProvider` functions that read from [AWS SDKs and Tools
10+
shared configuration and credentials
11+
files](https://docs.aws.amazon.com/credref/latest/refdocs/creds-config-files.html).
12+
Profiles in the `credentials` file are given precedence over
13+
profiles in the `config` file. This provider loads the
14+
_resolved_ access token from local disk then requests temporary AWS
15+
credentials. For guidance on the AWS Single Sign-On service, please
16+
refer to [AWS's Single Sign-On documentation](https://aws.amazon.com/single-sign-on/).
1417

1518
## Supported configuration
1619

@@ -26,16 +29,16 @@ the `fromSSO` factory function. The following options are supported:
2629
- `configFilepath` - The path to the shared config file. If not specified, the
2730
provider will use the value in the `AWS_CONFIG_FILE` environment variable or
2831
`~/.aws/config` by default.
29-
- `ssoClient` - The SSO Client that used to request AWS credentials with the SSO
32+
- `ssoClient` - The SSO Client used to request AWS credentials with the SSO
3033
access token. If not specified, a default SSO client will be created with the
3134
region specified in the profile `sso_region` entry.
3235

33-
## SSO Login with AWS CLI
36+
## SSO Login with the AWS CLI
3437

35-
This credential provider relies on [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-sso.html#sso-configure-profile)
36-
to login to an AWS SSO session. Here's a brief walk-through:
38+
This credential provider relies on the [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-sso.html#sso-configure-profile)
39+
to log into an AWS SSO session. Here's a brief walk-through:
3740

38-
1. Create a new AWS SSO enabled profile using AWS CLI. It will ask you to login
41+
1. Create a new AWS SSO enabled profile using the AWS CLI. It will ask you to login
3942
to your AWS SSO account and prompt for the name of the profile:
4043

4144
```console
@@ -45,7 +48,7 @@ $ aws configure sso
4548
CLI profile name [123456789011_ReadOnly]: my-sso-profile<ENTER>
4649
```
4750

48-
2. Configure you SDK client with the SSO credential provider:
51+
2. Configure your SDK client with the SSO credential provider:
4952

5053
```javascript
5154
import { fromSSO } from "@aws-sdk/credential-provider-sso"; // ES6 example
@@ -54,8 +57,8 @@ import { fromSSO } from "@aws-sdk/credential-provider-sso"; // ES6 example
5457
const client = new FooClient({ credentials: fromSSO({ profile: "my-sso-profile" });
5558
```
5659
57-
Alternatively, the SSO credential provider is supported in default Node.js credential
58-
provider:
60+
Alternatively, the SSO credential provider is supported as a default
61+
Node.js credential provider:
5962
6063
```javascript
6164
import { defaultProvider } from "@aws-sdk/credential-provider-node"; // ES6 example
@@ -64,7 +67,7 @@ import { defaultProvider } from "@aws-sdk/credential-provider-node"; // ES6 exam
6467
const client = new FooClient({ credentials: defaultProvider({ profile: "my-sso-profile" });
6568
```
6669
67-
3. To log out from the current SSO session, use AWS CLI:
70+
3. To log out from the current SSO session, use the AWS CLI:
6871
6972
```console
7073
$ aws sso logout

0 commit comments

Comments
 (0)