The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Paws::Pinpoint - Perl Interface to AWS Amazon Pinpoint

SYNOPSIS

  use Paws;

  my $obj = Paws->service('Pinpoint');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

Doc Engage API - Amazon Pinpoint API

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01

METHODS

CreateApp

CreateApplicationRequest => Paws::Pinpoint::CreateApplicationRequest

Each argument is described in detail in: Paws::Pinpoint::CreateApp

Returns: a Paws::Pinpoint::CreateAppResponse instance

Creates an application.

CreateCampaign

ApplicationId => Str
WriteCampaignRequest => Paws::Pinpoint::WriteCampaignRequest

Each argument is described in detail in: Paws::Pinpoint::CreateCampaign

Returns: a Paws::Pinpoint::CreateCampaignResponse instance

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

CreateEmailTemplate

EmailTemplateRequest => Paws::Pinpoint::EmailTemplateRequest
TemplateName => Str

Each argument is described in detail in: Paws::Pinpoint::CreateEmailTemplate

Returns: a Paws::Pinpoint::CreateEmailTemplateResponse instance

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

CreateExportJob

ApplicationId => Str
ExportJobRequest => Paws::Pinpoint::ExportJobRequest

Each argument is described in detail in: Paws::Pinpoint::CreateExportJob

Returns: a Paws::Pinpoint::CreateExportJobResponse instance

Creates an export job for an application.

CreateImportJob

ApplicationId => Str
ImportJobRequest => Paws::Pinpoint::ImportJobRequest

Each argument is described in detail in: Paws::Pinpoint::CreateImportJob

Returns: a Paws::Pinpoint::CreateImportJobResponse instance

Creates an import job for an application.

CreateJourney

ApplicationId => Str
WriteJourneyRequest => Paws::Pinpoint::WriteJourneyRequest

Each argument is described in detail in: Paws::Pinpoint::CreateJourney

Returns: a Paws::Pinpoint::CreateJourneyResponse instance

Creates a journey for an application.

CreatePushTemplate

PushNotificationTemplateRequest => Paws::Pinpoint::PushNotificationTemplateRequest
TemplateName => Str

Each argument is described in detail in: Paws::Pinpoint::CreatePushTemplate

Returns: a Paws::Pinpoint::CreatePushTemplateResponse instance

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

CreateRecommenderConfiguration

CreateRecommenderConfiguration => Paws::Pinpoint::CreateRecommenderConfigurationObj

Each argument is described in detail in: Paws::Pinpoint::CreateRecommenderConfiguration

Returns: a Paws::Pinpoint::CreateRecommenderConfigurationResponse instance

Creates an Amazon Pinpoint configuration for a recommender model.

CreateSegment

ApplicationId => Str
WriteSegmentRequest => Paws::Pinpoint::WriteSegmentRequest

Each argument is described in detail in: Paws::Pinpoint::CreateSegment

Returns: a Paws::Pinpoint::CreateSegmentResponse instance

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.

CreateSmsTemplate

SMSTemplateRequest => Paws::Pinpoint::SMSTemplateRequest
TemplateName => Str

Each argument is described in detail in: Paws::Pinpoint::CreateSmsTemplate

Returns: a Paws::Pinpoint::CreateSmsTemplateResponse instance

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

CreateVoiceTemplate

TemplateName => Str
VoiceTemplateRequest => Paws::Pinpoint::VoiceTemplateRequest

Each argument is described in detail in: Paws::Pinpoint::CreateVoiceTemplate

Returns: a Paws::Pinpoint::CreateVoiceTemplateResponse instance

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

DeleteAdmChannel

ApplicationId => Str

Each argument is described in detail in: Paws::Pinpoint::DeleteAdmChannel

Returns: a Paws::Pinpoint::DeleteAdmChannelResponse instance

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

DeleteApnsChannel

ApplicationId => Str

Each argument is described in detail in: Paws::Pinpoint::DeleteApnsChannel

Returns: a Paws::Pinpoint::DeleteApnsChannelResponse instance

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

DeleteApnsSandboxChannel

ApplicationId => Str

Each argument is described in detail in: Paws::Pinpoint::DeleteApnsSandboxChannel

Returns: a Paws::Pinpoint::DeleteApnsSandboxChannelResponse instance

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

DeleteApnsVoipChannel

ApplicationId => Str

Each argument is described in detail in: Paws::Pinpoint::DeleteApnsVoipChannel

Returns: a Paws::Pinpoint::DeleteApnsVoipChannelResponse instance

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

DeleteApnsVoipSandboxChannel

ApplicationId => Str

Each argument is described in detail in: Paws::Pinpoint::DeleteApnsVoipSandboxChannel

Returns: a Paws::Pinpoint::DeleteApnsVoipSandboxChannelResponse instance

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

DeleteApp

ApplicationId => Str

Each argument is described in detail in: Paws::Pinpoint::DeleteApp

Returns: a Paws::Pinpoint::DeleteAppResponse instance

Deletes an application.

DeleteBaiduChannel

ApplicationId => Str

Each argument is described in detail in: Paws::Pinpoint::DeleteBaiduChannel

Returns: a Paws::Pinpoint::DeleteBaiduChannelResponse instance

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

DeleteCampaign

ApplicationId => Str
CampaignId => Str

Each argument is described in detail in: Paws::Pinpoint::DeleteCampaign

Returns: a Paws::Pinpoint::DeleteCampaignResponse instance

Deletes a campaign from an application.

DeleteEmailChannel

ApplicationId => Str

Each argument is described in detail in: Paws::Pinpoint::DeleteEmailChannel

Returns: a Paws::Pinpoint::DeleteEmailChannelResponse instance

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

DeleteEmailTemplate

TemplateName => Str
[Version => Str]

Each argument is described in detail in: Paws::Pinpoint::DeleteEmailTemplate

Returns: a Paws::Pinpoint::DeleteEmailTemplateResponse instance

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

DeleteEndpoint

ApplicationId => Str
EndpointId => Str

Each argument is described in detail in: Paws::Pinpoint::DeleteEndpoint

Returns: a Paws::Pinpoint::DeleteEndpointResponse instance

Deletes an endpoint from an application.

DeleteEventStream

ApplicationId => Str

Each argument is described in detail in: Paws::Pinpoint::DeleteEventStream

Returns: a Paws::Pinpoint::DeleteEventStreamResponse instance

Deletes the event stream for an application.

DeleteGcmChannel

ApplicationId => Str

Each argument is described in detail in: Paws::Pinpoint::DeleteGcmChannel

Returns: a Paws::Pinpoint::DeleteGcmChannelResponse instance

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

DeleteJourney

ApplicationId => Str
JourneyId => Str

Each argument is described in detail in: Paws::Pinpoint::DeleteJourney

Returns: a Paws::Pinpoint::DeleteJourneyResponse instance

Deletes a journey from an application.

DeletePushTemplate

TemplateName => Str
[Version => Str]

Each argument is described in detail in: Paws::Pinpoint::DeletePushTemplate

Returns: a Paws::Pinpoint::DeletePushTemplateResponse instance

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

DeleteRecommenderConfiguration

RecommenderId => Str

Each argument is described in detail in: Paws::Pinpoint::DeleteRecommenderConfiguration

Returns: a Paws::Pinpoint::DeleteRecommenderConfigurationResponse instance

Deletes an Amazon Pinpoint configuration for a recommender model.

DeleteSegment

ApplicationId => Str
SegmentId => Str

Each argument is described in detail in: Paws::Pinpoint::DeleteSegment

Returns: a Paws::Pinpoint::DeleteSegmentResponse instance

Deletes a segment from an application.

DeleteSmsChannel

ApplicationId => Str

Each argument is described in detail in: Paws::Pinpoint::DeleteSmsChannel

Returns: a Paws::Pinpoint::DeleteSmsChannelResponse instance

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

DeleteSmsTemplate

TemplateName => Str
[Version => Str]

Each argument is described in detail in: Paws::Pinpoint::DeleteSmsTemplate

Returns: a Paws::Pinpoint::DeleteSmsTemplateResponse instance

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

DeleteUserEndpoints

ApplicationId => Str
UserId => Str

Each argument is described in detail in: Paws::Pinpoint::DeleteUserEndpoints

Returns: a Paws::Pinpoint::DeleteUserEndpointsResponse instance

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

DeleteVoiceChannel

ApplicationId => Str

Each argument is described in detail in: Paws::Pinpoint::DeleteVoiceChannel

Returns: a Paws::Pinpoint::DeleteVoiceChannelResponse instance

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

DeleteVoiceTemplate

TemplateName => Str
[Version => Str]

Each argument is described in detail in: Paws::Pinpoint::DeleteVoiceTemplate

Returns: a Paws::Pinpoint::DeleteVoiceTemplateResponse instance

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

GetAdmChannel

ApplicationId => Str

Each argument is described in detail in: Paws::Pinpoint::GetAdmChannel

Returns: a Paws::Pinpoint::GetAdmChannelResponse instance

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

GetApnsChannel

ApplicationId => Str

Each argument is described in detail in: Paws::Pinpoint::GetApnsChannel

Returns: a Paws::Pinpoint::GetApnsChannelResponse instance

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

GetApnsSandboxChannel

ApplicationId => Str

Each argument is described in detail in: Paws::Pinpoint::GetApnsSandboxChannel

Returns: a Paws::Pinpoint::GetApnsSandboxChannelResponse instance

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

GetApnsVoipChannel

ApplicationId => Str

Each argument is described in detail in: Paws::Pinpoint::GetApnsVoipChannel

Returns: a Paws::Pinpoint::GetApnsVoipChannelResponse instance

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

GetApnsVoipSandboxChannel

ApplicationId => Str

Each argument is described in detail in: Paws::Pinpoint::GetApnsVoipSandboxChannel

Returns: a Paws::Pinpoint::GetApnsVoipSandboxChannelResponse instance

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

GetApp

ApplicationId => Str

Each argument is described in detail in: Paws::Pinpoint::GetApp

Returns: a Paws::Pinpoint::GetAppResponse instance

Retrieves information about an application.

GetApplicationDateRangeKpi

ApplicationId => Str
KpiName => Str
[EndTime => Str]
[NextToken => Str]
[PageSize => Str]
[StartTime => Str]

Each argument is described in detail in: Paws::Pinpoint::GetApplicationDateRangeKpi

Returns: a Paws::Pinpoint::GetApplicationDateRangeKpiResponse instance

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

GetApplicationSettings

ApplicationId => Str

Each argument is described in detail in: Paws::Pinpoint::GetApplicationSettings

Returns: a Paws::Pinpoint::GetApplicationSettingsResponse instance

Retrieves information about the settings for an application.

GetApps

[PageSize => Str]
[Token => Str]

Each argument is described in detail in: Paws::Pinpoint::GetApps

Returns: a Paws::Pinpoint::GetAppsResponse instance

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

GetBaiduChannel

ApplicationId => Str

Each argument is described in detail in: Paws::Pinpoint::GetBaiduChannel

Returns: a Paws::Pinpoint::GetBaiduChannelResponse instance

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

GetCampaign

ApplicationId => Str
CampaignId => Str

Each argument is described in detail in: Paws::Pinpoint::GetCampaign

Returns: a Paws::Pinpoint::GetCampaignResponse instance

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

GetCampaignActivities

ApplicationId => Str
CampaignId => Str
[PageSize => Str]
[Token => Str]

Each argument is described in detail in: Paws::Pinpoint::GetCampaignActivities

Returns: a Paws::Pinpoint::GetCampaignActivitiesResponse instance

Retrieves information about all the activities for a campaign.

GetCampaignDateRangeKpi

ApplicationId => Str
CampaignId => Str
KpiName => Str
[EndTime => Str]
[NextToken => Str]
[PageSize => Str]
[StartTime => Str]

Each argument is described in detail in: Paws::Pinpoint::GetCampaignDateRangeKpi

Returns: a Paws::Pinpoint::GetCampaignDateRangeKpiResponse instance

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

GetCampaigns

ApplicationId => Str
[PageSize => Str]
[Token => Str]

Each argument is described in detail in: Paws::Pinpoint::GetCampaigns

Returns: a Paws::Pinpoint::GetCampaignsResponse instance

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

GetCampaignVersion

ApplicationId => Str
CampaignId => Str
Version => Str

Each argument is described in detail in: Paws::Pinpoint::GetCampaignVersion

Returns: a Paws::Pinpoint::GetCampaignVersionResponse instance

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

GetCampaignVersions

ApplicationId => Str
CampaignId => Str
[PageSize => Str]
[Token => Str]

Each argument is described in detail in: Paws::Pinpoint::GetCampaignVersions

Returns: a Paws::Pinpoint::GetCampaignVersionsResponse instance

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

GetChannels

ApplicationId => Str

Each argument is described in detail in: Paws::Pinpoint::GetChannels

Returns: a Paws::Pinpoint::GetChannelsResponse instance

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

GetEmailChannel

ApplicationId => Str

Each argument is described in detail in: Paws::Pinpoint::GetEmailChannel

Returns: a Paws::Pinpoint::GetEmailChannelResponse instance

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

GetEmailTemplate

TemplateName => Str
[Version => Str]

Each argument is described in detail in: Paws::Pinpoint::GetEmailTemplate

Returns: a Paws::Pinpoint::GetEmailTemplateResponse instance

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

GetEndpoint

ApplicationId => Str
EndpointId => Str

Each argument is described in detail in: Paws::Pinpoint::GetEndpoint

Returns: a Paws::Pinpoint::GetEndpointResponse instance

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

GetEventStream

ApplicationId => Str

Each argument is described in detail in: Paws::Pinpoint::GetEventStream

Returns: a Paws::Pinpoint::GetEventStreamResponse instance

Retrieves information about the event stream settings for an application.

GetExportJob

ApplicationId => Str
JobId => Str

Each argument is described in detail in: Paws::Pinpoint::GetExportJob

Returns: a Paws::Pinpoint::GetExportJobResponse instance

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

GetExportJobs

ApplicationId => Str
[PageSize => Str]
[Token => Str]

Each argument is described in detail in: Paws::Pinpoint::GetExportJobs

Returns: a Paws::Pinpoint::GetExportJobsResponse instance

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

GetGcmChannel

ApplicationId => Str

Each argument is described in detail in: Paws::Pinpoint::GetGcmChannel

Returns: a Paws::Pinpoint::GetGcmChannelResponse instance

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

GetImportJob

ApplicationId => Str
JobId => Str

Each argument is described in detail in: Paws::Pinpoint::GetImportJob

Returns: a Paws::Pinpoint::GetImportJobResponse instance

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

GetImportJobs

ApplicationId => Str
[PageSize => Str]
[Token => Str]

Each argument is described in detail in: Paws::Pinpoint::GetImportJobs

Returns: a Paws::Pinpoint::GetImportJobsResponse instance

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

GetJourney

ApplicationId => Str
JourneyId => Str

Each argument is described in detail in: Paws::Pinpoint::GetJourney

Returns: a Paws::Pinpoint::GetJourneyResponse instance

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

GetJourneyDateRangeKpi

ApplicationId => Str
JourneyId => Str
KpiName => Str
[EndTime => Str]
[NextToken => Str]
[PageSize => Str]
[StartTime => Str]

Each argument is described in detail in: Paws::Pinpoint::GetJourneyDateRangeKpi

Returns: a Paws::Pinpoint::GetJourneyDateRangeKpiResponse instance

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

GetJourneyExecutionActivityMetrics

ApplicationId => Str
JourneyActivityId => Str
JourneyId => Str
[NextToken => Str]
[PageSize => Str]

Each argument is described in detail in: Paws::Pinpoint::GetJourneyExecutionActivityMetrics

Returns: a Paws::Pinpoint::GetJourneyExecutionActivityMetricsResponse instance

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

GetJourneyExecutionMetrics

ApplicationId => Str
JourneyId => Str
[NextToken => Str]
[PageSize => Str]

Each argument is described in detail in: Paws::Pinpoint::GetJourneyExecutionMetrics

Returns: a Paws::Pinpoint::GetJourneyExecutionMetricsResponse instance

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

GetPushTemplate

TemplateName => Str
[Version => Str]

Each argument is described in detail in: Paws::Pinpoint::GetPushTemplate

Returns: a Paws::Pinpoint::GetPushTemplateResponse instance

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

GetRecommenderConfiguration

RecommenderId => Str

Each argument is described in detail in: Paws::Pinpoint::GetRecommenderConfiguration

Returns: a Paws::Pinpoint::GetRecommenderConfigurationResponse instance

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

GetRecommenderConfigurations

[PageSize => Str]
[Token => Str]

Each argument is described in detail in: Paws::Pinpoint::GetRecommenderConfigurations

Returns: a Paws::Pinpoint::GetRecommenderConfigurationsResponse instance

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

GetSegment

ApplicationId => Str
SegmentId => Str

Each argument is described in detail in: Paws::Pinpoint::GetSegment

Returns: a Paws::Pinpoint::GetSegmentResponse instance

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

GetSegmentExportJobs

ApplicationId => Str
SegmentId => Str
[PageSize => Str]
[Token => Str]

Each argument is described in detail in: Paws::Pinpoint::GetSegmentExportJobs

Returns: a Paws::Pinpoint::GetSegmentExportJobsResponse instance

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

GetSegmentImportJobs

ApplicationId => Str
SegmentId => Str
[PageSize => Str]
[Token => Str]

Each argument is described in detail in: Paws::Pinpoint::GetSegmentImportJobs

Returns: a Paws::Pinpoint::GetSegmentImportJobsResponse instance

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

GetSegments

ApplicationId => Str
[PageSize => Str]
[Token => Str]

Each argument is described in detail in: Paws::Pinpoint::GetSegments

Returns: a Paws::Pinpoint::GetSegmentsResponse instance

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

GetSegmentVersion

ApplicationId => Str
SegmentId => Str
Version => Str

Each argument is described in detail in: Paws::Pinpoint::GetSegmentVersion

Returns: a Paws::Pinpoint::GetSegmentVersionResponse instance

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

GetSegmentVersions

ApplicationId => Str
SegmentId => Str
[PageSize => Str]
[Token => Str]

Each argument is described in detail in: Paws::Pinpoint::GetSegmentVersions

Returns: a Paws::Pinpoint::GetSegmentVersionsResponse instance

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

GetSmsChannel

ApplicationId => Str

Each argument is described in detail in: Paws::Pinpoint::GetSmsChannel

Returns: a Paws::Pinpoint::GetSmsChannelResponse instance

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

GetSmsTemplate

TemplateName => Str
[Version => Str]

Each argument is described in detail in: Paws::Pinpoint::GetSmsTemplate

Returns: a Paws::Pinpoint::GetSmsTemplateResponse instance

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

GetUserEndpoints

ApplicationId => Str
UserId => Str

Each argument is described in detail in: Paws::Pinpoint::GetUserEndpoints

Returns: a Paws::Pinpoint::GetUserEndpointsResponse instance

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

GetVoiceChannel

ApplicationId => Str

Each argument is described in detail in: Paws::Pinpoint::GetVoiceChannel

Returns: a Paws::Pinpoint::GetVoiceChannelResponse instance

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

GetVoiceTemplate

TemplateName => Str
[Version => Str]

Each argument is described in detail in: Paws::Pinpoint::GetVoiceTemplate

Returns: a Paws::Pinpoint::GetVoiceTemplateResponse instance

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

ListJourneys

ApplicationId => Str
[PageSize => Str]
[Token => Str]

Each argument is described in detail in: Paws::Pinpoint::ListJourneys

Returns: a Paws::Pinpoint::ListJourneysResponse instance

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

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::Pinpoint::ListTagsForResource

Returns: a Paws::Pinpoint::ListTagsForResourceResponse instance

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

ListTemplates

[NextToken => Str]
[PageSize => Str]
[Prefix => Str]
[TemplateType => Str]

Each argument is described in detail in: Paws::Pinpoint::ListTemplates

Returns: a Paws::Pinpoint::ListTemplatesResponse instance

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

ListTemplateVersions

TemplateName => Str
TemplateType => Str
[NextToken => Str]
[PageSize => Str]

Each argument is described in detail in: Paws::Pinpoint::ListTemplateVersions

Returns: a Paws::Pinpoint::ListTemplateVersionsResponse instance

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

PhoneNumberValidate

NumberValidateRequest => Paws::Pinpoint::NumberValidateRequest

Each argument is described in detail in: Paws::Pinpoint::PhoneNumberValidate

Returns: a Paws::Pinpoint::PhoneNumberValidateResponse instance

Retrieves information about a phone number.

PutEvents

ApplicationId => Str
EventsRequest => Paws::Pinpoint::EventsRequest

Each argument is described in detail in: Paws::Pinpoint::PutEvents

Returns: a Paws::Pinpoint::PutEventsResponse instance

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

PutEventStream

ApplicationId => Str
WriteEventStream => Paws::Pinpoint::WriteEventStream

Each argument is described in detail in: Paws::Pinpoint::PutEventStream

Returns: a Paws::Pinpoint::PutEventStreamResponse instance

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

RemoveAttributes

ApplicationId => Str
AttributeType => Str
UpdateAttributesRequest => Paws::Pinpoint::UpdateAttributesRequest

Each argument is described in detail in: Paws::Pinpoint::RemoveAttributes

Returns: a Paws::Pinpoint::RemoveAttributesResponse instance

Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application.

SendMessages

ApplicationId => Str
MessageRequest => Paws::Pinpoint::MessageRequest

Each argument is described in detail in: Paws::Pinpoint::SendMessages

Returns: a Paws::Pinpoint::SendMessagesResponse instance

Creates and sends a direct message.

SendUsersMessages

ApplicationId => Str
SendUsersMessageRequest => Paws::Pinpoint::SendUsersMessageRequest

Each argument is described in detail in: Paws::Pinpoint::SendUsersMessages

Returns: a Paws::Pinpoint::SendUsersMessagesResponse instance

Creates and sends a message to a list of users.

TagResource

ResourceArn => Str
TagsModel => Paws::Pinpoint::TagsModel

Each argument is described in detail in: Paws::Pinpoint::TagResource

Returns: nothing

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

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::Pinpoint::UntagResource

Returns: nothing

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

UpdateAdmChannel

ADMChannelRequest => Paws::Pinpoint::ADMChannelRequest
ApplicationId => Str

Each argument is described in detail in: Paws::Pinpoint::UpdateAdmChannel

Returns: a Paws::Pinpoint::UpdateAdmChannelResponse instance

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

UpdateApnsChannel

APNSChannelRequest => Paws::Pinpoint::APNSChannelRequest
ApplicationId => Str

Each argument is described in detail in: Paws::Pinpoint::UpdateApnsChannel

Returns: a Paws::Pinpoint::UpdateApnsChannelResponse instance

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

UpdateApnsSandboxChannel

APNSSandboxChannelRequest => Paws::Pinpoint::APNSSandboxChannelRequest
ApplicationId => Str

Each argument is described in detail in: Paws::Pinpoint::UpdateApnsSandboxChannel

Returns: a Paws::Pinpoint::UpdateApnsSandboxChannelResponse instance

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

UpdateApnsVoipChannel

APNSVoipChannelRequest => Paws::Pinpoint::APNSVoipChannelRequest
ApplicationId => Str

Each argument is described in detail in: Paws::Pinpoint::UpdateApnsVoipChannel

Returns: a Paws::Pinpoint::UpdateApnsVoipChannelResponse instance

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

UpdateApnsVoipSandboxChannel

APNSVoipSandboxChannelRequest => Paws::Pinpoint::APNSVoipSandboxChannelRequest
ApplicationId => Str

Each argument is described in detail in: Paws::Pinpoint::UpdateApnsVoipSandboxChannel

Returns: a Paws::Pinpoint::UpdateApnsVoipSandboxChannelResponse instance

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

UpdateApplicationSettings

ApplicationId => Str
WriteApplicationSettingsRequest => Paws::Pinpoint::WriteApplicationSettingsRequest

Each argument is described in detail in: Paws::Pinpoint::UpdateApplicationSettings

Returns: a Paws::Pinpoint::UpdateApplicationSettingsResponse instance

Updates the settings for an application.

UpdateBaiduChannel

ApplicationId => Str
BaiduChannelRequest => Paws::Pinpoint::BaiduChannelRequest

Each argument is described in detail in: Paws::Pinpoint::UpdateBaiduChannel

Returns: a Paws::Pinpoint::UpdateBaiduChannelResponse instance

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

UpdateCampaign

ApplicationId => Str
CampaignId => Str
WriteCampaignRequest => Paws::Pinpoint::WriteCampaignRequest

Each argument is described in detail in: Paws::Pinpoint::UpdateCampaign

Returns: a Paws::Pinpoint::UpdateCampaignResponse instance

Updates the configuration and other settings for a campaign.

UpdateEmailChannel

ApplicationId => Str
EmailChannelRequest => Paws::Pinpoint::EmailChannelRequest

Each argument is described in detail in: Paws::Pinpoint::UpdateEmailChannel

Returns: a Paws::Pinpoint::UpdateEmailChannelResponse instance

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

UpdateEmailTemplate

EmailTemplateRequest => Paws::Pinpoint::EmailTemplateRequest
TemplateName => Str
[CreateNewVersion => Bool]
[Version => Str]

Each argument is described in detail in: Paws::Pinpoint::UpdateEmailTemplate

Returns: a Paws::Pinpoint::UpdateEmailTemplateResponse instance

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

UpdateEndpoint

ApplicationId => Str
EndpointId => Str
EndpointRequest => Paws::Pinpoint::EndpointRequest

Each argument is described in detail in: Paws::Pinpoint::UpdateEndpoint

Returns: a Paws::Pinpoint::UpdateEndpointResponse instance

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.

UpdateEndpointsBatch

ApplicationId => Str
EndpointBatchRequest => Paws::Pinpoint::EndpointBatchRequest

Each argument is described in detail in: Paws::Pinpoint::UpdateEndpointsBatch

Returns: a Paws::Pinpoint::UpdateEndpointsBatchResponse instance

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.

UpdateGcmChannel

ApplicationId => Str
GCMChannelRequest => Paws::Pinpoint::GCMChannelRequest

Each argument is described in detail in: Paws::Pinpoint::UpdateGcmChannel

Returns: a Paws::Pinpoint::UpdateGcmChannelResponse instance

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

UpdateJourney

ApplicationId => Str
JourneyId => Str
WriteJourneyRequest => Paws::Pinpoint::WriteJourneyRequest

Each argument is described in detail in: Paws::Pinpoint::UpdateJourney

Returns: a Paws::Pinpoint::UpdateJourneyResponse instance

Updates the configuration and other settings for a journey.

UpdateJourneyState

ApplicationId => Str
JourneyId => Str
JourneyStateRequest => Paws::Pinpoint::JourneyStateRequest

Each argument is described in detail in: Paws::Pinpoint::UpdateJourneyState

Returns: a Paws::Pinpoint::UpdateJourneyStateResponse instance

Cancels (stops) an active journey.

UpdatePushTemplate

PushNotificationTemplateRequest => Paws::Pinpoint::PushNotificationTemplateRequest
TemplateName => Str
[CreateNewVersion => Bool]
[Version => Str]

Each argument is described in detail in: Paws::Pinpoint::UpdatePushTemplate

Returns: a Paws::Pinpoint::UpdatePushTemplateResponse instance

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

UpdateRecommenderConfiguration

RecommenderId => Str
UpdateRecommenderConfiguration => Paws::Pinpoint::UpdateRecommenderConfigurationObj

Each argument is described in detail in: Paws::Pinpoint::UpdateRecommenderConfiguration

Returns: a Paws::Pinpoint::UpdateRecommenderConfigurationResponse instance

Updates an Amazon Pinpoint configuration for a recommender model.

UpdateSegment

ApplicationId => Str
SegmentId => Str
WriteSegmentRequest => Paws::Pinpoint::WriteSegmentRequest

Each argument is described in detail in: Paws::Pinpoint::UpdateSegment

Returns: a Paws::Pinpoint::UpdateSegmentResponse instance

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.

UpdateSmsChannel

ApplicationId => Str
SMSChannelRequest => Paws::Pinpoint::SMSChannelRequest

Each argument is described in detail in: Paws::Pinpoint::UpdateSmsChannel

Returns: a Paws::Pinpoint::UpdateSmsChannelResponse instance

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

UpdateSmsTemplate

SMSTemplateRequest => Paws::Pinpoint::SMSTemplateRequest
TemplateName => Str
[CreateNewVersion => Bool]
[Version => Str]

Each argument is described in detail in: Paws::Pinpoint::UpdateSmsTemplate

Returns: a Paws::Pinpoint::UpdateSmsTemplateResponse instance

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

UpdateTemplateActiveVersion

TemplateActiveVersionRequest => Paws::Pinpoint::TemplateActiveVersionRequest
TemplateName => Str
TemplateType => Str

Each argument is described in detail in: Paws::Pinpoint::UpdateTemplateActiveVersion

Returns: a Paws::Pinpoint::UpdateTemplateActiveVersionResponse instance

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

UpdateVoiceChannel

ApplicationId => Str
VoiceChannelRequest => Paws::Pinpoint::VoiceChannelRequest

Each argument is described in detail in: Paws::Pinpoint::UpdateVoiceChannel

Returns: a Paws::Pinpoint::UpdateVoiceChannelResponse instance

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

UpdateVoiceTemplate

TemplateName => Str
VoiceTemplateRequest => Paws::Pinpoint::VoiceTemplateRequest
[CreateNewVersion => Bool]
[Version => Str]

Each argument is described in detail in: Paws::Pinpoint::UpdateVoiceTemplate

Returns: a Paws::Pinpoint::UpdateVoiceTemplateResponse instance

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

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues