Logo for jsDocs.io

@aws-amplify/analytics

  • Version 7.2.0
  • Published
  • 658 kB
  • 5 dependencies
  • Apache-2.0 license

Install

npm i @aws-amplify/analytics
yarn add @aws-amplify/analytics
pnpm add @aws-amplify/analytics

Overview

Analytics category of aws-amplify

Index

Variables

Functions

Type Aliases

Variables

variable configureAutoTrack

const configureAutoTrack: {
    (ctx: AmplifyContext, input: AnalyticsConfigureAutoTrackInput): void;
    (input: AnalyticsConfigureAutoTrackInput): void;
};

  • Deprecated

    The default (Amazon Pinpoint) Analytics APIs are deprecated. AWS will end support for Amazon Pinpoint on October 30, 2026. Migrate to a supported provider by importing from its sub-path export instead — for example aws-amplify/analytics/kinesis, aws-amplify/analytics/kinesis-firehose, or aws-amplify/analytics/personalize.

variable flushEvents

const flushEvents: { (ctx: AmplifyContext): void; (): void };

  • Deprecated

    The default (Amazon Pinpoint) Analytics APIs are deprecated. AWS will end support for Amazon Pinpoint on October 30, 2026. Migrate to a supported provider by importing from its sub-path export instead — for example aws-amplify/analytics/kinesis, aws-amplify/analytics/kinesis-firehose, or aws-amplify/analytics/personalize.

variable identifyUser

const identifyUser: {
    (ctx: AmplifyContext, input: IdentifyUserInput): Promise<void>;
    (input: IdentifyUserInput): Promise<void>;
};

  • Deprecated

    The default (Amazon Pinpoint) Analytics APIs are deprecated. AWS will end support for Amazon Pinpoint on October 30, 2026. Migrate to a supported provider by importing from its sub-path export instead — for example aws-amplify/analytics/kinesis, aws-amplify/analytics/kinesis-firehose, or aws-amplify/analytics/personalize.

variable record

const record: {
    (ctx: AmplifyContext, input: PinpointAnalyticsEvent): void;
    (input: PinpointAnalyticsEvent): void;
};

  • Deprecated

    The default (Amazon Pinpoint) Analytics APIs are deprecated. AWS will end support for Amazon Pinpoint on October 30, 2026. Migrate to a supported provider by importing from its sub-path export instead — for example aws-amplify/analytics/kinesis, aws-amplify/analytics/kinesis-firehose, or aws-amplify/analytics/personalize.

Functions

function disable

disable: () => void;

  • Disables the Analytics category.

    When Analytics is disabled events will not be buffered or transmitted to your selected service. Any auto-tracking behavior that you have configured via configureAutoTrack will not have any effect while Analytics is disabled.

function enable

enable: () => void;

  • Enables the Analytics category to permit the transmission of events.

    Analytics is enabled by default. You do not need to call this API unless you have disabled Analytics.

Type Aliases

type ConfigureAutoTrackInput

type ConfigureAutoTrackInput = AnalyticsConfigureAutoTrackInput;

  • Input type for Pinpoint configureAutoTrack API.

type IdentifyUserInput

type IdentifyUserInput = AnalyticsIdentifyUserInput<IdentifyUserOptions>;

  • Input type for Pinpoint identifyUser API.

type RecordInput

type RecordInput = PinpointAnalyticsEvent;

  • Input type for Pinpoint record API.

Package Files (4)

Dependencies (5)

Dev Dependencies (3)

Peer Dependencies (1)

Badge

To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@aws-amplify/analytics.

  • Markdown
    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@aws-amplify/analytics)
  • HTML
    <a href="https://www.jsdocs.io/package/@aws-amplify/analytics"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>