@mavogel/awscdk-rootmail 0.0.20 → 0.0.21

package/node_modules/@aws-sdk/client-sso-oidc/dist-types/models/models_0.d.ts

@@ -1,22 +1,22 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
 import { SSOOIDCServiceException as __BaseException } from "./SSOOIDCServiceException";
 /**
- * @public
  * <p>You do not have sufficient access to perform this action.</p>
+ * @public
  */
 export declare class AccessDeniedException extends __BaseException {
     readonly name: "AccessDeniedException";
     readonly $fault: "client";
     /**
-     * @public
      * <p>Single error code.
      *       For this exception the value will be <code>access_denied</code>.</p>
+     * @public
      */
     error?: string;
     /**
-     * @public
      * <p>Human-readable text providing additional information, used to assist the
      *       client developer in understanding the error that occurred.</p>
+     * @public
      */
     error_description?: string;
     /**
@@ -25,23 +25,23 @@ 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>
+ * @public
  */
 export declare class AuthorizationPendingException extends __BaseException {
     readonly name: "AuthorizationPendingException";
     readonly $fault: "client";
     /**
-     * @public
      * <p>Single error code.
      *       For this exception the value will be <code>authorization_pending</code>.</p>
+     * @public
      */
     error?: string;
     /**
-     * @public
      * <p>Human-readable text providing additional information, used to assist the
      *       client developer in understanding the error that occurred.</p>
+     * @public
      */
     error_description?: string;
     /**
@@ -54,19 +54,18 @@ export declare class AuthorizationPendingException extends __BaseException {
  */
 export interface CreateTokenRequest {
     /**
-     * @public
      * <p>The unique identifier string for the client or application. This value comes from the
      *       result of the <a>RegisterClient</a> API.</p>
+     * @public
      */
     clientId: string | undefined;
     /**
-     * @public
      * <p>A secret string generated for the client. This value should come from the persisted result
      *       of the <a>RegisterClient</a> API.</p>
+     * @public
      */
     clientSecret: string | undefined;
     /**
-     * @public
      * <p>Supports the following OAuth grant types: Device Code and Refresh Token.
      *       Specify either of the following values, depending on the grant type that you want:</p>
      *          <p>* Device Code - <code>urn:ietf:params:oauth:grant-type:device_code</code>
@@ -74,44 +73,45 @@ export interface CreateTokenRequest {
      *          <p>* Refresh Token - <code>refresh_token</code>
      *          </p>
      *          <p>For information about how to obtain the device code, see the <a>StartDeviceAuthorization</a> topic.</p>
+     * @public
      */
     grantType: string | undefined;
     /**
-     * @public
      * <p>Used only when calling this API for the Device Code grant type. This short-term code is
      *       used to identify this authorization request. This comes from the result of the
      *       <a>StartDeviceAuthorization</a> API.</p>
+     * @public
      */
     deviceCode?: string;
     /**
-     * @public
      * <p>Used only when calling this API for the Authorization Code grant type. The short-term code is
      *       used to identify this authorization request. This grant type is currently unsupported for the
      *       <a>CreateToken</a> API.</p>
+     * @public
      */
     code?: string;
     /**
-     * @public
      * <p>Used only when calling this API for the Refresh Token grant type. This token is used to
      *       refresh short-term tokens, such as the access token, that might expire.</p>
      *          <p>For more information about the features and limitations of the current IAM Identity Center OIDC
      *       implementation, see <i>Considerations for Using this Guide</i> in the <a href="https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html">IAM Identity Center
      *       OIDC API Reference</a>.</p>
+     * @public
      */
     refreshToken?: string;
     /**
-     * @public
      * <p>The list of scopes for which authorization is requested. The access token that is issued
      *       is limited to the scopes that are granted. If this value is not specified, IAM Identity Center authorizes
      *       all scopes that are configured for the client during the call to
      *       <a>RegisterClient</a>.</p>
+     * @public
      */
     scope?: string[];
     /**
-     * @public
      * <p>Used only when calling this API for the Authorization Code grant type. This value specifies
      *       the location of the client or application that has registered to receive the authorization
      *         code.</p>
+     * @public
      */
     redirectUri?: string;
 }
@@ -120,59 +120,59 @@ export interface CreateTokenRequest {
  */
 export interface CreateTokenResponse {
     /**
-     * @public
      * <p>A bearer token to access AWS accounts and applications assigned to a user.</p>
+     * @public
      */
     accessToken?: string;
     /**
-     * @public
      * <p>Used to notify the client that the returned token is an access token. The supported token
      *       type is <code>Bearer</code>.</p>
+     * @public
      */
     tokenType?: string;
     /**
-     * @public
      * <p>Indicates the time in seconds when an access token will expire.</p>
+     * @public
      */
     expiresIn?: number;
     /**
-     * @public
      * <p>A token that, if present, can be used to refresh a previously issued access token that
      *       might have expired.</p>
      *          <p>For more
      *       information about the features and limitations of the current IAM Identity Center OIDC implementation,
      *       see <i>Considerations for Using this Guide</i> in the <a href="https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html">IAM Identity Center
      *         OIDC API Reference</a>.</p>
+     * @public
      */
     refreshToken?: string;
     /**
-     * @public
      * <p>The <code>idToken</code> is not implemented or supported. For more information about the
      *       features and limitations of the current IAM Identity Center OIDC implementation, see <i>Considerations
      *       for Using this Guide</i> in the <a href="https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html">IAM Identity Center
      *       OIDC API Reference</a>.</p>
      *          <p>A JSON Web Token (JWT) that identifies who is associated with the issued access token.
      *       </p>
+     * @public
      */
     idToken?: string;
 }
 /**
- * @public
  * <p>Indicates that the token issued by the service is expired and is no longer valid.</p>
+ * @public
  */
 export declare class ExpiredTokenException extends __BaseException {
     readonly name: "ExpiredTokenException";
     readonly $fault: "client";
     /**
-     * @public
      * <p>Single error code.
      *       For this exception the value will be <code>expired_token</code>.</p>
+     * @public
      */
     error?: string;
     /**
-     * @public
      * <p>Human-readable text providing additional information, used to assist the
      *       client developer in understanding the error that occurred.</p>
+     * @public
      */
     error_description?: string;
     /**
@@ -181,23 +181,23 @@ 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>
+ * @public
  */
 export declare class InternalServerException extends __BaseException {
     readonly name: "InternalServerException";
     readonly $fault: "server";
     /**
-     * @public
      * <p>Single error code.
      *       For this exception the value will be <code>server_error</code>.</p>
+     * @public
      */
     error?: string;
     /**
-     * @public
      * <p>Human-readable text providing additional information, used to assist the
      *       client developer in understanding the error that occurred.</p>
+     * @public
      */
     error_description?: string;
     /**
@@ -206,24 +206,24 @@ 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>
+ * @public
  */
 export declare class InvalidClientException extends __BaseException {
     readonly name: "InvalidClientException";
     readonly $fault: "client";
     /**
-     * @public
      * <p>Single error code.
      *       For this exception the value will be <code>invalid_client</code>.</p>
+     * @public
      */
     error?: string;
     /**
-     * @public
      * <p>Human-readable text providing additional information, used to assist the
      *       client developer in understanding the error that occurred.</p>
+     * @public
      */
     error_description?: string;
     /**
@@ -232,23 +232,23 @@ 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>
+ * @public
  */
 export declare class InvalidGrantException extends __BaseException {
     readonly name: "InvalidGrantException";
     readonly $fault: "client";
     /**
-     * @public
      * <p>Single error code.
      *       For this exception the value will be <code>invalid_grant</code>.</p>
+     * @public
      */
     error?: string;
     /**
-     * @public
      * <p>Human-readable text providing additional information, used to assist the
      *       client developer in understanding the error that occurred.</p>
+     * @public
      */
     error_description?: string;
     /**
@@ -257,23 +257,23 @@ 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>
+ * @public
  */
 export declare class InvalidRequestException extends __BaseException {
     readonly name: "InvalidRequestException";
     readonly $fault: "client";
     /**
-     * @public
      * <p>Single error code.
      *       For this exception the value will be <code>invalid_request</code>.</p>
+     * @public
      */
     error?: string;
     /**
-     * @public
      * <p>Human-readable text providing additional information, used to assist the
      *       client developer in understanding the error that occurred.</p>
+     * @public
      */
     error_description?: string;
     /**
@@ -282,22 +282,22 @@ export declare class InvalidRequestException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
 }
 /**
- * @public
  * <p>Indicates that the scope provided in the request is invalid.</p>
+ * @public
  */
 export declare class InvalidScopeException extends __BaseException {
     readonly name: "InvalidScopeException";
     readonly $fault: "client";
     /**
-     * @public
      * <p>Single error code.
      *       For this exception the value will be <code>invalid_scope</code>.</p>
+     * @public
      */
     error?: string;
     /**
-     * @public
      * <p>Human-readable text providing additional information, used to assist the
      *       client developer in understanding the error that occurred.</p>
+     * @public
      */
     error_description?: string;
     /**
@@ -306,23 +306,23 @@ 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>
+ * @public
  */
 export declare class SlowDownException extends __BaseException {
     readonly name: "SlowDownException";
     readonly $fault: "client";
     /**
-     * @public
      * <p>Single error code.
      *       For this exception the value will be <code>slow_down</code>.</p>
+     * @public
      */
     error?: string;
     /**
-     * @public
      * <p>Human-readable text providing additional information, used to assist the
      *       client developer in understanding the error that occurred.</p>
+     * @public
      */
     error_description?: string;
     /**
@@ -331,23 +331,23 @@ 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>
+ * @public
  */
 export declare class UnauthorizedClientException extends __BaseException {
     readonly name: "UnauthorizedClientException";
     readonly $fault: "client";
     /**
-     * @public
      * <p>Single error code.
      *       For this exception the value will be <code>unauthorized_client</code>.</p>
+     * @public
      */
     error?: string;
     /**
-     * @public
      * <p>Human-readable text providing additional information, used to assist the
      *       client developer in understanding the error that occurred.</p>
+     * @public
      */
     error_description?: string;
     /**
@@ -356,22 +356,22 @@ 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>
+ * @public
  */
 export declare class UnsupportedGrantTypeException extends __BaseException {
     readonly name: "UnsupportedGrantTypeException";
     readonly $fault: "client";
     /**
-     * @public
      * <p>Single error code.
      *       For this exception the value will be <code>unsupported_grant_type</code>.</p>
+     * @public
      */
     error?: string;
     /**
-     * @public
      * <p>Human-readable text providing additional information, used to assist the
      *       client developer in understanding the error that occurred.</p>
+     * @public
      */
     error_description?: string;
     /**
@@ -384,13 +384,12 @@ export declare class UnsupportedGrantTypeException extends __BaseException {
  */
 export interface CreateTokenWithIAMRequest {
     /**
-     * @public
      * <p>The unique identifier string for the client or application. This value is an application
      *       ARN that has OAuth grants configured.</p>
+     * @public
      */
     clientId: string | undefined;
     /**
-     * @public
      * <p>Supports the following OAuth grant types: Authorization Code, Refresh Token, JWT Bearer,
      *       and Token Exchange. Specify one of the following values, depending on the grant type that you
      *       want:</p>
@@ -402,72 +401,73 @@ export interface CreateTokenWithIAMRequest {
      *          </p>
      *          <p>* Token Exchange - <code>urn:ietf:params:oauth:grant-type:token-exchange</code>
      *          </p>
+     * @public
      */
     grantType: string | undefined;
     /**
-     * @public
      * <p>Used only when calling this API for the Authorization Code grant type. This short-term
      *         code is used to identify this authorization request. The code is obtained through a redirect
      *         from IAM Identity Center to a redirect URI persisted in the Authorization Code GrantOptions for the
      *         application.</p>
+     * @public
      */
     code?: string;
     /**
-     * @public
      * <p>Used only when calling this API for the Refresh Token grant type. This token is used to
      *       refresh short-term tokens, such as the access token, that might expire.</p>
      *          <p>For more information about the features and limitations of the current IAM Identity Center OIDC
      *       implementation, see <i>Considerations for Using this Guide</i> in the <a href="https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html">IAM Identity Center
      *       OIDC API Reference</a>.</p>
+     * @public
      */
     refreshToken?: string;
     /**
-     * @public
      * <p>Used only when calling this API for the JWT Bearer grant type. This value specifies the JSON
      *       Web Token (JWT) issued by a trusted token issuer. To authorize a trusted token issuer,
      *       configure the JWT Bearer GrantOptions for the application.</p>
+     * @public
      */
     assertion?: string;
     /**
-     * @public
      * <p>The list of scopes for which authorization is requested. The access token that is issued
      *       is limited to the scopes that are granted. If the value is not specified, IAM Identity Center authorizes all
      *       scopes configured for the application, including the following default scopes:
      *       <code>openid</code>, <code>aws</code>, <code>sts:identity_context</code>.</p>
+     * @public
      */
     scope?: string[];
     /**
-     * @public
      * <p>Used only when calling this API for the Authorization Code grant type. This value specifies
      *       the location of the client or application that has registered to receive the authorization code.
      *       </p>
+     * @public
      */
     redirectUri?: string;
     /**
-     * @public
      * <p>Used only when calling this API for the Token Exchange grant type. This value specifies
      *       the subject of the exchange. The value of the subject token must be an access token issued by
      *       IAM Identity Center to a different client or application. The access token must have authorized scopes
      *       that indicate the requested application as a target audience.</p>
+     * @public
      */
     subjectToken?: string;
     /**
-     * @public
      * <p>Used only when calling this API for the Token Exchange grant type. This value specifies
      *       the type of token that is passed as the subject of the exchange. The following value is
      *       supported:</p>
      *          <p>* Access Token - <code>urn:ietf:params:oauth:token-type:access_token</code>
      *          </p>
+     * @public
      */
     subjectTokenType?: string;
     /**
-     * @public
      * <p>Used only when calling this API for the Token Exchange grant type. This value specifies
      *       the type of token that the requester can receive. The following values are supported:</p>
      *          <p>* Access Token - <code>urn:ietf:params:oauth:token-type:access_token</code>
      *          </p>
      *          <p>* Refresh Token - <code>urn:ietf:params:oauth:token-type:refresh_token</code>
      *          </p>
+     * @public
      */
     requestedTokenType?: string;
 }
@@ -476,82 +476,82 @@ export interface CreateTokenWithIAMRequest {
  */
 export interface CreateTokenWithIAMResponse {
     /**
-     * @public
      * <p>A bearer token to access AWS accounts and applications assigned to a user.</p>
+     * @public
      */
     accessToken?: string;
     /**
-     * @public
      * <p>Used to notify the requester that the returned token is an access token. The supported
      *       token type is <code>Bearer</code>.</p>
+     * @public
      */
     tokenType?: string;
     /**
-     * @public
      * <p>Indicates the time in seconds when an access token will expire.</p>
+     * @public
      */
     expiresIn?: number;
     /**
-     * @public
      * <p>A token that, if present, can be used to refresh a previously issued access token that
      *       might have expired.</p>
      *          <p>For more
      *       information about the features and limitations of the current IAM Identity Center OIDC implementation,
      *       see <i>Considerations for Using this Guide</i> in the <a href="https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html">IAM Identity Center
      *         OIDC API Reference</a>.</p>
+     * @public
      */
     refreshToken?: string;
     /**
-     * @public
      * <p>A JSON Web Token (JWT) that identifies the user associated with the issued access token.
      *       </p>
+     * @public
      */
     idToken?: string;
     /**
-     * @public
      * <p>Indicates the type of tokens that are issued by IAM Identity Center. The following values are supported:
      *       </p>
      *          <p>* Access Token - <code>urn:ietf:params:oauth:token-type:access_token</code>
      *          </p>
      *          <p>* Refresh Token - <code>urn:ietf:params:oauth:token-type:refresh_token</code>
      *          </p>
+     * @public
      */
     issuedTokenType?: string;
     /**
-     * @public
      * <p>The list of scopes for which authorization is granted. The access token that is issued
      *       is limited to the scopes that are granted.</p>
+     * @public
      */
     scope?: string[];
 }
 /**
- * @public
  * <p>Indicates that a token provided as input to the request was issued by and is only usable
  *       by calling IAM Identity Center endpoints in another region.</p>
+ * @public
  */
 export declare class InvalidRequestRegionException extends __BaseException {
     readonly name: "InvalidRequestRegionException";
     readonly $fault: "client";
     /**
-     * @public
      * <p>Single error code.
      *       For this exception the value will be <code>invalid_request</code>.</p>
+     * @public
      */
     error?: string;
     /**
-     * @public
      * <p>Human-readable text providing additional information, used to assist the
      *       client developer in understanding the error that occurred.</p>
+     * @public
      */
     error_description?: string;
     /**
-     * @public
      * <p>Indicates the IAM Identity Center endpoint which the requester may call with this token.</p>
+     * @public
      */
     endpoint?: string;
     /**
-     * @public
      * <p>Indicates the region which the requester may call with this token.</p>
+     * @public
      */
     region?: string;
     /**
@@ -560,23 +560,23 @@ export declare class InvalidRequestRegionException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidRequestRegionException, __BaseException>);
 }
 /**
- * @public
  * <p>Indicates that the client information sent in the request during registration is
  *       invalid.</p>
+ * @public
  */
 export declare class InvalidClientMetadataException extends __BaseException {
     readonly name: "InvalidClientMetadataException";
     readonly $fault: "client";
     /**
-     * @public
      * <p>Single error code.
      *       For this exception the value will be <code>invalid_client_metadata</code>.</p>
+     * @public
      */
     error?: string;
     /**
-     * @public
      * <p>Human-readable text providing additional information, used to assist the
      *       client developer in understanding the error that occurred.</p>
+     * @public
      */
     error_description?: string;
     /**
@@ -589,20 +589,20 @@ export declare class InvalidClientMetadataException extends __BaseException {
  */
 export interface RegisterClientRequest {
     /**
-     * @public
      * <p>The friendly name of the client.</p>
+     * @public
      */
     clientName: string | undefined;
     /**
-     * @public
      * <p>The type of client. The service supports only <code>public</code> as a client type.
      *       Anything other than public will be rejected by the service.</p>
+     * @public
      */
     clientType: string | undefined;
     /**
-     * @public
      * <p>The list of scopes that are defined by the client. Upon authorization, this list is used
      *       to restrict permissions when granting an access token.</p>
+     * @public
      */
     scopes?: string[];
 }
@@ -611,37 +611,37 @@ export interface RegisterClientRequest {
  */
 export interface RegisterClientResponse {
     /**
-     * @public
      * <p>The unique identifier string for each client. This client uses this identifier to get
      *       authenticated by the service in subsequent calls.</p>
+     * @public
      */
     clientId?: string;
     /**
-     * @public
      * <p>A secret string generated for the client. The client will use this string to get
      *       authenticated by the service in subsequent calls.</p>
+     * @public
      */
     clientSecret?: string;
     /**
-     * @public
      * <p>Indicates the time at which the <code>clientId</code> and <code>clientSecret</code> were
      *       issued.</p>
+     * @public
      */
     clientIdIssuedAt?: number;
     /**
-     * @public
      * <p>Indicates the time at which the <code>clientId</code> and <code>clientSecret</code> will
      *       become invalid.</p>
+     * @public
      */
     clientSecretExpiresAt?: number;
     /**
-     * @public
      * <p>An endpoint that the client can use to request authorization.</p>
+     * @public
      */
     authorizationEndpoint?: string;
     /**
-     * @public
      * <p>An endpoint that the client can use to create tokens.</p>
+     * @public
      */
     tokenEndpoint?: string;
 }
@@ -650,22 +650,22 @@ export interface RegisterClientResponse {
  */
 export interface StartDeviceAuthorizationRequest {
     /**
-     * @public
      * <p>The unique identifier string for the client that is registered with IAM Identity Center. This value
      *       should come from the persisted result of the <a>RegisterClient</a> API
      *       operation.</p>
+     * @public
      */
     clientId: string | undefined;
     /**
-     * @public
      * <p>A secret string that is generated for the client. This value should come from the
      *       persisted result of the <a>RegisterClient</a> API operation.</p>
+     * @public
      */
     clientSecret: string | undefined;
     /**
-     * @public
      * <p>The URL for the Amazon Web Services access portal. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/using-the-portal.html">Using
      *       the Amazon Web Services access portal</a> in the <i>IAM Identity Center User Guide</i>.</p>
+     * @public
      */
     startUrl: string | undefined;
 }
@@ -674,37 +674,37 @@ export interface StartDeviceAuthorizationRequest {
  */
 export interface StartDeviceAuthorizationResponse {
     /**
-     * @public
      * <p>The short-lived code that is used by the device when polling for a session token.</p>
+     * @public
      */
     deviceCode?: string;
     /**
-     * @public
      * <p>A one-time user verification code. This is needed to authorize an in-use device.</p>
+     * @public
      */
     userCode?: string;
     /**
-     * @public
      * <p>The URI of the verification page that takes the <code>userCode</code> to authorize the
      *       device.</p>
+     * @public
      */
     verificationUri?: string;
     /**
-     * @public
      * <p>An alternate URL that the client can use to automatically launch a browser. This process
      *       skips the manual step in which the user visits the verification page and enters their
      *       code.</p>
+     * @public
      */
     verificationUriComplete?: string;
     /**
-     * @public
      * <p>Indicates the number of seconds in which the verification code will become invalid.</p>
+     * @public
      */
     expiresIn?: number;
     /**
-     * @public
      * <p>Indicates the number of seconds the client must wait between attempts when polling for a
      *       session.</p>
+     * @public
      */
     interval?: number;
 }