docs(client-sso-oidc): Fixed typos in the descriptions.

aws · Jan 24, 2025 · 90f84e0 · 90f84e0
1 parent d4cfdc2
commit 90f84e0
Show file tree

Hide file tree

Showing 9 changed files with 232 additions and 227 deletions.
diff --git a/clients/client-sso-oidc/README.md b/clients/client-sso-oidc/README.md
@@ -6,15 +6,16 @@
 
 AWS SDK for JavaScript SSOOIDC Client for Node.js, Browser and React Native.
 
-<p>IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI
-or a native application) to register with IAM Identity Center. The service also enables the client to
-fetch the user’s access token upon successful authentication and authorization with
-IAM Identity Center.</p>
-<note>
-<p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces.</p>
-</note>
+<p>IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI or a
+native application) to register with IAM Identity Center. The service also enables the client to fetch the
+user’s access token upon successful authentication and authorization with IAM Identity Center.</p>
 <p>
-<b>Considerations for Using This Guide</b>
+<b>API namespaces</b>
+</p>
+<p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces. IAM Identity Center
+OpenID Connect uses the <code>sso-oidc</code> namespace.</p>
+<p>
+<b>Considerations for using this guide</b>
 </p>
 <p>Before you begin using this guide, we recommend that you first review the following
 important information about how the IAM Identity Center OIDC service works.</p>
@@ -28,8 +29,8 @@ sign-on authentication with the CLI. </p>
 <p>With older versions of the CLI, the service only emits OIDC access tokens, so to
 obtain a new token, users must explicitly re-authenticate. To access the OIDC flow that
 supports token refresh and doesn’t require re-authentication, update to the latest CLI
-version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh and
-configurable IAM Identity Center session durations. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/configure-user-session.html">Configure Amazon Web Services access portal session duration </a>. </p>
+version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh
+and configurable IAM Identity Center session durations. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/configure-user-session.html">Configure Amazon Web Services access portal session duration </a>. </p>
 </li>
 <li>
 <p>The access tokens provided by this service grant access to all Amazon Web Services account

diff --git a/clients/client-sso-oidc/src/SSOOIDC.ts b/clients/client-sso-oidc/src/SSOOIDC.ts
@@ -89,15 +89,16 @@ export interface SSOOIDC {
 }
 
 /**
- * <p>IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI
- *       or a native application) to register with IAM Identity Center. The service also enables the client to
- *       fetch the user’s access token upon successful authentication and authorization with
- *       IAM Identity Center.</p>
- *          <note>
- *             <p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces.</p>
- *          </note>
+ * <p>IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI or a
+ *       native application) to register with IAM Identity Center. The service also enables the client to fetch the
+ *       user’s access token upon successful authentication and authorization with IAM Identity Center.</p>
  *          <p>
- *             <b>Considerations for Using This Guide</b>
+ *             <b>API namespaces</b>
+ *          </p>
+ *          <p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces. IAM Identity Center
+ *       OpenID Connect uses the <code>sso-oidc</code> namespace.</p>
+ *          <p>
+ *             <b>Considerations for using this guide</b>
  *          </p>
  *          <p>Before you begin using this guide, we recommend that you first review the following
  *       important information about how the IAM Identity Center OIDC service works.</p>
@@ -111,8 +112,8 @@ export interface SSOOIDC {
  *                <p>With older versions of the CLI, the service only emits OIDC access tokens, so to
  *           obtain a new token, users must explicitly re-authenticate. To access the OIDC flow that
  *           supports token refresh and doesn’t require re-authentication, update to the latest CLI
- *           version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh and
- *           configurable IAM Identity Center session durations. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/configure-user-session.html">Configure Amazon Web Services access portal session duration </a>. </p>
+ *           version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh
+ *           and configurable IAM Identity Center session durations. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/configure-user-session.html">Configure Amazon Web Services access portal session duration </a>. </p>
  *             </li>
  *             <li>
  *                <p>The access tokens provided by this service grant access to all Amazon Web Services account
@@ -122,7 +123,7 @@ export interface SSOOIDC {
  *                <p>The documentation in this guide does not describe the mechanism to convert the access
  *           token into Amazon Web Services Auth (“sigv4”) credentials for use with IAM-protected Amazon Web Services service
  *           endpoints. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/PortalAPIReference/API_GetRoleCredentials.html">GetRoleCredentials</a> in the <i>IAM Identity Center Portal API Reference
- *             Guide</i>.</p>
+ *           Guide</i>.</p>
  *             </li>
  *          </ul>
  *          <p>For general information about IAM Identity Center, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">What is

diff --git a/clients/client-sso-oidc/src/SSOOIDCClient.ts b/clients/client-sso-oidc/src/SSOOIDCClient.ts
@@ -280,15 +280,16 @@ export type SSOOIDCClientResolvedConfigType = __SmithyResolvedConfiguration<__Ht
 export interface SSOOIDCClientResolvedConfig extends SSOOIDCClientResolvedConfigType {}
 
 /**
- * <p>IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI
- *       or a native application) to register with IAM Identity Center. The service also enables the client to
- *       fetch the user’s access token upon successful authentication and authorization with
- *       IAM Identity Center.</p>
- *          <note>
- *             <p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces.</p>
- *          </note>
+ * <p>IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI or a
+ *       native application) to register with IAM Identity Center. The service also enables the client to fetch the
+ *       user’s access token upon successful authentication and authorization with IAM Identity Center.</p>
  *          <p>
- *             <b>Considerations for Using This Guide</b>
+ *             <b>API namespaces</b>
+ *          </p>
+ *          <p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces. IAM Identity Center
+ *       OpenID Connect uses the <code>sso-oidc</code> namespace.</p>
+ *          <p>
+ *             <b>Considerations for using this guide</b>
  *          </p>
  *          <p>Before you begin using this guide, we recommend that you first review the following
  *       important information about how the IAM Identity Center OIDC service works.</p>
@@ -302,8 +303,8 @@ export interface SSOOIDCClientResolvedConfig extends SSOOIDCClientResolvedConfig
  *                <p>With older versions of the CLI, the service only emits OIDC access tokens, so to
  *           obtain a new token, users must explicitly re-authenticate. To access the OIDC flow that
  *           supports token refresh and doesn’t require re-authentication, update to the latest CLI
- *           version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh and
- *           configurable IAM Identity Center session durations. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/configure-user-session.html">Configure Amazon Web Services access portal session duration </a>. </p>
+ *           version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh
+ *           and configurable IAM Identity Center session durations. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/configure-user-session.html">Configure Amazon Web Services access portal session duration </a>. </p>
  *             </li>
  *             <li>
  *                <p>The access tokens provided by this service grant access to all Amazon Web Services account
@@ -313,7 +314,7 @@ export interface SSOOIDCClientResolvedConfig extends SSOOIDCClientResolvedConfig
  *                <p>The documentation in this guide does not describe the mechanism to convert the access
  *           token into Amazon Web Services Auth (“sigv4”) credentials for use with IAM-protected Amazon Web Services service
  *           endpoints. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/PortalAPIReference/API_GetRoleCredentials.html">GetRoleCredentials</a> in the <i>IAM Identity Center Portal API Reference
- *             Guide</i>.</p>
+ *           Guide</i>.</p>
  *             </li>
  *          </ul>
  *          <p>For general information about IAM Identity Center, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">What is

diff --git a/clients/client-sso-oidc/src/commands/CreateTokenCommand.ts b/clients/client-sso-oidc/src/commands/CreateTokenCommand.ts
@@ -34,7 +34,7 @@ export interface CreateTokenCommandOutput extends CreateTokenResponse, __Metadat
 
 /**
  * <p>Creates and returns access and refresh tokens for clients that are authenticated using
- *       client secrets. The access token can be used to fetch short-term credentials for the assigned
+ *       client secrets. The access token can be used to fetch short-lived credentials for the assigned
  *       AWS accounts or to access application APIs using <code>bearer</code> authentication.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-sso-oidc/src/commands/CreateTokenWithIAMCommand.ts b/clients/client-sso-oidc/src/commands/CreateTokenWithIAMCommand.ts
@@ -34,9 +34,9 @@ export interface CreateTokenWithIAMCommandOutput extends CreateTokenWithIAMRespo
 
 /**
  * <p>Creates and returns access and refresh tokens for clients and applications that are
- *       authenticated using IAM entities. The access token can be used to fetch short-term credentials
- *       for the assigned Amazon Web Services accounts or to access application APIs using <code>bearer</code>
- *       authentication.</p>
+ *       authenticated using IAM entities. The access token can be used to fetch short-lived
+ *       credentials for the assigned Amazon Web Services accounts or to access application APIs using
+ *         <code>bearer</code> authentication.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-sso-oidc/src/commands/RegisterClientCommand.ts b/clients/client-sso-oidc/src/commands/RegisterClientCommand.ts
@@ -32,8 +32,9 @@ export interface RegisterClientCommandInput extends RegisterClientRequest {}
 export interface RegisterClientCommandOutput extends RegisterClientResponse, __MetadataBearer {}
 
 /**
- * <p>Registers a client with IAM Identity Center. This allows clients to initiate device authorization.
- *       The output should be persisted for reuse through many authentication requests.</p>
+ * <p>Registers a public client with IAM Identity Center. This allows clients to perform authorization using
+ *       the authorization code grant with Proof Key for Code Exchange (PKCE) or the device
+ *       code grant.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -83,7 +84,8 @@ export interface RegisterClientCommandOutput extends RegisterClientResponse, __M
  *       invalid.</p>
  *
  * @throws {@link InvalidRedirectUriException} (client fault)
- *  <p>Indicates that one or more redirect URI in the request is not supported for this operation.</p>
+ *  <p>Indicates that one or more redirect URI in the request is not supported for this
+ *       operation.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
  *  <p>Indicates that something is wrong with the input to the request. For example, a required

diff --git a/clients/client-sso-oidc/src/index.ts b/clients/client-sso-oidc/src/index.ts
@@ -1,15 +1,16 @@
 // smithy-typescript generated code
 /* eslint-disable */
 /**
- * <p>IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI
- *       or a native application) to register with IAM Identity Center. The service also enables the client to
- *       fetch the user’s access token upon successful authentication and authorization with
- *       IAM Identity Center.</p>
- *          <note>
- *             <p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces.</p>
- *          </note>
+ * <p>IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI or a
+ *       native application) to register with IAM Identity Center. The service also enables the client to fetch the
+ *       user’s access token upon successful authentication and authorization with IAM Identity Center.</p>
  *          <p>
- *             <b>Considerations for Using This Guide</b>
+ *             <b>API namespaces</b>
+ *          </p>
+ *          <p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces. IAM Identity Center
+ *       OpenID Connect uses the <code>sso-oidc</code> namespace.</p>
+ *          <p>
+ *             <b>Considerations for using this guide</b>
  *          </p>
  *          <p>Before you begin using this guide, we recommend that you first review the following
  *       important information about how the IAM Identity Center OIDC service works.</p>
@@ -23,8 +24,8 @@
  *                <p>With older versions of the CLI, the service only emits OIDC access tokens, so to
  *           obtain a new token, users must explicitly re-authenticate. To access the OIDC flow that
  *           supports token refresh and doesn’t require re-authentication, update to the latest CLI
- *           version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh and
- *           configurable IAM Identity Center session durations. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/configure-user-session.html">Configure Amazon Web Services access portal session duration </a>. </p>
+ *           version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh
+ *           and configurable IAM Identity Center session durations. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/configure-user-session.html">Configure Amazon Web Services access portal session duration </a>. </p>
  *             </li>
  *             <li>
  *                <p>The access tokens provided by this service grant access to all Amazon Web Services account
@@ -34,7 +35,7 @@
  *                <p>The documentation in this guide does not describe the mechanism to convert the access
  *           token into Amazon Web Services Auth (“sigv4”) credentials for use with IAM-protected Amazon Web Services service
  *           endpoints. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/PortalAPIReference/API_GetRoleCredentials.html">GetRoleCredentials</a> in the <i>IAM Identity Center Portal API Reference
- *             Guide</i>.</p>
+ *           Guide</i>.</p>
  *             </li>
  *          </ul>
  *          <p>For general information about IAM Identity Center, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">What is