(constructor)

[configuration]

Constructs a new instance of the <code>PinpointClient</code> class

config

The resolved configuration of PinpointClient class. This is resolved and normalized from the [constructor configuration interface](@aws-sdk/client-pinpoint!PinpointClientConfig:Interface).

destroy

Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

middlewareStack

send

command

options

PinpointClient

Doc Engage API - Amazon Pinpoint API

defaultsMode

The [@smithy/smithy-client#DefaultsMode](@smithy/smithy-client!DefaultsMode:type) that will be used to determine how certain default configuration options are resolved in the SDK.

disableHostPrefix

Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.

extensions

logger

Optional logger for logging debug/info/warn/error.

maxAttempts

Value for how many times a request will be made at most in case of retry.

region

The AWS region to which this client will send requests

requestHandler

The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.

retryMode

useDualstackEndpoint

useFipsEndpoint

ClientDefaults

CreateAppCommand

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

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.