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::ApplicationResponse 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::CampaignResponse instance

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

CreateExportJob

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

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

Returns: a Paws::Pinpoint::CreateExportJobResponse instance

Creates a new 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 a new import job for an application.

CreateSegment

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

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

Returns: a Paws::Pinpoint::SegmentResponse 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.

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::ApplicationResponse 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.

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.

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.

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.

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::ApplicationResponse instance

Retrieves information about an application.

GetApplicationSettings

ApplicationId => Str

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

Returns: a Paws::Pinpoint::ApplicationSettingsResource 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 of your applications.

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 Cloud Push 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::ActivitiesResponse instance

Retrieves 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

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::CampaignResponse 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::CampaignsResponse instance

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

GetChannels

ApplicationId => Str

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

Returns: a Paws::Pinpoint::ChannelsResponse 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.

GetEndpoint

ApplicationId => Str
EndpointId => Str

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

Returns: a Paws::Pinpoint::EndpointResponse 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.

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

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.

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, or segment.

PhoneNumberValidate

NumberValidateRequest => Paws::Pinpoint::NumberValidateRequest

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

Returns: a Paws::Pinpoint::NumberValidateResponse 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::MessageResponse 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, 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, 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

Updates the ADM channel settings 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

Updates the APNs channel settings 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

Updates the APNs sandbox channel settings 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

Updates the APNs VoIP channel settings 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

Updates the settings for 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

Updates the 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 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

Updates the status and settings of the email channel for an application.

UpdateEndpoint

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

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

Returns: a Paws::Pinpoint::MessageBody 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 (Attributes, Metrics, and UserAttributes properties) for 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

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 (Attributes, Metrics, and UserAttributes properties) for 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

Updates the status and settings of the GCM channel for an application.

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

Updates the status and settings of the SMS channel for an application.

UpdateVoiceChannel

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

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

Returns: a Paws::Pinpoint::UpdateVoiceChannelResponse instance

Updates the status and settings of the voice channel for an application.

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