PinpointClient

Doc Engage API - Amazon Pinpoint API

Installation

NPM
npm install @aws-sdk/client-pinpoint
Yarn
yarn add @aws-sdk/client-pinpoint
pnpm
pnpm add @aws-sdk/client-pinpoint

PinpointClient Operations

Command
Summary
CreateAppCommand

Creates an application.

CreateCampaignCommand

Creates a new campaign for an application or updates the settings of an existing campaign for an application.

CreateEmailTemplateCommand

Creates a message template for messages that are sent through the email channel.

CreateExportJobCommand

Creates an export job for an application.

CreateImportJobCommand

Creates an import job for an application.

CreateInAppTemplateCommand

Creates a new message template for messages using the in-app message channel.

CreateJourneyCommand

Creates a journey for an application.

CreatePushTemplateCommand

Creates a message template for messages that are sent through a push notification channel.

CreateRecommenderConfigurationCommand

Creates an Amazon Pinpoint configuration for a recommender model.

CreateSegmentCommand

Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.

CreateSmsTemplateCommand

Creates a message template for messages that are sent through the SMS channel.

CreateVoiceTemplateCommand

Creates a message template for messages that are sent through the voice channel.

DeleteAdmChannelCommand

Disables the ADM channel for an application and deletes any existing settings for the channel.

DeleteApnsChannelCommand

Disables the APNs channel for an application and deletes any existing settings for the channel.

DeleteApnsSandboxChannelCommand

Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.

DeleteApnsVoipChannelCommand

Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.

DeleteApnsVoipSandboxChannelCommand

Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.

DeleteAppCommand

Deletes an application.

DeleteBaiduChannelCommand

Disables the Baidu channel for an application and deletes any existing settings for the channel.

DeleteCampaignCommand

Deletes a campaign from an application.

DeleteEmailChannelCommand

Disables the email channel for an application and deletes any existing settings for the channel.

DeleteEmailTemplateCommand

Deletes a message template for messages that were sent through the email channel.

DeleteEndpointCommand

Deletes an endpoint from an application.

DeleteEventStreamCommand

Deletes the event stream for an application.

DeleteGcmChannelCommand

Disables the GCM channel for an application and deletes any existing settings for the channel.

DeleteInAppTemplateCommand

Deletes a message template for messages sent using the in-app message channel.

DeleteJourneyCommand

Deletes a journey from an application.

DeletePushTemplateCommand

Deletes a message template for messages that were sent through a push notification channel.

DeleteRecommenderConfigurationCommand

Deletes an Amazon Pinpoint configuration for a recommender model.

DeleteSegmentCommand

Deletes a segment from an application.

DeleteSmsChannelCommand

Disables the SMS channel for an application and deletes any existing settings for the channel.

DeleteSmsTemplateCommand

Deletes a message template for messages that were sent through the SMS channel.

DeleteUserEndpointsCommand

Deletes all the endpoints that are associated with a specific user ID.

DeleteVoiceChannelCommand

Disables the voice channel for an application and deletes any existing settings for the channel.

DeleteVoiceTemplateCommand

Deletes a message template for messages that were sent through the voice channel.

GetAdmChannelCommand

Retrieves information about the status and settings of the ADM channel for an application.

GetApnsChannelCommand

Retrieves information about the status and settings of the APNs channel for an application.

GetApnsSandboxChannelCommand

Retrieves information about the status and settings of the APNs sandbox channel for an application.

GetApnsVoipChannelCommand

Retrieves information about the status and settings of the APNs VoIP channel for an application.

GetApnsVoipSandboxChannelCommand

Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.

GetAppCommand

Retrieves information about an application.

GetApplicationDateRangeKpiCommand

Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.

GetApplicationSettingsCommand

Retrieves information about the settings for an application.

GetAppsCommand

Retrieves information about all the applications that are associated with your Amazon Pinpoint account.

GetBaiduChannelCommand

Retrieves information about the status and settings of the Baidu channel for an application.

GetCampaignActivitiesCommand

Retrieves information about all the activities for a campaign.

GetCampaignCommand

Retrieves information about the status, configuration, and other settings for a campaign.

GetCampaignDateRangeKpiCommand

Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.

GetCampaignVersionCommand

Retrieves information about the status, configuration, and other settings for a specific version of a campaign.

GetCampaignVersionsCommand

Retrieves information about the status, configuration, and other settings for all versions of a campaign.

GetCampaignsCommand

Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.

GetChannelsCommand

Retrieves information about the history and status of each channel for an application.

GetEmailChannelCommand

Retrieves information about the status and settings of the email channel for an application.

GetEmailTemplateCommand

Retrieves the content and settings of a message template for messages that are sent through the email channel.

GetEndpointCommand

Retrieves information about the settings and attributes of a specific endpoint for an application.

GetEventStreamCommand

Retrieves information about the event stream settings for an application.

GetExportJobCommand

Retrieves information about the status and settings of a specific export job for an application.

GetExportJobsCommand

Retrieves information about the status and settings of all the export jobs for an application.

GetGcmChannelCommand

Retrieves information about the status and settings of the GCM channel for an application.

GetImportJobCommand

Retrieves information about the status and settings of a specific import job for an application.

GetImportJobsCommand

Retrieves information about the status and settings of all the import jobs for an application.

GetInAppMessagesCommand

Retrieves the in-app messages targeted for the provided endpoint ID.

GetInAppTemplateCommand

Retrieves the content and settings of a message template for messages sent through the in-app channel.

GetJourneyCommand

Retrieves information about the status, configuration, and other settings for a journey.

GetJourneyDateRangeKpiCommand

Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.

GetJourneyExecutionActivityMetricsCommand

Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.

GetJourneyExecutionMetricsCommand

Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.

GetJourneyRunExecutionActivityMetricsCommand

Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey activity.

GetJourneyRunExecutionMetricsCommand

Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey.

GetJourneyRunsCommand

Provides information about the runs of a journey.

GetPushTemplateCommand

Retrieves the content and settings of a message template for messages that are sent through a push notification channel.

GetRecommenderConfigurationCommand

Retrieves information about an Amazon Pinpoint configuration for a recommender model.

GetRecommenderConfigurationsCommand

Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.

GetSegmentCommand

Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.

GetSegmentExportJobsCommand

Retrieves information about the status and settings of the export jobs for a segment.

GetSegmentImportJobsCommand

Retrieves information about the status and settings of the import jobs for a segment.

GetSegmentVersionCommand

Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.

GetSegmentVersionsCommand

Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application.

GetSegmentsCommand

Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.

GetSmsChannelCommand

Retrieves information about the status and settings of the SMS channel for an application.

GetSmsTemplateCommand

Retrieves the content and settings of a message template for messages that are sent through the SMS channel.

GetUserEndpointsCommand

Retrieves information about all the endpoints that are associated with a specific user ID.

GetVoiceChannelCommand

Retrieves information about the status and settings of the voice channel for an application.

GetVoiceTemplateCommand

Retrieves the content and settings of a message template for messages that are sent through the voice channel.

ListJourneysCommand

Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.

ListTagsForResourceCommand

Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.

ListTemplateVersionsCommand

Retrieves information about all the versions of a specific message template.

ListTemplatesCommand

Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.

PhoneNumberValidateCommand

Retrieves information about a phone number.

PutEventStreamCommand

Creates a new event stream for an application or updates the settings of an existing event stream for an application.

PutEventsCommand

Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.

RemoveAttributesCommand

Removes one or more custom attributes, of the same attribute type, from the application. Existing endpoints still have the attributes but Amazon Pinpoint will stop capturing new or changed values for these attributes.

SendMessagesCommand

Creates and sends a direct message.

SendOTPMessageCommand

Send an OTP message

SendUsersMessagesCommand

Creates and sends a message to a list of users.

TagResourceCommand

Adds one or more tags (keys and values) to an application, campaign, message template, or segment.

UntagResourceCommand

Removes one or more tags (keys and values) from an application, campaign, message template, or segment.

UpdateAdmChannelCommand

Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.

UpdateApnsChannelCommand

Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.

UpdateApnsSandboxChannelCommand

Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.

UpdateApnsVoipChannelCommand

Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.

UpdateApnsVoipSandboxChannelCommand

Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.

UpdateApplicationSettingsCommand

Updates the settings for an application.

UpdateBaiduChannelCommand

Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.

UpdateCampaignCommand

Updates the configuration and other settings for a campaign.

UpdateEmailChannelCommand

Enables the email channel for an application or updates the status and settings of the email channel for an application.

UpdateEmailTemplateCommand

Updates an existing message template for messages that are sent through the email channel.

UpdateEndpointCommand

Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes for an endpoint. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.

UpdateEndpointsBatchCommand

Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes for a batch of endpoints. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.

UpdateGcmChannelCommand

Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.

UpdateInAppTemplateCommand

Updates an existing message template for messages sent through the in-app message channel.

UpdateJourneyCommand

Updates the configuration and other settings for a journey.

UpdateJourneyStateCommand

Cancels (stops) an active journey.

UpdatePushTemplateCommand

Updates an existing message template for messages that are sent through a push notification channel.

UpdateRecommenderConfigurationCommand

Updates an Amazon Pinpoint configuration for a recommender model.

UpdateSegmentCommand

Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.

UpdateSmsChannelCommand

Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.

UpdateSmsTemplateCommand

Updates an existing message template for messages that are sent through the SMS channel.

UpdateTemplateActiveVersionCommand

Changes the status of a specific version of a message template to active.

UpdateVoiceChannelCommand

Enables the voice channel for an application or updates the status and settings of the voice channel for an application.

UpdateVoiceTemplateCommand

Updates an existing message template for messages that are sent through the voice channel.

VerifyOTPMessageCommand

Verify an OTP

PinpointClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: PinpointClientConfig