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

Amazon Pinpoint

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 or updates an app.

CreateCampaign

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

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

Returns: a Paws::Pinpoint::CreateCampaignResponse instance

Creates or updates a campaign.

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.

CreateImportJob

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

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

Returns: a Paws::Pinpoint::CreateImportJobResponse instance

Creates or updates an import job.

CreateSegment

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

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

Returns: a Paws::Pinpoint::CreateSegmentResponse instance

Used to create or update a segment.

DeleteAdmChannel

ApplicationId => Str

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

Returns: a Paws::Pinpoint::DeleteAdmChannelResponse instance

Delete an ADM channel.

DeleteApnsChannel

ApplicationId => Str

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

Returns: a Paws::Pinpoint::DeleteApnsChannelResponse instance

Deletes the APNs channel for an app.

DeleteApnsSandboxChannel

ApplicationId => Str

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

Returns: a Paws::Pinpoint::DeleteApnsSandboxChannelResponse instance

Delete an APNS sandbox channel.

DeleteApnsVoipChannel

ApplicationId => Str

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

Returns: a Paws::Pinpoint::DeleteApnsVoipChannelResponse instance

Delete an APNS VoIP channel

DeleteApnsVoipSandboxChannel

ApplicationId => Str

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

Returns: a Paws::Pinpoint::DeleteApnsVoipSandboxChannelResponse instance

Delete an APNS VoIP sandbox channel

DeleteApp

ApplicationId => Str

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

Returns: a Paws::Pinpoint::DeleteAppResponse instance

Deletes an app.

DeleteBaiduChannel

ApplicationId => Str

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

Returns: a Paws::Pinpoint::DeleteBaiduChannelResponse instance

Delete a BAIDU GCM 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.

DeleteEmailChannel

ApplicationId => Str

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

Returns: a Paws::Pinpoint::DeleteEmailChannelResponse instance

Delete an 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.

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 app.

DeleteGcmChannel

ApplicationId => Str

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

Returns: a Paws::Pinpoint::DeleteGcmChannelResponse instance

Deletes the GCM channel for an app.

DeleteSegment

ApplicationId => Str
SegmentId => Str

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

Returns: a Paws::Pinpoint::DeleteSegmentResponse instance

Deletes a segment.

DeleteSmsChannel

ApplicationId => Str

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

Returns: a Paws::Pinpoint::DeleteSmsChannelResponse instance

Delete an SMS channel.

DeleteUserEndpoints

ApplicationId => Str
UserId => Str

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

Returns: a Paws::Pinpoint::DeleteUserEndpointsResponse instance

Deletes endpoints that are associated with a User ID.

DeleteVoiceChannel

ApplicationId => Str

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

Returns: a Paws::Pinpoint::DeleteVoiceChannelResponse instance

Delete an Voice channel

GetAdmChannel

ApplicationId => Str

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

Returns: a Paws::Pinpoint::GetAdmChannelResponse instance

Get an ADM channel.

GetApnsChannel

ApplicationId => Str

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

Returns: a Paws::Pinpoint::GetApnsChannelResponse instance

Returns information about the APNs channel for an app.

GetApnsSandboxChannel

ApplicationId => Str

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

Returns: a Paws::Pinpoint::GetApnsSandboxChannelResponse instance

Get an APNS sandbox channel.

GetApnsVoipChannel

ApplicationId => Str

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

Returns: a Paws::Pinpoint::GetApnsVoipChannelResponse instance

Get an APNS VoIP channel

GetApnsVoipSandboxChannel

ApplicationId => Str

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

Returns: a Paws::Pinpoint::GetApnsVoipSandboxChannelResponse instance

Get an APNS VoIPSandbox channel

GetApp

ApplicationId => Str

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

Returns: a Paws::Pinpoint::GetAppResponse instance

Returns information about an app.

GetApplicationSettings

ApplicationId => Str

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

Returns: a Paws::Pinpoint::GetApplicationSettingsResponse instance

Used to request the settings for an app.

GetApps

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

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

Returns: a Paws::Pinpoint::GetAppsResponse instance

Returns information about your apps.

GetBaiduChannel

ApplicationId => Str

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

Returns: a Paws::Pinpoint::GetBaiduChannelResponse instance

Get a BAIDU GCM channel

GetCampaign

ApplicationId => Str
CampaignId => Str

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

Returns: a Paws::Pinpoint::GetCampaignResponse instance

Returns information about 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

Returns information about the activity performed by 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

Returns information about your campaigns.

GetCampaignVersion

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

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

Returns: a Paws::Pinpoint::GetCampaignVersionResponse instance

Returns information about 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

Returns information about your campaign versions.

GetChannels

ApplicationId => Str

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

Returns: a Paws::Pinpoint::GetChannelsResponse instance

Get all channels.

GetEmailChannel

ApplicationId => Str

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

Returns: a Paws::Pinpoint::GetEmailChannelResponse instance

Get an email channel.

GetEndpoint

ApplicationId => Str
EndpointId => Str

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

Returns: a Paws::Pinpoint::GetEndpointResponse instance

Returns information about an endpoint.

GetEventStream

ApplicationId => Str

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

Returns: a Paws::Pinpoint::GetEventStreamResponse instance

Returns the event stream for an app.

GetExportJob

ApplicationId => Str
JobId => Str

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

Returns: a Paws::Pinpoint::GetExportJobResponse instance

Returns information about an export job.

GetExportJobs

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

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

Returns: a Paws::Pinpoint::GetExportJobsResponse instance

Returns information about your export jobs.

GetGcmChannel

ApplicationId => Str

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

Returns: a Paws::Pinpoint::GetGcmChannelResponse instance

Returns information about the GCM channel for an app.

GetImportJob

ApplicationId => Str
JobId => Str

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

Returns: a Paws::Pinpoint::GetImportJobResponse instance

Returns information about an import job.

GetImportJobs

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

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

Returns: a Paws::Pinpoint::GetImportJobsResponse instance

Returns information about your import jobs.

GetSegment

ApplicationId => Str
SegmentId => Str

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

Returns: a Paws::Pinpoint::GetSegmentResponse instance

Returns information about a segment.

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

Returns a list of export jobs for a specific 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

Returns a list of import jobs for a specific segment.

GetSegments

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

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

Returns: a Paws::Pinpoint::GetSegmentsResponse instance

Used to get information about your segments.

GetSegmentVersion

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

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

Returns: a Paws::Pinpoint::GetSegmentVersionResponse instance

Returns information about a segment version.

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

Returns information about your segment versions.

GetSmsChannel

ApplicationId => Str

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

Returns: a Paws::Pinpoint::GetSmsChannelResponse instance

Get an SMS channel.

GetUserEndpoints

ApplicationId => Str
UserId => Str

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

Returns: a Paws::Pinpoint::GetUserEndpointsResponse instance

Returns information about the endpoints that are associated with a User ID.

GetVoiceChannel

ApplicationId => Str

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

Returns: a Paws::Pinpoint::GetVoiceChannelResponse instance

Get a Voice Channel

PhoneNumberValidate

NumberValidateRequest => Paws::Pinpoint::NumberValidateRequest

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

Returns: a Paws::Pinpoint::PhoneNumberValidateResponse instance

Returns information about the specified 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

Use to record events for endpoints. This method creates events and creates or updates the endpoints that those 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

Use to create or update the event stream for an app.

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

Used to remove the attributes for an app

SendMessages

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

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

Returns: a Paws::Pinpoint::SendMessagesResponse instance

Used to send 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

Used to send a message to a list of users.

UpdateAdmChannel

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

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

Returns: a Paws::Pinpoint::UpdateAdmChannelResponse instance

Update an ADM channel.

UpdateApnsChannel

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

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

Returns: a Paws::Pinpoint::UpdateApnsChannelResponse instance

Use to update the APNs channel for an app.

UpdateApnsSandboxChannel

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

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

Returns: a Paws::Pinpoint::UpdateApnsSandboxChannelResponse instance

Update an APNS sandbox channel.

UpdateApnsVoipChannel

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

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

Returns: a Paws::Pinpoint::UpdateApnsVoipChannelResponse instance

Update an APNS VoIP channel

UpdateApnsVoipSandboxChannel

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

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

Returns: a Paws::Pinpoint::UpdateApnsVoipSandboxChannelResponse instance

Update an APNS VoIP sandbox channel

UpdateApplicationSettings

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

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

Returns: a Paws::Pinpoint::UpdateApplicationSettingsResponse instance

Used to update the settings for an app.

UpdateBaiduChannel

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

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

Returns: a Paws::Pinpoint::UpdateBaiduChannelResponse instance

Update a BAIDU GCM channel

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

Use to update 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

Update an 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 or updates an endpoint.

UpdateEndpointsBatch

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

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

Returns: a Paws::Pinpoint::UpdateEndpointsBatchResponse instance

Use to update a batch of endpoints.

UpdateGcmChannel

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

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

Returns: a Paws::Pinpoint::UpdateGcmChannelResponse instance

Use to update the GCM channel for an app.

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

Used to update a segment.

UpdateSmsChannel

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

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

Returns: a Paws::Pinpoint::UpdateSmsChannelResponse instance

Update an SMS channel.

UpdateVoiceChannel

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

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

Returns: a Paws::Pinpoint::UpdateVoiceChannelResponse instance

Update an 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