docs(client-sso-oidc): Documentation updates to reflect service renam…

…e - AWS IAM Identity Center (successor to AWS Single Sign-On)
aws · Aug 8, 2022 · b62ea44 · b62ea44
1 parent 5ab6a9f
commit b62ea44
Show file tree

Hide file tree

Showing 8 changed files with 214 additions and 112 deletions.
diff --git a/clients/client-sso-oidc/README.md b/clients/client-sso-oidc/README.md
@@ -9,24 +9,46 @@
 
 AWS SDK for JavaScript SSOOIDC Client for Node.js, Browser and React Native.
 
-<p>AWS Single Sign-On (SSO) OpenID Connect (OIDC) is a web service that enables a client
-(such as AWS CLI or a native application) to register with AWS SSO. The service also
-enables the client to fetch the user’s access token upon successful authentication and
-authorization with AWS SSO. This service conforms with the OAuth 2.0 based implementation of
-the device authorization grant standard (<a href="https://tools.ietf.org/html/rfc8628">https://tools.ietf.org/html/rfc8628</a>).</p>
-
-<p>For general information about AWS SSO, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">What is AWS
-Single Sign-On?</a> in the <i>AWS SSO User Guide</i>.</p>
-
-<p>This API reference guide describes the AWS SSO OIDC operations that you can call
-programatically and includes detailed information on data types and errors.</p>
-
+<p>Amazon Web Services Single Sign On OpenID Connect (OIDC) is a web service that enables a client (such as Amazon Web Services CLI
+or a native application) to register with Amazon Web Services SSO. The service also enables the client to
+fetch the user’s access token upon successful authentication and authorization with
+Amazon Web Services SSO.</p>
 <note>
-<p>AWS provides SDKs that consist of libraries and sample code for various programming
-languages and platforms such as Java, Ruby, .Net, iOS, and Android. The SDKs provide a
-convenient way to create programmatic access to AWS SSO and other AWS services. For more
-information about the AWS SDKs, including how to download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>.</p>
+<p>Although Amazon Web Services Single Sign-On was renamed, the <code>sso</code> and
+<code>identitystore</code> API namespaces will continue to retain their original name for
+backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">Amazon Web Services SSO rename</a>.</p>
 </note>
+<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 Amazon Web Services SSO OIDC service works.</p>
+<ul>
+<li>
+<p>The Amazon Web Services SSO OIDC service currently implements only the portions of the OAuth 2.0
+Device Authorization Grant standard (<a href="https://tools.ietf.org/html/rfc8628">https://tools.ietf.org/html/rfc8628</a>) that are necessary to enable single
+sign-on authentication with the AWS CLI. Support for other OIDC flows frequently needed
+for native applications, such as Authorization Code Flow (+ PKCE), will be addressed in
+future releases.</p>
+</li>
+<li>
+<p>The service emits only OIDC access tokens, such that obtaining a new token (For
+example, token refresh) requires explicit user re-authentication.</p>
+</li>
+<li>
+<p>The access tokens provided by this service grant access to all AWS account
+entitlements assigned to an Amazon Web Services SSO user, not just a particular application.</p>
+</li>
+<li>
+<p>The documentation in this guide does not describe the mechanism to convert the access
+token into AWS Auth (“sigv4”) credentials for use with IAM-protected AWS service
+endpoints. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/PortalAPIReference/API_GetRoleCredentials.html">GetRoleCredentials</a> in the <i>Amazon Web Services SSO Portal API Reference
+Guide</i>.</p>
+</li>
+</ul>
+
+<p>For general information about Amazon Web Services SSO, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">What is
+Amazon Web Services SSO?</a> in the <i>Amazon Web Services SSO User Guide</i>.</p>
 
 ## Installing
 

diff --git a/clients/client-sso-oidc/src/SSOOIDC.ts b/clients/client-sso-oidc/src/SSOOIDC.ts
@@ -15,29 +15,51 @@ import {
 import { SSOOIDCClient } from "./SSOOIDCClient";
 
 /**
- * <p>AWS Single Sign-On (SSO) OpenID Connect (OIDC) is a web service that enables a client
- *       (such as AWS CLI or a native application) to register with AWS SSO. The service also
- *       enables the client to fetch the user’s access token upon successful authentication and
- *       authorization with AWS SSO. This service conforms with the OAuth 2.0 based implementation of
- *       the device authorization grant standard (<a href="https://tools.ietf.org/html/rfc8628">https://tools.ietf.org/html/rfc8628</a>).</p>
- *
- *          <p>For general information about AWS SSO, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">What is AWS
- *         Single Sign-On?</a> in the <i>AWS SSO User Guide</i>.</p>
- *
- *          <p>This API reference guide describes the AWS SSO OIDC operations that you can call
- *       programatically and includes detailed information on data types and errors.</p>
- *
+ * <p>Amazon Web Services Single Sign On OpenID Connect (OIDC) is a web service that enables a client (such as Amazon Web Services CLI
+ *       or a native application) to register with Amazon Web Services SSO. The service also enables the client to
+ *       fetch the user’s access token upon successful authentication and authorization with
+ *       Amazon Web Services SSO.</p>
  *          <note>
- *             <p>AWS provides SDKs that consist of libraries and sample code for various programming
- *         languages and platforms such as Java, Ruby, .Net, iOS, and Android. The SDKs provide a
- *         convenient way to create programmatic access to AWS SSO and other AWS services. For more
- *         information about the AWS SDKs, including how to download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>.</p>
+ *             <p>Although Amazon Web Services Single Sign-On was renamed, the <code>sso</code> and
+ *         <code>identitystore</code> API namespaces will continue to retain their original name for
+ *         backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">Amazon Web Services SSO rename</a>.</p>
  *          </note>
+ *          <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 Amazon Web Services SSO OIDC service works.</p>
+ *          <ul>
+ *             <li>
+ *                <p>The Amazon Web Services SSO OIDC service currently implements only the portions of the OAuth 2.0
+ *           Device Authorization Grant standard (<a href="https://tools.ietf.org/html/rfc8628">https://tools.ietf.org/html/rfc8628</a>) that are necessary to enable single
+ *           sign-on authentication with the AWS CLI. Support for other OIDC flows frequently needed
+ *           for native applications, such as Authorization Code Flow (+ PKCE), will be addressed in
+ *           future releases.</p>
+ *             </li>
+ *             <li>
+ *                <p>The service emits only OIDC access tokens, such that obtaining a new token (For
+ *           example, token refresh) requires explicit user re-authentication.</p>
+ *             </li>
+ *             <li>
+ *                <p>The access tokens provided by this service grant access to all AWS account
+ *           entitlements assigned to an Amazon Web Services SSO user, not just a particular application.</p>
+ *             </li>
+ *             <li>
+ *                <p>The documentation in this guide does not describe the mechanism to convert the access
+ *           token into AWS Auth (“sigv4”) credentials for use with IAM-protected AWS service
+ *           endpoints. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/PortalAPIReference/API_GetRoleCredentials.html">GetRoleCredentials</a> in the <i>Amazon Web Services SSO Portal API Reference
+ *             Guide</i>.</p>
+ *             </li>
+ *          </ul>
+ *
+ *          <p>For general information about Amazon Web Services SSO, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">What is
+ *         Amazon Web Services SSO?</a> in the <i>Amazon Web Services SSO User Guide</i>.</p>
  */
 export class SSOOIDC extends SSOOIDCClient {
   /**
    * <p>Creates and returns an access token for the authorized client. The access token issued
-   *       will be used to fetch short-term credentials for the assigned roles in the AWS
+   *       will be used to fetch short-term credentials for the assigned roles in the Amazon Web Services
    *       account.</p>
    */
   public createToken(args: CreateTokenCommandInput, options?: __HttpHandlerOptions): Promise<CreateTokenCommandOutput>;
@@ -64,7 +86,7 @@ export class SSOOIDC extends SSOOIDCClient {
   }
 
   /**
-   * <p>Registers a client with AWS SSO. This allows clients to initiate device authorization.
+   * <p>Registers a client with Amazon Web Services SSO. This allows clients to initiate device authorization.
    *       The output should be persisted for reuse through many authentication requests.</p>
    */
   public registerClient(
@@ -97,7 +119,8 @@ export class SSOOIDC extends SSOOIDCClient {
   }
 
   /**
-   * <p>Initiates device authorization by requesting a pair of verification codes from the authorization service.</p>
+   * <p>Initiates device authorization by requesting a pair of verification codes from the
+   *       authorization service.</p>
    */
   public startDeviceAuthorization(
     args: StartDeviceAuthorizationCommandInput,

diff --git a/clients/client-sso-oidc/src/SSOOIDCClient.ts b/clients/client-sso-oidc/src/SSOOIDCClient.ts
@@ -210,24 +210,46 @@ type SSOOIDCClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandl
 export interface SSOOIDCClientResolvedConfig extends SSOOIDCClientResolvedConfigType {}
 
 /**
- * <p>AWS Single Sign-On (SSO) OpenID Connect (OIDC) is a web service that enables a client
- *       (such as AWS CLI or a native application) to register with AWS SSO. The service also
- *       enables the client to fetch the user’s access token upon successful authentication and
- *       authorization with AWS SSO. This service conforms with the OAuth 2.0 based implementation of
- *       the device authorization grant standard (<a href="https://tools.ietf.org/html/rfc8628">https://tools.ietf.org/html/rfc8628</a>).</p>
- *
- *          <p>For general information about AWS SSO, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">What is AWS
- *         Single Sign-On?</a> in the <i>AWS SSO User Guide</i>.</p>
- *
- *          <p>This API reference guide describes the AWS SSO OIDC operations that you can call
- *       programatically and includes detailed information on data types and errors.</p>
- *
+ * <p>Amazon Web Services Single Sign On OpenID Connect (OIDC) is a web service that enables a client (such as Amazon Web Services CLI
+ *       or a native application) to register with Amazon Web Services SSO. The service also enables the client to
+ *       fetch the user’s access token upon successful authentication and authorization with
+ *       Amazon Web Services SSO.</p>
  *          <note>
- *             <p>AWS provides SDKs that consist of libraries and sample code for various programming
- *         languages and platforms such as Java, Ruby, .Net, iOS, and Android. The SDKs provide a
- *         convenient way to create programmatic access to AWS SSO and other AWS services. For more
- *         information about the AWS SDKs, including how to download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>.</p>
+ *             <p>Although Amazon Web Services Single Sign-On was renamed, the <code>sso</code> and
+ *         <code>identitystore</code> API namespaces will continue to retain their original name for
+ *         backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">Amazon Web Services SSO rename</a>.</p>
  *          </note>
+ *          <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 Amazon Web Services SSO OIDC service works.</p>
+ *          <ul>
+ *             <li>
+ *                <p>The Amazon Web Services SSO OIDC service currently implements only the portions of the OAuth 2.0
+ *           Device Authorization Grant standard (<a href="https://tools.ietf.org/html/rfc8628">https://tools.ietf.org/html/rfc8628</a>) that are necessary to enable single
+ *           sign-on authentication with the AWS CLI. Support for other OIDC flows frequently needed
+ *           for native applications, such as Authorization Code Flow (+ PKCE), will be addressed in
+ *           future releases.</p>
+ *             </li>
+ *             <li>
+ *                <p>The service emits only OIDC access tokens, such that obtaining a new token (For
+ *           example, token refresh) requires explicit user re-authentication.</p>
+ *             </li>
+ *             <li>
+ *                <p>The access tokens provided by this service grant access to all AWS account
+ *           entitlements assigned to an Amazon Web Services SSO user, not just a particular application.</p>
+ *             </li>
+ *             <li>
+ *                <p>The documentation in this guide does not describe the mechanism to convert the access
+ *           token into AWS Auth (“sigv4”) credentials for use with IAM-protected AWS service
+ *           endpoints. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/PortalAPIReference/API_GetRoleCredentials.html">GetRoleCredentials</a> in the <i>Amazon Web Services SSO Portal API Reference
+ *             Guide</i>.</p>
+ *             </li>
+ *          </ul>
+ *
+ *          <p>For general information about Amazon Web Services SSO, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">What is
+ *         Amazon Web Services SSO?</a> in the <i>Amazon Web Services SSO User Guide</i>.</p>
  */
 export class SSOOIDCClient extends __Client<
   __HttpHandlerOptions,

diff --git a/clients/client-sso-oidc/src/commands/CreateTokenCommand.ts b/clients/client-sso-oidc/src/commands/CreateTokenCommand.ts
@@ -29,7 +29,7 @@ export interface CreateTokenCommandOutput extends CreateTokenResponse, __Metadat
 
 /**
  * <p>Creates and returns an access token for the authorized client. The access token issued
- *       will be used to fetch short-term credentials for the assigned roles in the AWS
+ *       will be used to fetch short-term credentials for the assigned roles in the Amazon Web Services
  *       account.</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/RegisterClientCommand.ts b/clients/client-sso-oidc/src/commands/RegisterClientCommand.ts
@@ -28,7 +28,7 @@ export interface RegisterClientCommandInput extends RegisterClientRequest {}
 export interface RegisterClientCommandOutput extends RegisterClientResponse, __MetadataBearer {}
 
 /**
- * <p>Registers a client with AWS SSO. This allows clients to initiate device authorization.
+ * <p>Registers a client with Amazon Web Services SSO. This allows clients to initiate device authorization.
  *       The output should be persisted for reuse through many authentication requests.</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/StartDeviceAuthorizationCommand.ts b/clients/client-sso-oidc/src/commands/StartDeviceAuthorizationCommand.ts
@@ -28,7 +28,8 @@ export interface StartDeviceAuthorizationCommandInput extends StartDeviceAuthori
 export interface StartDeviceAuthorizationCommandOutput extends StartDeviceAuthorizationResponse, __MetadataBearer {}
 
 /**
- * <p>Initiates device authorization by requesting a pair of verification codes from the authorization service.</p>
+ * <p>Initiates device authorization by requesting a pair of verification codes from the
+ *       authorization service.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript