@aws-sdk/client-sso-oidc 3.295.0 → 3.297.0

package/dist-types/SSOOIDC.d.ts

@@ -4,6 +4,7 @@ import { RegisterClientCommandInput, RegisterClientCommandOutput } from "./comma
 import { StartDeviceAuthorizationCommandInput, StartDeviceAuthorizationCommandOutput } from "./commands/StartDeviceAuthorizationCommand";
 import { SSOOIDCClient } from "./SSOOIDCClient";
 /**
+ * @public
  * <p>AWS IAM Identity Center (successor to AWS Single Sign-On) OpenID Connect (OIDC) is a web service that enables a client (such as AWS 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
@@ -47,6 +48,7 @@ import { SSOOIDCClient } from "./SSOOIDCClient";
  */
 export declare class SSOOIDC extends SSOOIDCClient {
     /**
+     * @public
      * <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
      *       account.</p>
@@ -55,6 +57,7 @@ export declare class SSOOIDC extends SSOOIDCClient {
     createToken(args: CreateTokenCommandInput, cb: (err: any, data?: CreateTokenCommandOutput) => void): void;
     createToken(args: CreateTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTokenCommandOutput) => void): void;
     /**
+     * @public
      * <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>
      */
@@ -62,6 +65,7 @@ export declare class SSOOIDC extends SSOOIDCClient {
     registerClient(args: RegisterClientCommandInput, cb: (err: any, data?: RegisterClientCommandOutput) => void): void;
     registerClient(args: RegisterClientCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterClientCommandOutput) => void): void;
     /**
+     * @public
      * <p>Initiates device authorization by requesting a pair of verification codes from the
      *       authorization service.</p>
      */

package/dist-types/SSOOIDCClient.d.ts

@@ -10,15 +10,24 @@ import { CreateTokenCommandInput, CreateTokenCommandOutput } from "./commands/Cr
 import { RegisterClientCommandInput, RegisterClientCommandOutput } from "./commands/RegisterClientCommand";
 import { StartDeviceAuthorizationCommandInput, StartDeviceAuthorizationCommandOutput } from "./commands/StartDeviceAuthorizationCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = CreateTokenCommandInput | RegisterClientCommandInput | StartDeviceAuthorizationCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = CreateTokenCommandOutput | RegisterClientCommandOutput | StartDeviceAuthorizationCommandOutput;
+/**
+ * @public
+ */
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.
      */
     requestHandler?: __HttpHandler;
     /**
-     * A constructor for a class implementing the {@link __Checksum} interface
+     * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
      * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
      * @internal
      */
@@ -103,23 +112,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
      */
     logger?: __Logger;
     /**
-     * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
      */
     defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
 }
+/**
+ * @public
+ */
 type SSOOIDCClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of SSOOIDCClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of SSOOIDCClient class constructor that set the region, credentials and other options.
  */
 export interface SSOOIDCClientConfig extends SSOOIDCClientConfigType {
 }
+/**
+ * @public
+ */
 type SSOOIDCClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of SSOOIDCClient class. This is resolved and normalized from the {@link SSOOIDCClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of SSOOIDCClient class. This is resolved and normalized from the {@link SSOOIDCClientConfig | constructor configuration interface}.
  */
 export interface SSOOIDCClientResolvedConfig extends SSOOIDCClientResolvedConfigType {
 }
 /**
+ * @public
  * <p>AWS IAM Identity Center (successor to AWS Single Sign-On) OpenID Connect (OIDC) is a web service that enables a client (such as AWS 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

package/dist-types/commands/CreateTokenCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CreateTokenRequest, CreateTokenResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SSOOIDCClientResolvedConfig } from "../SSOOIDCClient";
 /**
+ * @public
+ *
  * The input for {@link CreateTokenCommand}.
  */
 export interface CreateTokenCommandInput extends CreateTokenRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateTokenCommand}.
  */
 export interface CreateTokenCommandOutput extends CreateTokenResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <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
  *       account.</p>
@@ -27,6 +32,8 @@ export interface CreateTokenCommandOutput extends CreateTokenResponse, __Metadat
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateTokenCommandInput - {@link CreateTokenCommandInput}
+ * @returns {@link CreateTokenCommandOutput}
  * @see {@link CreateTokenCommandInput} for command's `input` shape.
  * @see {@link CreateTokenCommandOutput} for command's `response` shape.
  * @see {@link SSOOIDCClientResolvedConfig | config} for SSOOIDCClient's `config` shape.
@@ -77,11 +84,20 @@ export interface CreateTokenCommandOutput extends CreateTokenResponse, __Metadat
 export declare class CreateTokenCommand extends $Command<CreateTokenCommandInput, CreateTokenCommandOutput, SSOOIDCClientResolvedConfig> {
     readonly input: CreateTokenCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateTokenCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSOOIDCClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateTokenCommandInput, CreateTokenCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/RegisterClientCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { RegisterClientRequest, RegisterClientResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SSOOIDCClientResolvedConfig } from "../SSOOIDCClient";
 /**
+ * @public
+ *
  * The input for {@link RegisterClientCommand}.
  */
 export interface RegisterClientCommandInput extends RegisterClientRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link RegisterClientCommand}.
  */
 export interface RegisterClientCommandOutput extends RegisterClientResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <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>
  * @example
@@ -26,6 +31,8 @@ export interface RegisterClientCommandOutput extends RegisterClientResponse, __M
  * const response = await client.send(command);
  * ```
  *
+ * @param RegisterClientCommandInput - {@link RegisterClientCommandInput}
+ * @returns {@link RegisterClientCommandOutput}
  * @see {@link RegisterClientCommandInput} for command's `input` shape.
  * @see {@link RegisterClientCommandOutput} for command's `response` shape.
  * @see {@link SSOOIDCClientResolvedConfig | config} for SSOOIDCClient's `config` shape.
@@ -50,11 +57,20 @@ export interface RegisterClientCommandOutput extends RegisterClientResponse, __M
 export declare class RegisterClientCommand extends $Command<RegisterClientCommandInput, RegisterClientCommandOutput, SSOOIDCClientResolvedConfig> {
     readonly input: RegisterClientCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: RegisterClientCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSOOIDCClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RegisterClientCommandInput, RegisterClientCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/StartDeviceAuthorizationCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { StartDeviceAuthorizationRequest, StartDeviceAuthorizationResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SSOOIDCClientResolvedConfig } from "../SSOOIDCClient";
 /**
+ * @public
+ *
  * The input for {@link StartDeviceAuthorizationCommand}.
  */
 export interface StartDeviceAuthorizationCommandInput extends StartDeviceAuthorizationRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link StartDeviceAuthorizationCommand}.
  */
 export interface StartDeviceAuthorizationCommandOutput extends StartDeviceAuthorizationResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Initiates device authorization by requesting a pair of verification codes from the
  *       authorization service.</p>
  * @example
@@ -26,6 +31,8 @@ export interface StartDeviceAuthorizationCommandOutput extends StartDeviceAuthor
  * const response = await client.send(command);
  * ```
  *
+ * @param StartDeviceAuthorizationCommandInput - {@link StartDeviceAuthorizationCommandInput}
+ * @returns {@link StartDeviceAuthorizationCommandOutput}
  * @see {@link StartDeviceAuthorizationCommandInput} for command's `input` shape.
  * @see {@link StartDeviceAuthorizationCommandOutput} for command's `response` shape.
  * @see {@link SSOOIDCClientResolvedConfig | config} for SSOOIDCClient's `config` shape.
@@ -56,11 +63,20 @@ export interface StartDeviceAuthorizationCommandOutput extends StartDeviceAuthor
 export declare class StartDeviceAuthorizationCommand extends $Command<StartDeviceAuthorizationCommandInput, StartDeviceAuthorizationCommandOutput, SSOOIDCClientResolvedConfig> {
     readonly input: StartDeviceAuthorizationCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StartDeviceAuthorizationCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSOOIDCClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartDeviceAuthorizationCommandInput, StartDeviceAuthorizationCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/SSOOIDCServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from SSOOIDC service.
  */
 export declare class SSOOIDCServiceException extends __ServiceException {

package/dist-types/models/models_0.d.ts

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { SSOOIDCServiceException as __BaseException } from "./SSOOIDCServiceException";
 /**
+ * @public
  * <p>You do not have sufficient access to perform this action.</p>
  */
 export declare class AccessDeniedException extends __BaseException {
@@ -14,6 +15,7 @@ export declare class AccessDeniedException extends __BaseException {
     constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
 }
 /**
+ * @public
  * <p>Indicates that a request to authorize a client with an access user session token is
  *       pending.</p>
  */
@@ -27,6 +29,9 @@ export declare class AuthorizationPendingException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<AuthorizationPendingException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface CreateTokenRequest {
     /**
      * <p>The unique identifier string for each client. This value should come from the persisted
@@ -81,6 +86,9 @@ export interface CreateTokenRequest {
      */
     redirectUri?: string;
 }
+/**
+ * @public
+ */
 export interface CreateTokenResponse {
     /**
      * <p>An opaque token to access IAM Identity Center resources assigned to a user.</p>
@@ -114,6 +122,7 @@ export interface CreateTokenResponse {
     idToken?: string;
 }
 /**
+ * @public
  * <p>Indicates that the token issued by the service is expired and is no longer valid.</p>
  */
 export declare class ExpiredTokenException extends __BaseException {
@@ -127,6 +136,7 @@ export declare class ExpiredTokenException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ExpiredTokenException, __BaseException>);
 }
 /**
+ * @public
  * <p>Indicates that an error from the service occurred while trying to process a
  *       request.</p>
  */
@@ -141,6 +151,7 @@ export declare class InternalServerException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
 }
 /**
+ * @public
  * <p>Indicates that the <code>clientId</code> or <code>clientSecret</code> in the request is
  *       invalid. For example, this can occur when a client sends an incorrect <code>clientId</code> or
  *       an expired <code>clientSecret</code>.</p>
@@ -156,6 +167,7 @@ export declare class InvalidClientException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidClientException, __BaseException>);
 }
 /**
+ * @public
  * <p>Indicates that a request contains an invalid grant. This can occur if a client makes a
  *         <a>CreateToken</a> request with an invalid grant type.</p>
  */
@@ -170,6 +182,7 @@ export declare class InvalidGrantException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidGrantException, __BaseException>);
 }
 /**
+ * @public
  * <p>Indicates that something is wrong with the input to the request. For example, a required
  *       parameter might be missing or out of range.</p>
  */
@@ -184,6 +197,7 @@ export declare class InvalidRequestException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
 }
 /**
+ * @public
  * <p>Indicates that the scope provided in the request is invalid.</p>
  */
 export declare class InvalidScopeException extends __BaseException {
@@ -197,6 +211,7 @@ export declare class InvalidScopeException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidScopeException, __BaseException>);
 }
 /**
+ * @public
  * <p>Indicates that the client is making the request too frequently and is more than the
  *       service can handle. </p>
  */
@@ -211,6 +226,7 @@ export declare class SlowDownException extends __BaseException {
     constructor(opts: __ExceptionOptionType<SlowDownException, __BaseException>);
 }
 /**
+ * @public
  * <p>Indicates that the client is not currently authorized to make the request. This can happen
  *       when a <code>clientId</code> is not issued for a public client.</p>
  */
@@ -225,6 +241,7 @@ export declare class UnauthorizedClientException extends __BaseException {
     constructor(opts: __ExceptionOptionType<UnauthorizedClientException, __BaseException>);
 }
 /**
+ * @public
  * <p>Indicates that the grant type in the request is not supported by the service.</p>
  */
 export declare class UnsupportedGrantTypeException extends __BaseException {
@@ -238,6 +255,7 @@ export declare class UnsupportedGrantTypeException extends __BaseException {
     constructor(opts: __ExceptionOptionType<UnsupportedGrantTypeException, __BaseException>);
 }
 /**
+ * @public
  * <p>Indicates that the client information sent in the request during registration is
  *       invalid.</p>
  */
@@ -251,6 +269,9 @@ export declare class InvalidClientMetadataException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<InvalidClientMetadataException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface RegisterClientRequest {
     /**
      * <p>The friendly name of the client.</p>
@@ -267,6 +288,9 @@ export interface RegisterClientRequest {
      */
     scopes?: string[];
 }
+/**
+ * @public
+ */
 export interface RegisterClientResponse {
     /**
      * <p>The unique identifier string for each client. This client uses this identifier to get
@@ -297,6 +321,9 @@ export interface RegisterClientResponse {
      */
     tokenEndpoint?: string;
 }
+/**
+ * @public
+ */
 export interface StartDeviceAuthorizationRequest {
     /**
      * <p>The unique identifier string for the client that is registered with IAM Identity Center. This value
@@ -315,6 +342,9 @@ export interface StartDeviceAuthorizationRequest {
      */
     startUrl: string | undefined;
 }
+/**
+ * @public
+ */
 export interface StartDeviceAuthorizationResponse {
     /**
      * <p>The short-lived code that is used by the device when polling for a session token.</p>

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-sso-oidc",
   "description": "AWS SDK for JavaScript Sso Oidc Client for Node.js, Browser and React Native",
-  "version": "3.295.0",
+  "version": "3.297.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,34 +20,34 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/config-resolver": "3.295.0",
-    "@aws-sdk/fetch-http-handler": "3.295.0",
-    "@aws-sdk/hash-node": "3.295.0",
-    "@aws-sdk/invalid-dependency": "3.295.0",
-    "@aws-sdk/middleware-content-length": "3.295.0",
-    "@aws-sdk/middleware-endpoint": "3.295.0",
-    "@aws-sdk/middleware-host-header": "3.295.0",
-    "@aws-sdk/middleware-logger": "3.295.0",
-    "@aws-sdk/middleware-recursion-detection": "3.295.0",
-    "@aws-sdk/middleware-retry": "3.295.0",
-    "@aws-sdk/middleware-serde": "3.295.0",
-    "@aws-sdk/middleware-stack": "3.295.0",
-    "@aws-sdk/middleware-user-agent": "3.295.0",
-    "@aws-sdk/node-config-provider": "3.295.0",
-    "@aws-sdk/node-http-handler": "3.295.0",
-    "@aws-sdk/protocol-http": "3.295.0",
-    "@aws-sdk/smithy-client": "3.295.0",
-    "@aws-sdk/types": "3.295.0",
-    "@aws-sdk/url-parser": "3.295.0",
+    "@aws-sdk/config-resolver": "3.296.0",
+    "@aws-sdk/fetch-http-handler": "3.296.0",
+    "@aws-sdk/hash-node": "3.296.0",
+    "@aws-sdk/invalid-dependency": "3.296.0",
+    "@aws-sdk/middleware-content-length": "3.296.0",
+    "@aws-sdk/middleware-endpoint": "3.296.0",
+    "@aws-sdk/middleware-host-header": "3.296.0",
+    "@aws-sdk/middleware-logger": "3.296.0",
+    "@aws-sdk/middleware-recursion-detection": "3.296.0",
+    "@aws-sdk/middleware-retry": "3.296.0",
+    "@aws-sdk/middleware-serde": "3.296.0",
+    "@aws-sdk/middleware-stack": "3.296.0",
+    "@aws-sdk/middleware-user-agent": "3.296.0",
+    "@aws-sdk/node-config-provider": "3.296.0",
+    "@aws-sdk/node-http-handler": "3.296.0",
+    "@aws-sdk/protocol-http": "3.296.0",
+    "@aws-sdk/smithy-client": "3.296.0",
+    "@aws-sdk/types": "3.296.0",
+    "@aws-sdk/url-parser": "3.296.0",
     "@aws-sdk/util-base64": "3.295.0",
     "@aws-sdk/util-body-length-browser": "3.295.0",
     "@aws-sdk/util-body-length-node": "3.295.0",
-    "@aws-sdk/util-defaults-mode-browser": "3.295.0",
-    "@aws-sdk/util-defaults-mode-node": "3.295.0",
-    "@aws-sdk/util-endpoints": "3.295.0",
-    "@aws-sdk/util-retry": "3.295.0",
-    "@aws-sdk/util-user-agent-browser": "3.295.0",
-    "@aws-sdk/util-user-agent-node": "3.295.0",
+    "@aws-sdk/util-defaults-mode-browser": "3.296.0",
+    "@aws-sdk/util-defaults-mode-node": "3.296.0",
+    "@aws-sdk/util-endpoints": "3.296.0",
+    "@aws-sdk/util-retry": "3.296.0",
+    "@aws-sdk/util-user-agent-browser": "3.296.0",
+    "@aws-sdk/util-user-agent-node": "3.296.0",
     "@aws-sdk/util-utf8": "3.295.0",
     "tslib": "^2.5.0"
   },