@aws-amplify/core

constructor

constructor();

property libraryOptions

libraryOptions: LibraryOptions;

property resourcesConfig

resourcesConfig: ResourcesConfig;

method configure

configure: (
    resourcesConfig: ResourcesConfig | LegacyConfig | AmplifyOutputsUnknown,
    libraryOptions?: LibraryOptions
) => void;

• Configures Amplify for use with your back-end resources.

  Parameter resourceConfig

  Back-end resource configuration. Typically provided via the aws-exports.js file.

  Parameter libraryOptions

  Additional options for customizing the behavior of the library.

  Remarks

  configure can be used to specify additional library options where available for supported categories.

method getConfig

getConfig: () => Readonly<ResourcesConfig>;

• Provides access to the current back-end resource configuration for the Library.

  Returns

  Returns the immutable back-end resource configuration.

constructor

constructor(name: string, level?: string);

• Parameter name

  Name of the logger

property BIND_ALL_LOG_LEVELS

static BIND_ALL_LOG_LEVELS: boolean;

property level

level: string;

property LOG_LEVEL

static LOG_LEVEL: string;

property name

name: string;

method addPluggable

addPluggable: (pluggable: LoggingProvider) => void;

method configure

configure: (config?: object) => object | undefined;

method debug

debug: (...msg: any) => void;

• Write DEBUG log Logger

  Parameter msg

  Logging message or object

method error

error: (...msg: any) => void;

• Write ERROR log Logger

  Parameter msg

  Logging message or object

method info

info: (...msg: any) => void;

• Write INFO log Logger

  Parameter msg

  Logging message or object

method listPluggables

listPluggables: () => LoggingProvider[];

method log

log: (...msg: any) => void;

• Write General log. Default to INFO Logger

  Parameter msg

  Logging message or object

method verbose

verbose: (...msg: any) => void;

• Write VERBOSE log Logger

  Parameter msg

  Logging message or object

method warn

warn: (...msg: any) => void;

• Write WARN log Logger

  Parameter msg

  Logging message or object

constructor

constructor(data?: CookieStorageData);

property domain

domain?: string;

property expires

expires?: number;

property path

path: string;

property sameSite

sameSite?: SameSite;

property secure

secure?: boolean;

method clear

clear: () => Promise<void>;

method getItem

getItem: (key: string) => Promise<string | null>;

method removeItem

removeItem: (key: string) => Promise<void>;

method setItem

setItem: (key: string, value: string) => Promise<void>;

method checkConfig

static checkConfig: () => boolean;

method configure

static configure: (config: Record<string, any>) => I18nConfig;

• Configure I18n part

  Parameter config

  Configuration of the I18n

method createInstance

static createInstance: () => void;

• Create an instance of I18n for the library

method get

static get: (key: string, defVal?: string) => any;

• Get value

  Parameter key

  Parameter defVal

  Default value

method getModuleName

static getModuleName: () => string;

method putVocabularies

static putVocabularies: (
    vocabularies: Record<string, Record<string, string>>
) => void;

• Add vocabularies for one language

  Parameter vocabularies

  Object that has language as key, vocabularies of each language as value

method putVocabulariesForLanguage

static putVocabulariesForLanguage: (
    language: string,
    vocabularies: Record<string, string>
) => void;

• Add vocabularies for one language

  Parameter language

  Language of the dictionary

  Parameter vocabularies

  Object that has key-value as dictionary entry

method setLanguage

static setLanguage: (lang: string) => void;

• Explicitly setting language

  Parameter lang

property serviceWorker

readonly serviceWorker: ServiceWorker;

• Get the currently active service worker

method enablePush

enablePush: (publicKey: string) => Promise<unknown>;

• Enable web push notifications. If not subscribed, a new subscription will be created and registered. Test Push Server: https://web-push-codelab.glitch.me/ Push Server Libraries: https://github.com/web-push-libs/ API Doc: https://developers.google.com/web/fundamentals/codelabs/push-notifications/

  Parameter publicKey

  Returns

  {Promise} - resolve(PushSubscription) - reject(Error)

method register

register: (
    filePath?: string,
    scope?: string,
    options?: ServiceWorkerOptions
) => Promise<unknown>;

• Register the service-worker.js file in the browser Make sure the service-worker.js is part of the build for example with Angular, modify the angular-cli.json file and add to "assets" array "service-worker.js"

  Note: when options.onStateChange is omitted, this method implicitly records service worker lifecycle (statechange) events to Amazon Pinpoint. That built-in auto-recording is deprecated and will be removed in a future major version — only the implicit Pinpoint recording is deprecated, not register() itself. Provide options.onStateChange to observe lifecycle state changes and emit vendor-neutral telemetry instead.

  Parameter filePath

  Service worker file. Defaults to "/service-worker.js"

  Parameter scope

  The service worker scope. Defaults to "/" - API Doc: https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerContainer/register

  Parameter options

  Optional registration options. When onStateChange is provided it is invoked on every service worker state change and replaces the built-in Pinpoint auto-recording. It is also invoked once with the worker's current state at registration time, so an already-active worker (which dispatches no statechange event) is still observed. This initial emit applies only to onStateChange; the built-in Pinpoint path is unaffected.

  Returns

  {Promise} - resolve(ServiceWorkerRegistration) - reject(Error)

method send

send: (message: object | string) => void;

• Send a message to the service worker. The service worker needs to implement `self.addEventListener('message') to handle the message. This ***currently*** does not work in Safari or IE.

  Parameter message

  An arbitrary JSON object or string message to send to the service worker - see: https://developer.mozilla.org/en-US/docs/Web/API/Transferable

  Returns

  {Promise}

property libraryOptions

readonly libraryOptions: Readonly<LibraryOptions>;

property resourcesConfig

readonly resourcesConfig: Readonly<ResourcesConfig>;

property token

readonly token: AmplifyContextToken;

• Per-context identity handle; see AmplifyContextToken. All legitimate producers are the Amplify context factories, which attach a fresh, frozen token per context.

method clearCredentials

clearCredentials: () => Promise<void>;

method fetchAuthSession

fetchAuthSession: (options?: FetchAuthSessionOptions) => Promise<AuthSession>;

method getTokens

getTokens: (options: FetchAuthSessionOptions) => Promise<AuthTokens | undefined>;

property value

readonly value: symbol;

property credentials

credentials?: AWSCredentials;

property identityId

identityId?: string;

property tokens

tokens?: AuthTokens;

property userSub

userSub?: string;

property accessToken

accessToken: JWT;

property idToken

idToken?: JWT;

property signInDetails

signInDetails?: AWSAuthSignInDetails;

• Deprecated

  Use getCurrentUser to access signInDetails

property Cognito

Cognito: CognitoUserPoolAndIdentityPoolConfig;

property Cognito

Cognito: CognitoUserPoolConfig & {
    identityPoolId?: never;
    identityPoolEndpoint?: never;
    allowGuestAccess?: never;
};

property capacityInBytes

capacityInBytes: number;

• Cache capacity, in bytes

property defaultPriority

defaultPriority: number;

• default priority number put on cached items

property defaultTTL

defaultTTL: number;

• Time to live, in milliseconds

property itemMaxSize

itemMaxSize: number;

• Max size of one item

property keyPrefix

keyPrefix: string;

• Prepend to key to avoid conflicts

property storage

storage?: Storage;

property warningThreshold

warningThreshold: number;

• Warn when over threshold percentage of capacity, maximum 1

property groups

groups?: Record<UserGroupName, UserGroupPrecedence>[];

property loginWith

loginWith?: {
    oauth?: OAuthConfig;
    username?: boolean;
    email?: boolean;
    phone?: boolean;
};

property mfa

mfa?: {
    status?: CognitoUserPoolConfigMfaStatus;
    totpEnabled?: boolean;
    smsEnabled?: boolean;
};

property passwordFormat

passwordFormat?: {
    minLength?: number;
    requireLowercase?: boolean;
    requireUppercase?: boolean;
    requireNumbers?: boolean;
    requireSpecialCharacters?: boolean;
};

property passwordless

passwordless?: {
    emailOtpEnabled?: boolean;
    smsOtpEnabled?: boolean;
    webAuthn?: {
        relyingPartyId?: string;
        userVerification?: string;
    };
    preferredChallenge?: PreferredChallenge;
};

property signUpVerificationMethod

signUpVerificationMethod?: 'code' | 'link';

property userAttributes

userAttributes?: AuthConfigUserAttributes;

property userPoolClientId

userPoolClientId: string;

property userPoolEndpoint

userPoolEndpoint?: string;

• Use this field to specify a custom endpoint for the Amazon Cognito user pool. Ensure this endpoint is correct and valid.

property userPoolId

userPoolId: string;

method add

add: <K extends keyof ResourcesConfig>(
    category: K,
    value: CategoryConfig<K>
) => ConfigurationBuilder;

• Add or replace a category configuration.

  Example 1

  config.add('Auth', { Cognito: { userPoolId: '...', userPoolClientId: '...' } });
  config.add('Storage', { S3: { bucket: '...', region: '...' } });

method analytics

analytics: (config: CategoryConfig<'Analytics'>) => ConfigurationBuilder;

• Shorthand for .add('Analytics', config)

method api

api: (config: CategoryConfig<'API'>) => ConfigurationBuilder;

• Shorthand for .add('API', config)

method auth

auth: (config: CategoryConfig<'Auth'>) => ConfigurationBuilder;

• Shorthand for .add('Auth', config)

method build

build: () => ResourcesConfig;

• Produces a frozen ResourcesConfig ready for Amplify.configure().

method from

from: (existing: ConfigurationSeed) => ConfigurationBuilder;

• Merge an existing config into this builder. Accepts any format that Amplify.configure() accepts, or another ConfigurationBuilder.

  Example 1

  const config = createConfiguration()
    .from(amplifyOutputs)
    .add('Storage', { S3: { bucket: 'my-bucket', region: 'us-east-1' } })
    .build();

method geo

geo: (config: CategoryConfig<'Geo'>) => ConfigurationBuilder;

• Shorthand for .add('Geo', config)

method interactions

interactions: (config: CategoryConfig<'Interactions'>) => ConfigurationBuilder;

• Shorthand for .add('Interactions', config)

method notifications

notifications: (config: CategoryConfig<'Notifications'>) => ConfigurationBuilder;

• Shorthand for .add('Notifications', config)

method patch

patch: <K extends keyof ResourcesConfig>(
    category: K,
    value: DeepPartial<CategoryConfig<K>>
) => ConfigurationBuilder;

• Deep-merge a partial config into an existing category. Use this to override specific nested values without replacing the entire category.

  Example 1

  // Base config from outputs, override just the user pool for dev
  const dev = createConfiguration({ from: outputs })
    .patch('Auth', { Cognito: { userPoolId: 'us-east-1_DEV' } })
    .build();

method predictions

predictions: (config: CategoryConfig<'Predictions'>) => ConfigurationBuilder;

• Shorthand for .add('Predictions', config)

method storage

storage: (config: CategoryConfig<'Storage'>) => ConfigurationBuilder;

• Shorthand for .add('Storage', config)

property from

from?: ConfigurationSeed;

property credentials

credentials: AWSCredentials;

property identityId

identityId?: string;

method clearCredentialsAndIdentityId

clearCredentialsAndIdentityId: () => void;

method getCredentialsAndIdentityId

getCredentialsAndIdentityId: (
    getCredentialsOptions: GetCredentialsOptions
) => Promise<CredentialsAndIdentityId | undefined>;

property clientMetadata

clientMetadata?: ClientMetadata;

property forceRefresh

forceRefresh?: boolean;

property CustomRoleArn

CustomRoleArn?: string;

• The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization.

property IdentityId

IdentityId: string | undefined;

• A unique identifier in the format REGION:GUID.

property Logins

Logins?: Record<string, string>;

• A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax "provider_name": "provider_user_identifier". Logins should not be specified when trying to get credentials for an unauthenticated identity. The Logins parameter is required when using identities associated with external identity providers such as Facebook. For examples of Logins maps, see the code examples in the External Identity Providers section of the Amazon Cognito Developer Guide.

property channel

channel: Channel;

property crossTab

crossTab?: boolean;

property patternInfo

patternInfo?: string[];

property payload

payload: HubPayload<EventData>;

property source

source?: string;

property id

id: string;

property type

type: 'guest' | 'primary';

property payload

payload: JwtPayload;

method toString

toString: () => string;

property key

readonly key: string | null;

property newValue

readonly newValue: string | null;

property oldValue

readonly oldValue: string | null;

method addListener

addListener: (
    listener: (ev: KeyValueStorageEvent) => Promise<void>
) => () => void;

• Subscribe to cross-tab storage changes.

  Parameter listener

  invoked when the underlying storage changes in another tab.

  Returns

  an unsubscribe function that removes the listener. Optional: storages that do not support cross-tab notifications (e.g. cookie storage) may omit it.

method clear

clear: () => Promise<void>;

method getItem

getItem: (key: string) => Promise<string | null>;

method removeItem

removeItem: (key: string) => Promise<void>;

method setItem

setItem: (key: string, value: string) => Promise<void>;

property API

API?: LibraryAPIOptions;

property Auth

Auth?: LibraryAuthOptions;

property ssr

ssr?: boolean;

property Storage

Storage?: LibraryStorageOptions;

property domain

domain: string;

property providers

providers?: (OAuthProvider | CustomProvider)[];

property redirectSignIn

redirectSignIn: string[];

property redirectSignOut

redirectSignOut: string[];

property responseType

responseType: 'code' | 'token';

property scopes

scopes: OAuthScope[];

property Analytics

Analytics?: AnalyticsConfig;

property API

API?: APIConfig;

property Auth

Auth?: AuthConfig;

property Geo

Geo?: GeoConfig;

property Interactions

Interactions?: InteractionsConfig;

property Notifications

Notifications?: NotificationsConfig;

property Predictions

Predictions?: PredictionsConfig;

property Storage

Storage?: StorageConfig;

property onStateChange

onStateChange?: ServiceWorkerStateChangeHandler;

• Optional handler invoked on every service worker statechange event.

  When provided, this handler replaces the built-in Pinpoint auto-recording: the built-in analytics event is only recorded when no handler is supplied, which prevents duplicate telemetry for the same state change.

method getTokens

getTokens: (options?: { forceRefresh?: boolean }) => Promise<AuthTokens | null>;

property customProperties

customProperties?: Record<string, string[]>;

property demographic

demographic?: {
    appVersion?: string;
    locale?: string;
    make?: string;
    model?: string;
    modelVersion?: string;
    platform?: string;
    platformVersion?: string;
    timezone?: string;
};

property email

email?: string;

property location

location?: {
    city?: string;
    country?: string;
    latitude?: number;
    longitude?: number;
    postalCode?: string;
    region?: string;
};

property metrics

metrics?: Record<string, number>;

property name

name?: string;

property plan

plan?: string;