@aws-sdk/client-cognito-identity-provider 3.169.0 → 3.170.0

package/dist-types/ts3.4/models/models_1.d.ts

@@ -1,347 +1,412 @@
-import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
-import { CognitoIdentityProviderServiceException as __BaseException } from "./CognitoIdentityProviderServiceException";
-import { AccountRecoverySettingType, AdminCreateUserConfigType, AnalyticsConfigurationType, AttributeType, CodeDeliveryDetailsType, CustomDomainConfigType, DeviceConfigurationType, DeviceRememberedStatusType, EmailConfigurationType, ExplicitAuthFlowsType, FeedbackValueType, GroupType, IdentityProviderType, LambdaConfigType, OAuthFlowType, PreventUserExistenceErrorTypes, ResourceServerScopeType, ResourceServerType, SmsConfigurationType, TokenValidityUnitsType, UserAttributeUpdateSettingsType, UserImportJobType, UserPoolAddOnsType, UserPoolClientType, UserPoolMfaType, UserPoolPolicyType, VerificationMessageTemplateType, VerifiedAttributeType } from "./models_0";
-
-export interface SignUpResponse {
-    
-    UserConfirmed: boolean | undefined;
-    
-    CodeDeliveryDetails?: CodeDeliveryDetailsType;
-    
-    UserSub: string | undefined;
-}
-
-export interface StartUserImportJobRequest {
-    
-    UserPoolId: string | undefined;
-    
-    JobId: string | undefined;
-}
-
-export interface StartUserImportJobResponse {
-    
-    UserImportJob?: UserImportJobType;
-}
-
-export interface StopUserImportJobRequest {
-    
-    UserPoolId: string | undefined;
-    
-    JobId: string | undefined;
-}
-
-export interface StopUserImportJobResponse {
-    
-    UserImportJob?: UserImportJobType;
-}
-export interface TagResourceRequest {
-    
-    ResourceArn: string | undefined;
-    
-    Tags: Record<string, string> | undefined;
-}
-export interface TagResourceResponse {
-}
-export interface UntagResourceRequest {
-    
-    ResourceArn: string | undefined;
-    
-    TagKeys: string[] | undefined;
-}
-export interface UntagResourceResponse {
-}
-export interface UpdateAuthEventFeedbackRequest {
-    
-    UserPoolId: string | undefined;
-    
-    Username: string | undefined;
-    
-    EventId: string | undefined;
-    
-    FeedbackToken: string | undefined;
-    
-    FeedbackValue: FeedbackValueType | string | undefined;
-}
-export interface UpdateAuthEventFeedbackResponse {
-}
-
-export interface UpdateDeviceStatusRequest {
-    
-    AccessToken: string | undefined;
-    
-    DeviceKey: string | undefined;
-    
-    DeviceRememberedStatus?: DeviceRememberedStatusType | string;
-}
-
-export interface UpdateDeviceStatusResponse {
-}
-export interface UpdateGroupRequest {
-    
-    GroupName: string | undefined;
-    
-    UserPoolId: string | undefined;
-    
-    Description?: string;
-    
-    RoleArn?: string;
-    
-    Precedence?: number;
-}
-export interface UpdateGroupResponse {
-    
-    Group?: GroupType;
-}
-export interface UpdateIdentityProviderRequest {
-    
-    UserPoolId: string | undefined;
-    
-    ProviderName: string | undefined;
-    
-    ProviderDetails?: Record<string, string>;
-    
-    AttributeMapping?: Record<string, string>;
-    
-    IdpIdentifiers?: string[];
-}
-export interface UpdateIdentityProviderResponse {
-    
-    IdentityProvider: IdentityProviderType | undefined;
-}
-export interface UpdateResourceServerRequest {
-    
-    UserPoolId: string | undefined;
-    
-    Identifier: string | undefined;
-    
-    Name: string | undefined;
-    
-    Scopes?: ResourceServerScopeType[];
-}
-export interface UpdateResourceServerResponse {
-    
-    ResourceServer: ResourceServerType | undefined;
-}
-
-export interface UpdateUserAttributesRequest {
-    
-    UserAttributes: AttributeType[] | undefined;
-    
-    AccessToken: string | undefined;
-    
-    ClientMetadata?: Record<string, string>;
-}
-
-export interface UpdateUserAttributesResponse {
-    
-    CodeDeliveryDetailsList?: CodeDeliveryDetailsType[];
-}
-
-export interface UpdateUserPoolRequest {
-    
-    UserPoolId: string | undefined;
-    
-    Policies?: UserPoolPolicyType;
-    
-    LambdaConfig?: LambdaConfigType;
-    
-    AutoVerifiedAttributes?: (VerifiedAttributeType | string)[];
-    
-    SmsVerificationMessage?: string;
-    
-    EmailVerificationMessage?: string;
-    
-    EmailVerificationSubject?: string;
-    
-    VerificationMessageTemplate?: VerificationMessageTemplateType;
-    
-    SmsAuthenticationMessage?: string;
-    
-    UserAttributeUpdateSettings?: UserAttributeUpdateSettingsType;
-    
-    MfaConfiguration?: UserPoolMfaType | string;
-    
-    DeviceConfiguration?: DeviceConfigurationType;
-    
-    EmailConfiguration?: EmailConfigurationType;
-    
-    SmsConfiguration?: SmsConfigurationType;
-    
-    UserPoolTags?: Record<string, string>;
-    
-    AdminCreateUserConfig?: AdminCreateUserConfigType;
-    
-    UserPoolAddOns?: UserPoolAddOnsType;
-    
-    AccountRecoverySetting?: AccountRecoverySettingType;
-}
-
-export interface UpdateUserPoolResponse {
-}
-
-export interface UpdateUserPoolClientRequest {
-    
-    UserPoolId: string | undefined;
-    
-    ClientId: string | undefined;
-    
-    ClientName?: string;
-    
-    RefreshTokenValidity?: number;
-    
-    AccessTokenValidity?: number;
-    
-    IdTokenValidity?: number;
-    
-    TokenValidityUnits?: TokenValidityUnitsType;
-    
-    ReadAttributes?: string[];
-    
-    WriteAttributes?: string[];
-    
-    ExplicitAuthFlows?: (ExplicitAuthFlowsType | string)[];
-    
-    SupportedIdentityProviders?: string[];
-    
-    CallbackURLs?: string[];
-    
-    LogoutURLs?: string[];
-    
-    DefaultRedirectURI?: string;
-    
-    AllowedOAuthFlows?: (OAuthFlowType | string)[];
-    
-    AllowedOAuthScopes?: string[];
-    
-    AllowedOAuthFlowsUserPoolClient?: boolean;
-    
-    AnalyticsConfiguration?: AnalyticsConfigurationType;
-    
-    PreventUserExistenceErrors?: PreventUserExistenceErrorTypes | string;
-    
-    EnableTokenRevocation?: boolean;
-    
-    EnablePropagateAdditionalUserContextData?: boolean;
-    
-    AuthSessionValidity?: number;
-}
-
-export interface UpdateUserPoolClientResponse {
-    
-    UserPoolClient?: UserPoolClientType;
-}
-
-export interface UpdateUserPoolDomainRequest {
-    
-    Domain: string | undefined;
-    
-    UserPoolId: string | undefined;
-    
-    CustomDomainConfig: CustomDomainConfigType | undefined;
-}
-
-export interface UpdateUserPoolDomainResponse {
-    
-    CloudFrontDomain?: string;
-}
-
-export declare class EnableSoftwareTokenMFAException extends __BaseException {
-    readonly name: "EnableSoftwareTokenMFAException";
-    readonly $fault: "client";
-    
-    constructor(opts: __ExceptionOptionType<EnableSoftwareTokenMFAException, __BaseException>);
-}
-export interface VerifySoftwareTokenRequest {
-    
-    AccessToken?: string;
-    
-    Session?: string;
-    
-    UserCode: string | undefined;
-    
-    FriendlyDeviceName?: string;
-}
-export declare enum VerifySoftwareTokenResponseType {
-    ERROR = "ERROR",
-    SUCCESS = "SUCCESS"
-}
-export interface VerifySoftwareTokenResponse {
-    
-    Status?: VerifySoftwareTokenResponseType | string;
-    
-    Session?: string;
-}
-
-export interface VerifyUserAttributeRequest {
-    
-    AccessToken: string | undefined;
-    
-    AttributeName: string | undefined;
-    
-    Code: string | undefined;
-}
-
-export interface VerifyUserAttributeResponse {
-}
-
-export declare const SignUpResponseFilterSensitiveLog: (obj: SignUpResponse) => any;
-
-export declare const StartUserImportJobRequestFilterSensitiveLog: (obj: StartUserImportJobRequest) => any;
-
-export declare const StartUserImportJobResponseFilterSensitiveLog: (obj: StartUserImportJobResponse) => any;
-
-export declare const StopUserImportJobRequestFilterSensitiveLog: (obj: StopUserImportJobRequest) => any;
-
-export declare const StopUserImportJobResponseFilterSensitiveLog: (obj: StopUserImportJobResponse) => any;
-
-export declare const TagResourceRequestFilterSensitiveLog: (obj: TagResourceRequest) => any;
-
-export declare const TagResourceResponseFilterSensitiveLog: (obj: TagResourceResponse) => any;
-
-export declare const UntagResourceRequestFilterSensitiveLog: (obj: UntagResourceRequest) => any;
-
-export declare const UntagResourceResponseFilterSensitiveLog: (obj: UntagResourceResponse) => any;
-
-export declare const UpdateAuthEventFeedbackRequestFilterSensitiveLog: (obj: UpdateAuthEventFeedbackRequest) => any;
-
-export declare const UpdateAuthEventFeedbackResponseFilterSensitiveLog: (obj: UpdateAuthEventFeedbackResponse) => any;
-
-export declare const UpdateDeviceStatusRequestFilterSensitiveLog: (obj: UpdateDeviceStatusRequest) => any;
-
-export declare const UpdateDeviceStatusResponseFilterSensitiveLog: (obj: UpdateDeviceStatusResponse) => any;
-
-export declare const UpdateGroupRequestFilterSensitiveLog: (obj: UpdateGroupRequest) => any;
-
-export declare const UpdateGroupResponseFilterSensitiveLog: (obj: UpdateGroupResponse) => any;
-
-export declare const UpdateIdentityProviderRequestFilterSensitiveLog: (obj: UpdateIdentityProviderRequest) => any;
-
-export declare const UpdateIdentityProviderResponseFilterSensitiveLog: (obj: UpdateIdentityProviderResponse) => any;
-
-export declare const UpdateResourceServerRequestFilterSensitiveLog: (obj: UpdateResourceServerRequest) => any;
-
-export declare const UpdateResourceServerResponseFilterSensitiveLog: (obj: UpdateResourceServerResponse) => any;
-
-export declare const UpdateUserAttributesRequestFilterSensitiveLog: (obj: UpdateUserAttributesRequest) => any;
-
-export declare const UpdateUserAttributesResponseFilterSensitiveLog: (obj: UpdateUserAttributesResponse) => any;
-
-export declare const UpdateUserPoolRequestFilterSensitiveLog: (obj: UpdateUserPoolRequest) => any;
-
-export declare const UpdateUserPoolResponseFilterSensitiveLog: (obj: UpdateUserPoolResponse) => any;
-
-export declare const UpdateUserPoolClientRequestFilterSensitiveLog: (obj: UpdateUserPoolClientRequest) => any;
-
-export declare const UpdateUserPoolClientResponseFilterSensitiveLog: (obj: UpdateUserPoolClientResponse) => any;
-
-export declare const UpdateUserPoolDomainRequestFilterSensitiveLog: (obj: UpdateUserPoolDomainRequest) => any;
-
-export declare const UpdateUserPoolDomainResponseFilterSensitiveLog: (obj: UpdateUserPoolDomainResponse) => any;
-
-export declare const VerifySoftwareTokenRequestFilterSensitiveLog: (obj: VerifySoftwareTokenRequest) => any;
-
-export declare const VerifySoftwareTokenResponseFilterSensitiveLog: (obj: VerifySoftwareTokenResponse) => any;
-
-export declare const VerifyUserAttributeRequestFilterSensitiveLog: (obj: VerifyUserAttributeRequest) => any;
-
-export declare const VerifyUserAttributeResponseFilterSensitiveLog: (obj: VerifyUserAttributeResponse) => any;
+import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
+import { CognitoIdentityProviderServiceException as __BaseException } from "./CognitoIdentityProviderServiceException";
+import {
+  AccountRecoverySettingType,
+  AdminCreateUserConfigType,
+  AnalyticsConfigurationType,
+  AttributeType,
+  CodeDeliveryDetailsType,
+  CustomDomainConfigType,
+  DeviceConfigurationType,
+  DeviceRememberedStatusType,
+  EmailConfigurationType,
+  ExplicitAuthFlowsType,
+  FeedbackValueType,
+  GroupType,
+  IdentityProviderType,
+  LambdaConfigType,
+  OAuthFlowType,
+  PreventUserExistenceErrorTypes,
+  ResourceServerScopeType,
+  ResourceServerType,
+  SmsConfigurationType,
+  TokenValidityUnitsType,
+  UserAttributeUpdateSettingsType,
+  UserImportJobType,
+  UserPoolAddOnsType,
+  UserPoolClientType,
+  UserPoolMfaType,
+  UserPoolPolicyType,
+  VerificationMessageTemplateType,
+  VerifiedAttributeType,
+} from "./models_0";
+
+export interface SignUpResponse {
+  UserConfirmed: boolean | undefined;
+
+  CodeDeliveryDetails?: CodeDeliveryDetailsType;
+
+  UserSub: string | undefined;
+}
+
+export interface StartUserImportJobRequest {
+  UserPoolId: string | undefined;
+
+  JobId: string | undefined;
+}
+
+export interface StartUserImportJobResponse {
+  UserImportJob?: UserImportJobType;
+}
+
+export interface StopUserImportJobRequest {
+  UserPoolId: string | undefined;
+
+  JobId: string | undefined;
+}
+
+export interface StopUserImportJobResponse {
+  UserImportJob?: UserImportJobType;
+}
+export interface TagResourceRequest {
+  ResourceArn: string | undefined;
+
+  Tags: Record<string, string> | undefined;
+}
+export interface TagResourceResponse {}
+export interface UntagResourceRequest {
+  ResourceArn: string | undefined;
+
+  TagKeys: string[] | undefined;
+}
+export interface UntagResourceResponse {}
+export interface UpdateAuthEventFeedbackRequest {
+  UserPoolId: string | undefined;
+
+  Username: string | undefined;
+
+  EventId: string | undefined;
+
+  FeedbackToken: string | undefined;
+
+  FeedbackValue: FeedbackValueType | string | undefined;
+}
+export interface UpdateAuthEventFeedbackResponse {}
+
+export interface UpdateDeviceStatusRequest {
+  AccessToken: string | undefined;
+
+  DeviceKey: string | undefined;
+
+  DeviceRememberedStatus?: DeviceRememberedStatusType | string;
+}
+
+export interface UpdateDeviceStatusResponse {}
+export interface UpdateGroupRequest {
+  GroupName: string | undefined;
+
+  UserPoolId: string | undefined;
+
+  Description?: string;
+
+  RoleArn?: string;
+
+  Precedence?: number;
+}
+export interface UpdateGroupResponse {
+  Group?: GroupType;
+}
+export interface UpdateIdentityProviderRequest {
+  UserPoolId: string | undefined;
+
+  ProviderName: string | undefined;
+
+  ProviderDetails?: Record<string, string>;
+
+  AttributeMapping?: Record<string, string>;
+
+  IdpIdentifiers?: string[];
+}
+export interface UpdateIdentityProviderResponse {
+  IdentityProvider: IdentityProviderType | undefined;
+}
+export interface UpdateResourceServerRequest {
+  UserPoolId: string | undefined;
+
+  Identifier: string | undefined;
+
+  Name: string | undefined;
+
+  Scopes?: ResourceServerScopeType[];
+}
+export interface UpdateResourceServerResponse {
+  ResourceServer: ResourceServerType | undefined;
+}
+
+export interface UpdateUserAttributesRequest {
+  UserAttributes: AttributeType[] | undefined;
+
+  AccessToken: string | undefined;
+
+  ClientMetadata?: Record<string, string>;
+}
+
+export interface UpdateUserAttributesResponse {
+  CodeDeliveryDetailsList?: CodeDeliveryDetailsType[];
+}
+
+export interface UpdateUserPoolRequest {
+  UserPoolId: string | undefined;
+
+  Policies?: UserPoolPolicyType;
+
+  LambdaConfig?: LambdaConfigType;
+
+  AutoVerifiedAttributes?: (VerifiedAttributeType | string)[];
+
+  SmsVerificationMessage?: string;
+
+  EmailVerificationMessage?: string;
+
+  EmailVerificationSubject?: string;
+
+  VerificationMessageTemplate?: VerificationMessageTemplateType;
+
+  SmsAuthenticationMessage?: string;
+
+  UserAttributeUpdateSettings?: UserAttributeUpdateSettingsType;
+
+  MfaConfiguration?: UserPoolMfaType | string;
+
+  DeviceConfiguration?: DeviceConfigurationType;
+
+  EmailConfiguration?: EmailConfigurationType;
+
+  SmsConfiguration?: SmsConfigurationType;
+
+  UserPoolTags?: Record<string, string>;
+
+  AdminCreateUserConfig?: AdminCreateUserConfigType;
+
+  UserPoolAddOns?: UserPoolAddOnsType;
+
+  AccountRecoverySetting?: AccountRecoverySettingType;
+}
+
+export interface UpdateUserPoolResponse {}
+
+export interface UpdateUserPoolClientRequest {
+  UserPoolId: string | undefined;
+
+  ClientId: string | undefined;
+
+  ClientName?: string;
+
+  RefreshTokenValidity?: number;
+
+  AccessTokenValidity?: number;
+
+  IdTokenValidity?: number;
+
+  TokenValidityUnits?: TokenValidityUnitsType;
+
+  ReadAttributes?: string[];
+
+  WriteAttributes?: string[];
+
+  ExplicitAuthFlows?: (ExplicitAuthFlowsType | string)[];
+
+  SupportedIdentityProviders?: string[];
+
+  CallbackURLs?: string[];
+
+  LogoutURLs?: string[];
+
+  DefaultRedirectURI?: string;
+
+  AllowedOAuthFlows?: (OAuthFlowType | string)[];
+
+  AllowedOAuthScopes?: string[];
+
+  AllowedOAuthFlowsUserPoolClient?: boolean;
+
+  AnalyticsConfiguration?: AnalyticsConfigurationType;
+
+  PreventUserExistenceErrors?: PreventUserExistenceErrorTypes | string;
+
+  EnableTokenRevocation?: boolean;
+
+  EnablePropagateAdditionalUserContextData?: boolean;
+
+  AuthSessionValidity?: number;
+}
+
+export interface UpdateUserPoolClientResponse {
+  UserPoolClient?: UserPoolClientType;
+}
+
+export interface UpdateUserPoolDomainRequest {
+  Domain: string | undefined;
+
+  UserPoolId: string | undefined;
+
+  CustomDomainConfig: CustomDomainConfigType | undefined;
+}
+
+export interface UpdateUserPoolDomainResponse {
+  CloudFrontDomain?: string;
+}
+
+export declare class EnableSoftwareTokenMFAException extends __BaseException {
+  readonly name: "EnableSoftwareTokenMFAException";
+  readonly $fault: "client";
+
+  constructor(
+    opts: __ExceptionOptionType<
+      EnableSoftwareTokenMFAException,
+      __BaseException
+    >
+  );
+}
+export interface VerifySoftwareTokenRequest {
+  AccessToken?: string;
+
+  Session?: string;
+
+  UserCode: string | undefined;
+
+  FriendlyDeviceName?: string;
+}
+export declare enum VerifySoftwareTokenResponseType {
+  ERROR = "ERROR",
+  SUCCESS = "SUCCESS",
+}
+export interface VerifySoftwareTokenResponse {
+  Status?: VerifySoftwareTokenResponseType | string;
+
+  Session?: string;
+}
+
+export interface VerifyUserAttributeRequest {
+  AccessToken: string | undefined;
+
+  AttributeName: string | undefined;
+
+  Code: string | undefined;
+}
+
+export interface VerifyUserAttributeResponse {}
+
+export declare const SignUpResponseFilterSensitiveLog: (
+  obj: SignUpResponse
+) => any;
+
+export declare const StartUserImportJobRequestFilterSensitiveLog: (
+  obj: StartUserImportJobRequest
+) => any;
+
+export declare const StartUserImportJobResponseFilterSensitiveLog: (
+  obj: StartUserImportJobResponse
+) => any;
+
+export declare const StopUserImportJobRequestFilterSensitiveLog: (
+  obj: StopUserImportJobRequest
+) => any;
+
+export declare const StopUserImportJobResponseFilterSensitiveLog: (
+  obj: StopUserImportJobResponse
+) => any;
+
+export declare const TagResourceRequestFilterSensitiveLog: (
+  obj: TagResourceRequest
+) => any;
+
+export declare const TagResourceResponseFilterSensitiveLog: (
+  obj: TagResourceResponse
+) => any;
+
+export declare const UntagResourceRequestFilterSensitiveLog: (
+  obj: UntagResourceRequest
+) => any;
+
+export declare const UntagResourceResponseFilterSensitiveLog: (
+  obj: UntagResourceResponse
+) => any;
+
+export declare const UpdateAuthEventFeedbackRequestFilterSensitiveLog: (
+  obj: UpdateAuthEventFeedbackRequest
+) => any;
+
+export declare const UpdateAuthEventFeedbackResponseFilterSensitiveLog: (
+  obj: UpdateAuthEventFeedbackResponse
+) => any;
+
+export declare const UpdateDeviceStatusRequestFilterSensitiveLog: (
+  obj: UpdateDeviceStatusRequest
+) => any;
+
+export declare const UpdateDeviceStatusResponseFilterSensitiveLog: (
+  obj: UpdateDeviceStatusResponse
+) => any;
+
+export declare const UpdateGroupRequestFilterSensitiveLog: (
+  obj: UpdateGroupRequest
+) => any;
+
+export declare const UpdateGroupResponseFilterSensitiveLog: (
+  obj: UpdateGroupResponse
+) => any;
+
+export declare const UpdateIdentityProviderRequestFilterSensitiveLog: (
+  obj: UpdateIdentityProviderRequest
+) => any;
+
+export declare const UpdateIdentityProviderResponseFilterSensitiveLog: (
+  obj: UpdateIdentityProviderResponse
+) => any;
+
+export declare const UpdateResourceServerRequestFilterSensitiveLog: (
+  obj: UpdateResourceServerRequest
+) => any;
+
+export declare const UpdateResourceServerResponseFilterSensitiveLog: (
+  obj: UpdateResourceServerResponse
+) => any;
+
+export declare const UpdateUserAttributesRequestFilterSensitiveLog: (
+  obj: UpdateUserAttributesRequest
+) => any;
+
+export declare const UpdateUserAttributesResponseFilterSensitiveLog: (
+  obj: UpdateUserAttributesResponse
+) => any;
+
+export declare const UpdateUserPoolRequestFilterSensitiveLog: (
+  obj: UpdateUserPoolRequest
+) => any;
+
+export declare const UpdateUserPoolResponseFilterSensitiveLog: (
+  obj: UpdateUserPoolResponse
+) => any;
+
+export declare const UpdateUserPoolClientRequestFilterSensitiveLog: (
+  obj: UpdateUserPoolClientRequest
+) => any;
+
+export declare const UpdateUserPoolClientResponseFilterSensitiveLog: (
+  obj: UpdateUserPoolClientResponse
+) => any;
+
+export declare const UpdateUserPoolDomainRequestFilterSensitiveLog: (
+  obj: UpdateUserPoolDomainRequest
+) => any;
+
+export declare const UpdateUserPoolDomainResponseFilterSensitiveLog: (
+  obj: UpdateUserPoolDomainResponse
+) => any;
+
+export declare const VerifySoftwareTokenRequestFilterSensitiveLog: (
+  obj: VerifySoftwareTokenRequest
+) => any;
+
+export declare const VerifySoftwareTokenResponseFilterSensitiveLog: (
+  obj: VerifySoftwareTokenResponse
+) => any;
+
+export declare const VerifyUserAttributeRequestFilterSensitiveLog: (
+  obj: VerifyUserAttributeRequest
+) => any;
+
+export declare const VerifyUserAttributeResponseFilterSensitiveLog: (
+  obj: VerifyUserAttributeResponse
+) => any;