Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Pinpoint.Lens

Contents

Operations
Types

Description

Synopsis

Operations

GetGcmChannel

getGcmChannel_applicationId :: Lens' GetGcmChannel Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getGcmChannelResponse_httpStatus :: Lens' GetGcmChannelResponse Int Source #

The response's http status code.

getGcmChannelResponse_gCMChannelResponse :: Lens' GetGcmChannelResponse GCMChannelResponse Source #

Undocumented member.

GetSegmentImportJobs

getSegmentImportJobs_token :: Lens' GetSegmentImportJobs (Maybe Text) Source #

The NextToken string that specifies which page of results to return in a paginated response.

getSegmentImportJobs_pageSize :: Lens' GetSegmentImportJobs (Maybe Text) Source #

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

getSegmentImportJobs_segmentId :: Lens' GetSegmentImportJobs Text Source #

The unique identifier for the segment.

getSegmentImportJobs_applicationId :: Lens' GetSegmentImportJobs Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getSegmentImportJobsResponse_httpStatus :: Lens' GetSegmentImportJobsResponse Int Source #

The response's http status code.

getSegmentImportJobsResponse_importJobsResponse :: Lens' GetSegmentImportJobsResponse ImportJobsResponse Source #

Undocumented member.

SendMessages

sendMessages_applicationId :: Lens' SendMessages Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

sendMessages_messageRequest :: Lens' SendMessages MessageRequest Source #

Undocumented member.

sendMessagesResponse_httpStatus :: Lens' SendMessagesResponse Int Source #

The response's http status code.

sendMessagesResponse_messageResponse :: Lens' SendMessagesResponse MessageResponse Source #

Undocumented member.

GetImportJob

getImportJob_applicationId :: Lens' GetImportJob Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getImportJob_jobId :: Lens' GetImportJob Text Source #

The unique identifier for the job.

getImportJobResponse_httpStatus :: Lens' GetImportJobResponse Int Source #

The response's http status code.

getImportJobResponse_importJobResponse :: Lens' GetImportJobResponse ImportJobResponse Source #

Undocumented member.

DeleteSmsTemplate

deleteSmsTemplate_version :: Lens' DeleteSmsTemplate (Maybe Text) Source #

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.

deleteSmsTemplate_templateName :: Lens' DeleteSmsTemplate Text Source #

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

deleteSmsTemplateResponse_httpStatus :: Lens' DeleteSmsTemplateResponse Int Source #

The response's http status code.

deleteSmsTemplateResponse_messageBody :: Lens' DeleteSmsTemplateResponse MessageBody Source #

Undocumented member.

UpdateSmsTemplate

updateSmsTemplate_version :: Lens' UpdateSmsTemplate (Maybe Text) Source #

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.

updateSmsTemplate_createNewVersion :: Lens' UpdateSmsTemplate (Maybe Bool) Source #

Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.

updateSmsTemplate_templateName :: Lens' UpdateSmsTemplate Text Source #

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

updateSmsTemplate_sMSTemplateRequest :: Lens' UpdateSmsTemplate SMSTemplateRequest Source #

Undocumented member.

updateSmsTemplateResponse_httpStatus :: Lens' UpdateSmsTemplateResponse Int Source #

The response's http status code.

updateSmsTemplateResponse_messageBody :: Lens' UpdateSmsTemplateResponse MessageBody Source #

Undocumented member.

GetApnsVoipSandboxChannel

getApnsVoipSandboxChannel_applicationId :: Lens' GetApnsVoipSandboxChannel Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getApnsVoipSandboxChannelResponse_httpStatus :: Lens' GetApnsVoipSandboxChannelResponse Int Source #

The response's http status code.

getApnsVoipSandboxChannelResponse_aPNSVoipSandboxChannelResponse :: Lens' GetApnsVoipSandboxChannelResponse APNSVoipSandboxChannelResponse Source #

Undocumented member.

GetSegmentVersions

getSegmentVersions_token :: Lens' GetSegmentVersions (Maybe Text) Source #

The NextToken string that specifies which page of results to return in a paginated response.

getSegmentVersions_pageSize :: Lens' GetSegmentVersions (Maybe Text) Source #

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

getSegmentVersions_segmentId :: Lens' GetSegmentVersions Text Source #

The unique identifier for the segment.

getSegmentVersions_applicationId :: Lens' GetSegmentVersions Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getSegmentVersionsResponse_httpStatus :: Lens' GetSegmentVersionsResponse Int Source #

The response's http status code.

getSegmentVersionsResponse_segmentsResponse :: Lens' GetSegmentVersionsResponse SegmentsResponse Source #

Undocumented member.

DeleteCampaign

deleteCampaign_campaignId :: Lens' DeleteCampaign Text Source #

The unique identifier for the campaign.

deleteCampaign_applicationId :: Lens' DeleteCampaign Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

deleteCampaignResponse_httpStatus :: Lens' DeleteCampaignResponse Int Source #

The response's http status code.

deleteCampaignResponse_campaignResponse :: Lens' DeleteCampaignResponse CampaignResponse Source #

Undocumented member.

UpdateCampaign

updateCampaign_campaignId :: Lens' UpdateCampaign Text Source #

The unique identifier for the campaign.

updateCampaign_applicationId :: Lens' UpdateCampaign Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

updateCampaign_writeCampaignRequest :: Lens' UpdateCampaign WriteCampaignRequest Source #

Undocumented member.

updateCampaignResponse_httpStatus :: Lens' UpdateCampaignResponse Int Source #

The response's http status code.

updateCampaignResponse_campaignResponse :: Lens' UpdateCampaignResponse CampaignResponse Source #

Undocumented member.

GetSegmentVersion

getSegmentVersion_segmentId :: Lens' GetSegmentVersion Text Source #

The unique identifier for the segment.

getSegmentVersion_version :: Lens' GetSegmentVersion Text Source #

The unique version number (Version property) for the campaign version.

getSegmentVersion_applicationId :: Lens' GetSegmentVersion Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getSegmentVersionResponse_httpStatus :: Lens' GetSegmentVersionResponse Int Source #

The response's http status code.

getSegmentVersionResponse_segmentResponse :: Lens' GetSegmentVersionResponse SegmentResponse Source #

Undocumented member.

DeletePushTemplate

deletePushTemplate_version :: Lens' DeletePushTemplate (Maybe Text) Source #

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.

deletePushTemplate_templateName :: Lens' DeletePushTemplate Text Source #

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

deletePushTemplateResponse_httpStatus :: Lens' DeletePushTemplateResponse Int Source #

The response's http status code.

deletePushTemplateResponse_messageBody :: Lens' DeletePushTemplateResponse MessageBody Source #

Undocumented member.

UpdatePushTemplate

updatePushTemplate_version :: Lens' UpdatePushTemplate (Maybe Text) Source #

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.

updatePushTemplate_createNewVersion :: Lens' UpdatePushTemplate (Maybe Bool) Source #

Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.

updatePushTemplate_templateName :: Lens' UpdatePushTemplate Text Source #

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

updatePushTemplate_pushNotificationTemplateRequest :: Lens' UpdatePushTemplate PushNotificationTemplateRequest Source #

Undocumented member.

updatePushTemplateResponse_httpStatus :: Lens' UpdatePushTemplateResponse Int Source #

The response's http status code.

updatePushTemplateResponse_messageBody :: Lens' UpdatePushTemplateResponse MessageBody Source #

Undocumented member.

CreateExportJob

createExportJob_applicationId :: Lens' CreateExportJob Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

createExportJob_exportJobRequest :: Lens' CreateExportJob ExportJobRequest Source #

Undocumented member.

createExportJobResponse_httpStatus :: Lens' CreateExportJobResponse Int Source #

The response's http status code.

createExportJobResponse_exportJobResponse :: Lens' CreateExportJobResponse ExportJobResponse Source #

Undocumented member.

CreateSegment

createSegment_applicationId :: Lens' CreateSegment Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

createSegment_writeSegmentRequest :: Lens' CreateSegment WriteSegmentRequest Source #

Undocumented member.

createSegmentResponse_httpStatus :: Lens' CreateSegmentResponse Int Source #

The response's http status code.

createSegmentResponse_segmentResponse :: Lens' CreateSegmentResponse SegmentResponse Source #

Undocumented member.

CreateRecommenderConfiguration

createRecommenderConfiguration'_createRecommenderConfiguration :: Lens' CreateRecommenderConfiguration' CreateRecommenderConfiguration Source #

Undocumented member.

createRecommenderConfigurationResponse_httpStatus :: Lens' CreateRecommenderConfigurationResponse Int Source #

The response's http status code.

createRecommenderConfigurationResponse_recommenderConfigurationResponse :: Lens' CreateRecommenderConfigurationResponse RecommenderConfigurationResponse Source #

Undocumented member.

CreateInAppTemplate

createInAppTemplate_templateName :: Lens' CreateInAppTemplate Text Source #

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

createInAppTemplate_inAppTemplateRequest :: Lens' CreateInAppTemplate InAppTemplateRequest Source #

Undocumented member.

createInAppTemplateResponse_httpStatus :: Lens' CreateInAppTemplateResponse Int Source #

The response's http status code.

createInAppTemplateResponse_templateCreateMessageBody :: Lens' CreateInAppTemplateResponse TemplateCreateMessageBody Source #

Undocumented member.

CreateVoiceTemplate

createVoiceTemplate_templateName :: Lens' CreateVoiceTemplate Text Source #

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

createVoiceTemplate_voiceTemplateRequest :: Lens' CreateVoiceTemplate VoiceTemplateRequest Source #

Undocumented member.

createVoiceTemplateResponse_httpStatus :: Lens' CreateVoiceTemplateResponse Int Source #

The response's http status code.

createVoiceTemplateResponse_createTemplateMessageBody :: Lens' CreateVoiceTemplateResponse CreateTemplateMessageBody Source #

Undocumented member.

UpdateAdmChannel

updateAdmChannel_applicationId :: Lens' UpdateAdmChannel Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

updateAdmChannel_aDMChannelRequest :: Lens' UpdateAdmChannel ADMChannelRequest Source #

Undocumented member.

updateAdmChannelResponse_httpStatus :: Lens' UpdateAdmChannelResponse Int Source #

The response's http status code.

updateAdmChannelResponse_aDMChannelResponse :: Lens' UpdateAdmChannelResponse ADMChannelResponse Source #

Undocumented member.

DeleteAdmChannel

deleteAdmChannel_applicationId :: Lens' DeleteAdmChannel Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

deleteAdmChannelResponse_httpStatus :: Lens' DeleteAdmChannelResponse Int Source #

The response's http status code.

deleteAdmChannelResponse_aDMChannelResponse :: Lens' DeleteAdmChannelResponse ADMChannelResponse Source #

Undocumented member.

DeleteRecommenderConfiguration

deleteRecommenderConfiguration_recommenderId :: Lens' DeleteRecommenderConfiguration Text Source #

The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint console.

deleteRecommenderConfigurationResponse_httpStatus :: Lens' DeleteRecommenderConfigurationResponse Int Source #

The response's http status code.

deleteRecommenderConfigurationResponse_recommenderConfigurationResponse :: Lens' DeleteRecommenderConfigurationResponse RecommenderConfigurationResponse Source #

Undocumented member.

UpdateRecommenderConfiguration

updateRecommenderConfiguration'_recommenderId :: Lens' UpdateRecommenderConfiguration' Text Source #

The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint console.

updateRecommenderConfiguration'_updateRecommenderConfiguration :: Lens' UpdateRecommenderConfiguration' UpdateRecommenderConfiguration Source #

Undocumented member.

updateRecommenderConfigurationResponse_httpStatus :: Lens' UpdateRecommenderConfigurationResponse Int Source #

The response's http status code.

updateRecommenderConfigurationResponse_recommenderConfigurationResponse :: Lens' UpdateRecommenderConfigurationResponse RecommenderConfigurationResponse Source #

Undocumented member.

CreatePushTemplate

createPushTemplate_templateName :: Lens' CreatePushTemplate Text Source #

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

createPushTemplate_pushNotificationTemplateRequest :: Lens' CreatePushTemplate PushNotificationTemplateRequest Source #

Undocumented member.

createPushTemplateResponse_httpStatus :: Lens' CreatePushTemplateResponse Int Source #

The response's http status code.

createPushTemplateResponse_createTemplateMessageBody :: Lens' CreatePushTemplateResponse CreateTemplateMessageBody Source #

Undocumented member.

DeleteEndpoint

deleteEndpoint_applicationId :: Lens' DeleteEndpoint Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

deleteEndpoint_endpointId :: Lens' DeleteEndpoint Text Source #

The unique identifier for the endpoint.

deleteEndpointResponse_httpStatus :: Lens' DeleteEndpointResponse Int Source #

The response's http status code.

deleteEndpointResponse_endpointResponse :: Lens' DeleteEndpointResponse EndpointResponse Source #

Undocumented member.

UpdateEndpoint

updateEndpoint_applicationId :: Lens' UpdateEndpoint Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

updateEndpoint_endpointId :: Lens' UpdateEndpoint Text Source #

The unique identifier for the endpoint.

updateEndpoint_endpointRequest :: Lens' UpdateEndpoint EndpointRequest Source #

Undocumented member.

updateEndpointResponse_httpStatus :: Lens' UpdateEndpointResponse Int Source #

The response's http status code.

updateEndpointResponse_messageBody :: Lens' UpdateEndpointResponse MessageBody Source #

Undocumented member.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the resource.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #

The response's http status code.

listTagsForResourceResponse_tagsModel :: Lens' ListTagsForResourceResponse TagsModel Source #

Undocumented member.

CreateCampaign

createCampaign_applicationId :: Lens' CreateCampaign Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

createCampaign_writeCampaignRequest :: Lens' CreateCampaign WriteCampaignRequest Source #

Undocumented member.

createCampaignResponse_httpStatus :: Lens' CreateCampaignResponse Int Source #

The response's http status code.

createCampaignResponse_campaignResponse :: Lens' CreateCampaignResponse CampaignResponse Source #

Undocumented member.

GetEmailTemplate

getEmailTemplate_version :: Lens' GetEmailTemplate (Maybe Text) Source #

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.

getEmailTemplate_templateName :: Lens' GetEmailTemplate Text Source #

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

getEmailTemplateResponse_httpStatus :: Lens' GetEmailTemplateResponse Int Source #

The response's http status code.

getEmailTemplateResponse_emailTemplateResponse :: Lens' GetEmailTemplateResponse EmailTemplateResponse Source #

Undocumented member.

GetExportJob

getExportJob_applicationId :: Lens' GetExportJob Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getExportJob_jobId :: Lens' GetExportJob Text Source #

The unique identifier for the job.

getExportJobResponse_httpStatus :: Lens' GetExportJobResponse Int Source #

The response's http status code.

getExportJobResponse_exportJobResponse :: Lens' GetExportJobResponse ExportJobResponse Source #

Undocumented member.

GetEndpoint

getEndpoint_applicationId :: Lens' GetEndpoint Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getEndpoint_endpointId :: Lens' GetEndpoint Text Source #

The unique identifier for the endpoint.

getEndpointResponse_httpStatus :: Lens' GetEndpointResponse Int Source #

The response's http status code.

getEndpointResponse_endpointResponse :: Lens' GetEndpointResponse EndpointResponse Source #

Undocumented member.

GetSegment

getSegment_segmentId :: Lens' GetSegment Text Source #

The unique identifier for the segment.

getSegment_applicationId :: Lens' GetSegment Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getSegmentResponse_httpStatus :: Lens' GetSegmentResponse Int Source #

The response's http status code.

getSegmentResponse_segmentResponse :: Lens' GetSegmentResponse SegmentResponse Source #

Undocumented member.

GetRecommenderConfiguration

getRecommenderConfiguration_recommenderId :: Lens' GetRecommenderConfiguration Text Source #

The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint console.

getRecommenderConfigurationResponse_httpStatus :: Lens' GetRecommenderConfigurationResponse Int Source #

The response's http status code.

getRecommenderConfigurationResponse_recommenderConfigurationResponse :: Lens' GetRecommenderConfigurationResponse RecommenderConfigurationResponse Source #

Undocumented member.

UpdateEndpointsBatch

updateEndpointsBatch_applicationId :: Lens' UpdateEndpointsBatch Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

updateEndpointsBatch_endpointBatchRequest :: Lens' UpdateEndpointsBatch EndpointBatchRequest Source #

Undocumented member.

updateEndpointsBatchResponse_httpStatus :: Lens' UpdateEndpointsBatchResponse Int Source #

The response's http status code.

updateEndpointsBatchResponse_messageBody :: Lens' UpdateEndpointsBatchResponse MessageBody Source #

Undocumented member.

GetAdmChannel

getAdmChannel_applicationId :: Lens' GetAdmChannel Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getAdmChannelResponse_httpStatus :: Lens' GetAdmChannelResponse Int Source #

The response's http status code.

getAdmChannelResponse_aDMChannelResponse :: Lens' GetAdmChannelResponse ADMChannelResponse Source #

Undocumented member.

GetCampaign

getCampaign_campaignId :: Lens' GetCampaign Text Source #

The unique identifier for the campaign.

getCampaign_applicationId :: Lens' GetCampaign Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getCampaignResponse_httpStatus :: Lens' GetCampaignResponse Int Source #

The response's http status code.

getCampaignResponse_campaignResponse :: Lens' GetCampaignResponse CampaignResponse Source #

Undocumented member.

GetVoiceTemplate

getVoiceTemplate_version :: Lens' GetVoiceTemplate (Maybe Text) Source #

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.

getVoiceTemplate_templateName :: Lens' GetVoiceTemplate Text Source #

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

getVoiceTemplateResponse_httpStatus :: Lens' GetVoiceTemplateResponse Int Source #

The response's http status code.

getVoiceTemplateResponse_voiceTemplateResponse :: Lens' GetVoiceTemplateResponse VoiceTemplateResponse Source #

Undocumented member.

GetInAppTemplate

getInAppTemplate_version :: Lens' GetInAppTemplate (Maybe Text) Source #

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.

getInAppTemplate_templateName :: Lens' GetInAppTemplate Text Source #

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

getInAppTemplateResponse_httpStatus :: Lens' GetInAppTemplateResponse Int Source #

The response's http status code.

getInAppTemplateResponse_inAppTemplateResponse :: Lens' GetInAppTemplateResponse InAppTemplateResponse Source #

Undocumented member.

GetPushTemplate

getPushTemplate_version :: Lens' GetPushTemplate (Maybe Text) Source #

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.

getPushTemplate_templateName :: Lens' GetPushTemplate Text Source #

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

getPushTemplateResponse_httpStatus :: Lens' GetPushTemplateResponse Int Source #

The response's http status code.

getPushTemplateResponse_pushNotificationTemplateResponse :: Lens' GetPushTemplateResponse PushNotificationTemplateResponse Source #

Undocumented member.

DeleteUserEndpoints

deleteUserEndpoints_applicationId :: Lens' DeleteUserEndpoints Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

deleteUserEndpoints_userId :: Lens' DeleteUserEndpoints Text Source #

The unique identifier for the user.

deleteUserEndpointsResponse_httpStatus :: Lens' DeleteUserEndpointsResponse Int Source #

The response's http status code.

deleteUserEndpointsResponse_endpointsResponse :: Lens' DeleteUserEndpointsResponse EndpointsResponse Source #

Undocumented member.

CreateEmailTemplate

createEmailTemplate_templateName :: Lens' CreateEmailTemplate Text Source #

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

createEmailTemplate_emailTemplateRequest :: Lens' CreateEmailTemplate EmailTemplateRequest Source #

Undocumented member.

createEmailTemplateResponse_httpStatus :: Lens' CreateEmailTemplateResponse Int Source #

The response's http status code.

createEmailTemplateResponse_createTemplateMessageBody :: Lens' CreateEmailTemplateResponse CreateTemplateMessageBody Source #

Undocumented member.

GetInAppMessages

getInAppMessages_applicationId :: Lens' GetInAppMessages Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getInAppMessages_endpointId :: Lens' GetInAppMessages Text Source #

The unique identifier for the endpoint.

getInAppMessagesResponse_httpStatus :: Lens' GetInAppMessagesResponse Int Source #

The response's http status code.

getInAppMessagesResponse_inAppMessagesResponse :: Lens' GetInAppMessagesResponse InAppMessagesResponse Source #

Undocumented member.

DeleteApp

deleteApp_applicationId :: Lens' DeleteApp Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

deleteAppResponse_httpStatus :: Lens' DeleteAppResponse Int Source #

The response's http status code.

deleteAppResponse_applicationResponse :: Lens' DeleteAppResponse ApplicationResponse Source #

Undocumented member.

UpdateApnsVoipSandboxChannel

updateApnsVoipSandboxChannel_applicationId :: Lens' UpdateApnsVoipSandboxChannel Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

updateApnsVoipSandboxChannel_aPNSVoipSandboxChannelRequest :: Lens' UpdateApnsVoipSandboxChannel APNSVoipSandboxChannelRequest Source #

Undocumented member.

updateApnsVoipSandboxChannelResponse_httpStatus :: Lens' UpdateApnsVoipSandboxChannelResponse Int Source #

The response's http status code.

updateApnsVoipSandboxChannelResponse_aPNSVoipSandboxChannelResponse :: Lens' UpdateApnsVoipSandboxChannelResponse APNSVoipSandboxChannelResponse Source #

Undocumented member.

DeleteApnsVoipSandboxChannel

deleteApnsVoipSandboxChannel_applicationId :: Lens' DeleteApnsVoipSandboxChannel Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

deleteApnsVoipSandboxChannelResponse_httpStatus :: Lens' DeleteApnsVoipSandboxChannelResponse Int Source #

The response's http status code.

deleteApnsVoipSandboxChannelResponse_aPNSVoipSandboxChannelResponse :: Lens' DeleteApnsVoipSandboxChannelResponse APNSVoipSandboxChannelResponse Source #

Undocumented member.

UpdateGcmChannel

updateGcmChannel_applicationId :: Lens' UpdateGcmChannel Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

updateGcmChannel_gCMChannelRequest :: Lens' UpdateGcmChannel GCMChannelRequest Source #

Undocumented member.

updateGcmChannelResponse_httpStatus :: Lens' UpdateGcmChannelResponse Int Source #

The response's http status code.

updateGcmChannelResponse_gCMChannelResponse :: Lens' UpdateGcmChannelResponse GCMChannelResponse Source #

Undocumented member.

DeleteGcmChannel

deleteGcmChannel_applicationId :: Lens' DeleteGcmChannel Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

deleteGcmChannelResponse_httpStatus :: Lens' DeleteGcmChannelResponse Int Source #

The response's http status code.

deleteGcmChannelResponse_gCMChannelResponse :: Lens' DeleteGcmChannelResponse GCMChannelResponse Source #

Undocumented member.

GetCampaignActivities

getCampaignActivities_token :: Lens' GetCampaignActivities (Maybe Text) Source #

The NextToken string that specifies which page of results to return in a paginated response.

getCampaignActivities_pageSize :: Lens' GetCampaignActivities (Maybe Text) Source #

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

getCampaignActivities_applicationId :: Lens' GetCampaignActivities Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getCampaignActivities_campaignId :: Lens' GetCampaignActivities Text Source #

The unique identifier for the campaign.

getCampaignActivitiesResponse_httpStatus :: Lens' GetCampaignActivitiesResponse Int Source #

The response's http status code.

getCampaignActivitiesResponse_activitiesResponse :: Lens' GetCampaignActivitiesResponse ActivitiesResponse Source #

Undocumented member.

GetJourneyExecutionMetrics

getJourneyExecutionMetrics_nextToken :: Lens' GetJourneyExecutionMetrics (Maybe Text) Source #

The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

getJourneyExecutionMetrics_pageSize :: Lens' GetJourneyExecutionMetrics (Maybe Text) Source #

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

getJourneyExecutionMetrics_applicationId :: Lens' GetJourneyExecutionMetrics Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getJourneyExecutionMetrics_journeyId :: Lens' GetJourneyExecutionMetrics Text Source #

The unique identifier for the journey.

getJourneyExecutionMetricsResponse_httpStatus :: Lens' GetJourneyExecutionMetricsResponse Int Source #

The response's http status code.

getJourneyExecutionMetricsResponse_journeyExecutionMetricsResponse :: Lens' GetJourneyExecutionMetricsResponse JourneyExecutionMetricsResponse Source #

Undocumented member.

UpdateJourneyState

updateJourneyState_journeyId :: Lens' UpdateJourneyState Text Source #

The unique identifier for the journey.

updateJourneyState_applicationId :: Lens' UpdateJourneyState Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

updateJourneyState_journeyStateRequest :: Lens' UpdateJourneyState JourneyStateRequest Source #

Undocumented member.

updateJourneyStateResponse_httpStatus :: Lens' UpdateJourneyStateResponse Int Source #

The response's http status code.

updateJourneyStateResponse_journeyResponse :: Lens' UpdateJourneyStateResponse JourneyResponse Source #

Undocumented member.

GetEventStream

getEventStream_applicationId :: Lens' GetEventStream Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getEventStreamResponse_httpStatus :: Lens' GetEventStreamResponse Int Source #

The response's http status code.

getEventStreamResponse_eventStream :: Lens' GetEventStreamResponse EventStream Source #

Undocumented member.

GetChannels

getChannels_applicationId :: Lens' GetChannels Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getChannelsResponse_httpStatus :: Lens' GetChannelsResponse Int Source #

The response's http status code.

getChannelsResponse_channelsResponse :: Lens' GetChannelsResponse ChannelsResponse Source #

Undocumented member.

GetJourney

getJourney_journeyId :: Lens' GetJourney Text Source #

The unique identifier for the journey.

getJourney_applicationId :: Lens' GetJourney Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getJourneyResponse_httpStatus :: Lens' GetJourneyResponse Int Source #

The response's http status code.

getJourneyResponse_journeyResponse :: Lens' GetJourneyResponse JourneyResponse Source #

Undocumented member.

DeleteEmailChannel

deleteEmailChannel_applicationId :: Lens' DeleteEmailChannel Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

deleteEmailChannelResponse_httpStatus :: Lens' DeleteEmailChannelResponse Int Source #

The response's http status code.

deleteEmailChannelResponse_emailChannelResponse :: Lens' DeleteEmailChannelResponse EmailChannelResponse Source #

Undocumented member.

UpdateEmailChannel

updateEmailChannel_applicationId :: Lens' UpdateEmailChannel Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

updateEmailChannel_emailChannelRequest :: Lens' UpdateEmailChannel EmailChannelRequest Source #

Undocumented member.

updateEmailChannelResponse_httpStatus :: Lens' UpdateEmailChannelResponse Int Source #

The response's http status code.

updateEmailChannelResponse_emailChannelResponse :: Lens' UpdateEmailChannelResponse EmailChannelResponse Source #

Undocumented member.

GetBaiduChannel

getBaiduChannel_applicationId :: Lens' GetBaiduChannel Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getBaiduChannelResponse_httpStatus :: Lens' GetBaiduChannelResponse Int Source #

The response's http status code.

getBaiduChannelResponse_baiduChannelResponse :: Lens' GetBaiduChannelResponse BaiduChannelResponse Source #

Undocumented member.

DeleteApnsChannel

deleteApnsChannel_applicationId :: Lens' DeleteApnsChannel Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

deleteApnsChannelResponse_httpStatus :: Lens' DeleteApnsChannelResponse Int Source #

The response's http status code.

deleteApnsChannelResponse_aPNSChannelResponse :: Lens' DeleteApnsChannelResponse APNSChannelResponse Source #

Undocumented member.

UpdateApnsChannel

updateApnsChannel_applicationId :: Lens' UpdateApnsChannel Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

updateApnsChannel_aPNSChannelRequest :: Lens' UpdateApnsChannel APNSChannelRequest Source #

Undocumented member.

updateApnsChannelResponse_httpStatus :: Lens' UpdateApnsChannelResponse Int Source #

The response's http status code.

updateApnsChannelResponse_aPNSChannelResponse :: Lens' UpdateApnsChannelResponse APNSChannelResponse Source #

Undocumented member.

RemoveAttributes

removeAttributes_attributeType :: Lens' RemoveAttributes Text Source #

The type of attribute or attributes to remove. Valid values are:

endpoint-custom-attributes - Custom attributes that describe endpoints, such as the date when an associated user opted in or out of receiving communications from you through a specific type of channel.
endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints, such as the number of app sessions or the number of items left in a cart.
endpoint-user-attributes - Custom attributes that describe users, such as first name, last name, and age.

removeAttributes_applicationId :: Lens' RemoveAttributes Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

removeAttributes_updateAttributesRequest :: Lens' RemoveAttributes UpdateAttributesRequest Source #

Undocumented member.

removeAttributesResponse_httpStatus :: Lens' RemoveAttributesResponse Int Source #

The response's http status code.

removeAttributesResponse_attributesResource :: Lens' RemoveAttributesResponse AttributesResource Source #

Undocumented member.

ListTemplates

listTemplates_templateType :: Lens' ListTemplates (Maybe Text) Source #

The type of message template to include in the results. Valid values are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, don't include this parameter in your request.

listTemplates_prefix :: Lens' ListTemplates (Maybe Text) Source #

The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify.

listTemplates_nextToken :: Lens' ListTemplates (Maybe Text) Source #

The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

listTemplates_pageSize :: Lens' ListTemplates (Maybe Text) Source #

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

listTemplatesResponse_httpStatus :: Lens' ListTemplatesResponse Int Source #

The response's http status code.

listTemplatesResponse_templatesResponse :: Lens' ListTemplatesResponse TemplatesResponse Source #

Undocumented member.

PutEventStream

putEventStream_applicationId :: Lens' PutEventStream Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

putEventStream_writeEventStream :: Lens' PutEventStream WriteEventStream Source #

Undocumented member.

putEventStreamResponse_httpStatus :: Lens' PutEventStreamResponse Int Source #

The response's http status code.

putEventStreamResponse_eventStream :: Lens' PutEventStreamResponse EventStream Source #

Undocumented member.

DeleteEventStream

deleteEventStream_applicationId :: Lens' DeleteEventStream Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

deleteEventStreamResponse_httpStatus :: Lens' DeleteEventStreamResponse Int Source #

The response's http status code.

deleteEventStreamResponse_eventStream :: Lens' DeleteEventStreamResponse EventStream Source #

Undocumented member.

GetCampaignVersions

getCampaignVersions_token :: Lens' GetCampaignVersions (Maybe Text) Source #

The NextToken string that specifies which page of results to return in a paginated response.

getCampaignVersions_pageSize :: Lens' GetCampaignVersions (Maybe Text) Source #

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

getCampaignVersions_applicationId :: Lens' GetCampaignVersions Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getCampaignVersions_campaignId :: Lens' GetCampaignVersions Text Source #

The unique identifier for the campaign.

getCampaignVersionsResponse_httpStatus :: Lens' GetCampaignVersionsResponse Int Source #

The response's http status code.

getCampaignVersionsResponse_campaignsResponse :: Lens' GetCampaignVersionsResponse CampaignsResponse Source #

Undocumented member.

DeleteJourney

deleteJourney_journeyId :: Lens' DeleteJourney Text Source #

The unique identifier for the journey.

deleteJourney_applicationId :: Lens' DeleteJourney Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

deleteJourneyResponse_httpStatus :: Lens' DeleteJourneyResponse Int Source #

The response's http status code.

deleteJourneyResponse_journeyResponse :: Lens' DeleteJourneyResponse JourneyResponse Source #

Undocumented member.

UpdateJourney

updateJourney_journeyId :: Lens' UpdateJourney Text Source #

The unique identifier for the journey.

updateJourney_applicationId :: Lens' UpdateJourney Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

updateJourney_writeJourneyRequest :: Lens' UpdateJourney WriteJourneyRequest Source #

Undocumented member.

updateJourneyResponse_httpStatus :: Lens' UpdateJourneyResponse Int Source #

The response's http status code.

updateJourneyResponse_journeyResponse :: Lens' UpdateJourneyResponse JourneyResponse Source #

Undocumented member.

GetCampaignDateRangeKpi

getCampaignDateRangeKpi_startTime :: Lens' GetCampaignDateRangeKpi (Maybe UTCTime) Source #

The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.

getCampaignDateRangeKpi_nextToken :: Lens' GetCampaignDateRangeKpi (Maybe Text) Source #

The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

getCampaignDateRangeKpi_endTime :: Lens' GetCampaignDateRangeKpi (Maybe UTCTime) Source #

The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.

getCampaignDateRangeKpi_pageSize :: Lens' GetCampaignDateRangeKpi (Maybe Text) Source #

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

getCampaignDateRangeKpi_applicationId :: Lens' GetCampaignDateRangeKpi Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getCampaignDateRangeKpi_kpiName :: Lens' GetCampaignDateRangeKpi Text Source #

The name of the metric, also referred to as a /key performance indicator (KPI)/, to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

getCampaignDateRangeKpi_campaignId :: Lens' GetCampaignDateRangeKpi Text Source #

The unique identifier for the campaign.

getCampaignDateRangeKpiResponse_httpStatus :: Lens' GetCampaignDateRangeKpiResponse Int Source #

The response's http status code.

getCampaignDateRangeKpiResponse_campaignDateRangeKpiResponse :: Lens' GetCampaignDateRangeKpiResponse CampaignDateRangeKpiResponse Source #

Undocumented member.

GetApnsChannel

getApnsChannel_applicationId :: Lens' GetApnsChannel Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getApnsChannelResponse_httpStatus :: Lens' GetApnsChannelResponse Int Source #

The response's http status code.

getApnsChannelResponse_aPNSChannelResponse :: Lens' GetApnsChannelResponse APNSChannelResponse Source #

Undocumented member.

UpdateVoiceChannel

updateVoiceChannel_applicationId :: Lens' UpdateVoiceChannel Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

updateVoiceChannel_voiceChannelRequest :: Lens' UpdateVoiceChannel VoiceChannelRequest Source #

Undocumented member.

updateVoiceChannelResponse_httpStatus :: Lens' UpdateVoiceChannelResponse Int Source #

The response's http status code.

updateVoiceChannelResponse_voiceChannelResponse :: Lens' UpdateVoiceChannelResponse VoiceChannelResponse Source #

Undocumented member.

DeleteVoiceChannel

deleteVoiceChannel_applicationId :: Lens' DeleteVoiceChannel Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

deleteVoiceChannelResponse_httpStatus :: Lens' DeleteVoiceChannelResponse Int Source #

The response's http status code.

deleteVoiceChannelResponse_voiceChannelResponse :: Lens' DeleteVoiceChannelResponse VoiceChannelResponse Source #

Undocumented member.

GetApps

getApps_token :: Lens' GetApps (Maybe Text) Source #

The NextToken string that specifies which page of results to return in a paginated response.

getApps_pageSize :: Lens' GetApps (Maybe Text) Source #

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

getAppsResponse_httpStatus :: Lens' GetAppsResponse Int Source #

The response's http status code.

getAppsResponse_applicationsResponse :: Lens' GetAppsResponse ApplicationsResponse Source #

Undocumented member.

GetApnsSandboxChannel

getApnsSandboxChannel_applicationId :: Lens' GetApnsSandboxChannel Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getApnsSandboxChannelResponse_httpStatus :: Lens' GetApnsSandboxChannelResponse Int Source #

The response's http status code.

getApnsSandboxChannelResponse_aPNSSandboxChannelResponse :: Lens' GetApnsSandboxChannelResponse APNSSandboxChannelResponse Source #

Undocumented member.

CreateJourney

createJourney_applicationId :: Lens' CreateJourney Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

createJourney_writeJourneyRequest :: Lens' CreateJourney WriteJourneyRequest Source #

Undocumented member.

createJourneyResponse_httpStatus :: Lens' CreateJourneyResponse Int Source #

The response's http status code.

createJourneyResponse_journeyResponse :: Lens' CreateJourneyResponse JourneyResponse Source #

Undocumented member.

GetUserEndpoints

getUserEndpoints_applicationId :: Lens' GetUserEndpoints Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getUserEndpoints_userId :: Lens' GetUserEndpoints Text Source #

The unique identifier for the user.

getUserEndpointsResponse_httpStatus :: Lens' GetUserEndpointsResponse Int Source #

The response's http status code.

getUserEndpointsResponse_endpointsResponse :: Lens' GetUserEndpointsResponse EndpointsResponse Source #

Undocumented member.

DeleteVoiceTemplate

deleteVoiceTemplate_version :: Lens' DeleteVoiceTemplate (Maybe Text) Source #

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.

deleteVoiceTemplate_templateName :: Lens' DeleteVoiceTemplate Text Source #

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

deleteVoiceTemplateResponse_httpStatus :: Lens' DeleteVoiceTemplateResponse Int Source #

The response's http status code.

deleteVoiceTemplateResponse_messageBody :: Lens' DeleteVoiceTemplateResponse MessageBody Source #

Undocumented member.

UpdateVoiceTemplate

updateVoiceTemplate_version :: Lens' UpdateVoiceTemplate (Maybe Text) Source #

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.

updateVoiceTemplate_createNewVersion :: Lens' UpdateVoiceTemplate (Maybe Bool) Source #

Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.

updateVoiceTemplate_templateName :: Lens' UpdateVoiceTemplate Text Source #

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

updateVoiceTemplate_voiceTemplateRequest :: Lens' UpdateVoiceTemplate VoiceTemplateRequest Source #

Undocumented member.

updateVoiceTemplateResponse_httpStatus :: Lens' UpdateVoiceTemplateResponse Int Source #

The response's http status code.

updateVoiceTemplateResponse_messageBody :: Lens' UpdateVoiceTemplateResponse MessageBody Source #

Undocumented member.

DeleteInAppTemplate

deleteInAppTemplate_version :: Lens' DeleteInAppTemplate (Maybe Text) Source #

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.

deleteInAppTemplate_templateName :: Lens' DeleteInAppTemplate Text Source #

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

deleteInAppTemplateResponse_httpStatus :: Lens' DeleteInAppTemplateResponse Int Source #

The response's http status code.

deleteInAppTemplateResponse_messageBody :: Lens' DeleteInAppTemplateResponse MessageBody Source #

Undocumented member.

UpdateInAppTemplate

updateInAppTemplate_version :: Lens' UpdateInAppTemplate (Maybe Text) Source #

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.

updateInAppTemplate_createNewVersion :: Lens' UpdateInAppTemplate (Maybe Bool) Source #

Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.

updateInAppTemplate_templateName :: Lens' UpdateInAppTemplate Text Source #

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

updateInAppTemplate_inAppTemplateRequest :: Lens' UpdateInAppTemplate InAppTemplateRequest Source #

Undocumented member.

updateInAppTemplateResponse_httpStatus :: Lens' UpdateInAppTemplateResponse Int Source #

The response's http status code.

updateInAppTemplateResponse_messageBody :: Lens' UpdateInAppTemplateResponse MessageBody Source #

Undocumented member.

GetImportJobs

getImportJobs_token :: Lens' GetImportJobs (Maybe Text) Source #

The NextToken string that specifies which page of results to return in a paginated response.

getImportJobs_pageSize :: Lens' GetImportJobs (Maybe Text) Source #

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

getImportJobs_applicationId :: Lens' GetImportJobs Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getImportJobsResponse_httpStatus :: Lens' GetImportJobsResponse Int Source #

The response's http status code.

getImportJobsResponse_importJobsResponse :: Lens' GetImportJobsResponse ImportJobsResponse Source #

Undocumented member.

GetJourneyDateRangeKpi

getJourneyDateRangeKpi_startTime :: Lens' GetJourneyDateRangeKpi (Maybe UTCTime) Source #

The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.

getJourneyDateRangeKpi_nextToken :: Lens' GetJourneyDateRangeKpi (Maybe Text) Source #

The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

getJourneyDateRangeKpi_endTime :: Lens' GetJourneyDateRangeKpi (Maybe UTCTime) Source #

The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.

getJourneyDateRangeKpi_pageSize :: Lens' GetJourneyDateRangeKpi (Maybe Text) Source #

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

getJourneyDateRangeKpi_journeyId :: Lens' GetJourneyDateRangeKpi Text Source #

The unique identifier for the journey.

getJourneyDateRangeKpi_applicationId :: Lens' GetJourneyDateRangeKpi Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getJourneyDateRangeKpi_kpiName :: Lens' GetJourneyDateRangeKpi Text Source #

The name of the metric, also referred to as a /key performance indicator (KPI)/, to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

getJourneyDateRangeKpiResponse_httpStatus :: Lens' GetJourneyDateRangeKpiResponse Int Source #

The response's http status code.

getJourneyDateRangeKpiResponse_journeyDateRangeKpiResponse :: Lens' GetJourneyDateRangeKpiResponse JourneyDateRangeKpiResponse Source #

Undocumented member.

UpdateTemplateActiveVersion

updateTemplateActiveVersion_templateName :: Lens' UpdateTemplateActiveVersion Text Source #

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

updateTemplateActiveVersion_templateType :: Lens' UpdateTemplateActiveVersion Text Source #

The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.

updateTemplateActiveVersion_templateActiveVersionRequest :: Lens' UpdateTemplateActiveVersion TemplateActiveVersionRequest Source #

Undocumented member.

updateTemplateActiveVersionResponse_httpStatus :: Lens' UpdateTemplateActiveVersionResponse Int Source #

The response's http status code.

updateTemplateActiveVersionResponse_messageBody :: Lens' UpdateTemplateActiveVersionResponse MessageBody Source #

Undocumented member.

DeleteSmsChannel

deleteSmsChannel_applicationId :: Lens' DeleteSmsChannel Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

deleteSmsChannelResponse_httpStatus :: Lens' DeleteSmsChannelResponse Int Source #

The response's http status code.

deleteSmsChannelResponse_sMSChannelResponse :: Lens' DeleteSmsChannelResponse SMSChannelResponse Source #

Undocumented member.

UpdateSmsChannel

updateSmsChannel_applicationId :: Lens' UpdateSmsChannel Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

updateSmsChannel_sMSChannelRequest :: Lens' UpdateSmsChannel SMSChannelRequest Source #

Undocumented member.

updateSmsChannelResponse_httpStatus :: Lens' UpdateSmsChannelResponse Int Source #

The response's http status code.

updateSmsChannelResponse_sMSChannelResponse :: Lens' UpdateSmsChannelResponse SMSChannelResponse Source #

Undocumented member.

GetApp

getApp_applicationId :: Lens' GetApp Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getAppResponse_httpStatus :: Lens' GetAppResponse Int Source #

The response's http status code.

getAppResponse_applicationResponse :: Lens' GetAppResponse ApplicationResponse Source #

Undocumented member.

GetCampaignVersion

getCampaignVersion_version :: Lens' GetCampaignVersion Text Source #

The unique version number (Version property) for the campaign version.

getCampaignVersion_applicationId :: Lens' GetCampaignVersion Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getCampaignVersion_campaignId :: Lens' GetCampaignVersion Text Source #

The unique identifier for the campaign.

getCampaignVersionResponse_httpStatus :: Lens' GetCampaignVersionResponse Int Source #

The response's http status code.

getCampaignVersionResponse_campaignResponse :: Lens' GetCampaignVersionResponse CampaignResponse Source #

Undocumented member.

DeleteSegment

deleteSegment_segmentId :: Lens' DeleteSegment Text Source #

The unique identifier for the segment.

deleteSegment_applicationId :: Lens' DeleteSegment Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

deleteSegmentResponse_httpStatus :: Lens' DeleteSegmentResponse Int Source #

The response's http status code.

deleteSegmentResponse_segmentResponse :: Lens' DeleteSegmentResponse SegmentResponse Source #

Undocumented member.

UpdateSegment

updateSegment_segmentId :: Lens' UpdateSegment Text Source #

The unique identifier for the segment.

updateSegment_applicationId :: Lens' UpdateSegment Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

updateSegment_writeSegmentRequest :: Lens' UpdateSegment WriteSegmentRequest Source #

Undocumented member.

updateSegmentResponse_httpStatus :: Lens' UpdateSegmentResponse Int Source #

The response's http status code.

updateSegmentResponse_segmentResponse :: Lens' UpdateSegmentResponse SegmentResponse Source #

Undocumented member.

GetApplicationDateRangeKpi

getApplicationDateRangeKpi_startTime :: Lens' GetApplicationDateRangeKpi (Maybe UTCTime) Source #

The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.

getApplicationDateRangeKpi_nextToken :: Lens' GetApplicationDateRangeKpi (Maybe Text) Source #

The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

getApplicationDateRangeKpi_endTime :: Lens' GetApplicationDateRangeKpi (Maybe UTCTime) Source #

The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.

getApplicationDateRangeKpi_pageSize :: Lens' GetApplicationDateRangeKpi (Maybe Text) Source #

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

getApplicationDateRangeKpi_applicationId :: Lens' GetApplicationDateRangeKpi Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getApplicationDateRangeKpi_kpiName :: Lens' GetApplicationDateRangeKpi Text Source #

The name of the metric, also referred to as a /key performance indicator (KPI)/, to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

getApplicationDateRangeKpiResponse_httpStatus :: Lens' GetApplicationDateRangeKpiResponse Int Source #

The response's http status code.

getApplicationDateRangeKpiResponse_applicationDateRangeKpiResponse :: Lens' GetApplicationDateRangeKpiResponse ApplicationDateRangeKpiResponse Source #

Undocumented member.

CreateApp

createApp_createApplicationRequest :: Lens' CreateApp CreateApplicationRequest Source #

Undocumented member.

createAppResponse_httpStatus :: Lens' CreateAppResponse Int Source #

The response's http status code.

createAppResponse_applicationResponse :: Lens' CreateAppResponse ApplicationResponse Source #

Undocumented member.

GetSegmentExportJobs

getSegmentExportJobs_token :: Lens' GetSegmentExportJobs (Maybe Text) Source #

The NextToken string that specifies which page of results to return in a paginated response.

getSegmentExportJobs_pageSize :: Lens' GetSegmentExportJobs (Maybe Text) Source #

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

getSegmentExportJobs_segmentId :: Lens' GetSegmentExportJobs Text Source #

The unique identifier for the segment.

getSegmentExportJobs_applicationId :: Lens' GetSegmentExportJobs Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getSegmentExportJobsResponse_httpStatus :: Lens' GetSegmentExportJobsResponse Int Source #

The response's http status code.

getSegmentExportJobsResponse_exportJobsResponse :: Lens' GetSegmentExportJobsResponse ExportJobsResponse Source #

Undocumented member.

DeleteEmailTemplate

deleteEmailTemplate_version :: Lens' DeleteEmailTemplate (Maybe Text) Source #

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.

deleteEmailTemplate_templateName :: Lens' DeleteEmailTemplate Text Source #

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

deleteEmailTemplateResponse_httpStatus :: Lens' DeleteEmailTemplateResponse Int Source #

The response's http status code.

deleteEmailTemplateResponse_messageBody :: Lens' DeleteEmailTemplateResponse MessageBody Source #

Undocumented member.

UpdateEmailTemplate

updateEmailTemplate_version :: Lens' UpdateEmailTemplate (Maybe Text) Source #

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.

updateEmailTemplate_createNewVersion :: Lens' UpdateEmailTemplate (Maybe Bool) Source #

Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.

updateEmailTemplate_templateName :: Lens' UpdateEmailTemplate Text Source #

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

updateEmailTemplate_emailTemplateRequest :: Lens' UpdateEmailTemplate EmailTemplateRequest Source #

Undocumented member.

updateEmailTemplateResponse_httpStatus :: Lens' UpdateEmailTemplateResponse Int Source #

The response's http status code.

updateEmailTemplateResponse_messageBody :: Lens' UpdateEmailTemplateResponse MessageBody Source #

Undocumented member.

GetSmsChannel

getSmsChannel_applicationId :: Lens' GetSmsChannel Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getSmsChannelResponse_httpStatus :: Lens' GetSmsChannelResponse Int Source #

The response's http status code.

getSmsChannelResponse_sMSChannelResponse :: Lens' GetSmsChannelResponse SMSChannelResponse Source #

Undocumented member.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the resource.

tagResource_tagsModel :: Lens' TagResource TagsModel Source #

Undocumented member.

DeleteApnsSandboxChannel

deleteApnsSandboxChannel_applicationId :: Lens' DeleteApnsSandboxChannel Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

deleteApnsSandboxChannelResponse_httpStatus :: Lens' DeleteApnsSandboxChannelResponse Int Source #

The response's http status code.

deleteApnsSandboxChannelResponse_aPNSSandboxChannelResponse :: Lens' DeleteApnsSandboxChannelResponse APNSSandboxChannelResponse Source #

Undocumented member.

UpdateApnsSandboxChannel

updateApnsSandboxChannel_applicationId :: Lens' UpdateApnsSandboxChannel Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

updateApnsSandboxChannel_aPNSSandboxChannelRequest :: Lens' UpdateApnsSandboxChannel APNSSandboxChannelRequest Source #

Undocumented member.

updateApnsSandboxChannelResponse_httpStatus :: Lens' UpdateApnsSandboxChannelResponse Int Source #

The response's http status code.

updateApnsSandboxChannelResponse_aPNSSandboxChannelResponse :: Lens' UpdateApnsSandboxChannelResponse APNSSandboxChannelResponse Source #

Undocumented member.

GetCampaigns

getCampaigns_token :: Lens' GetCampaigns (Maybe Text) Source #

The NextToken string that specifies which page of results to return in a paginated response.

getCampaigns_pageSize :: Lens' GetCampaigns (Maybe Text) Source #

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

getCampaigns_applicationId :: Lens' GetCampaigns Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getCampaignsResponse_httpStatus :: Lens' GetCampaignsResponse Int Source #

The response's http status code.

getCampaignsResponse_campaignsResponse :: Lens' GetCampaignsResponse CampaignsResponse Source #

Undocumented member.

GetVoiceChannel

getVoiceChannel_applicationId :: Lens' GetVoiceChannel Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getVoiceChannelResponse_httpStatus :: Lens' GetVoiceChannelResponse Int Source #

The response's http status code.

getVoiceChannelResponse_voiceChannelResponse :: Lens' GetVoiceChannelResponse VoiceChannelResponse Source #

Undocumented member.

UntagResource

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

The key of the tag to remove from the resource. To remove multiple tags, append the tagKeys parameter and argument for each additional tag to remove, separated by an ampersand (&).

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the resource.

ListTemplateVersions

listTemplateVersions_nextToken :: Lens' ListTemplateVersions (Maybe Text) Source #

The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

listTemplateVersions_pageSize :: Lens' ListTemplateVersions (Maybe Text) Source #

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

listTemplateVersions_templateName :: Lens' ListTemplateVersions Text Source #

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

listTemplateVersions_templateType :: Lens' ListTemplateVersions Text Source #

The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.

listTemplateVersionsResponse_httpStatus :: Lens' ListTemplateVersionsResponse Int Source #

The response's http status code.

listTemplateVersionsResponse_templateVersionsResponse :: Lens' ListTemplateVersionsResponse TemplateVersionsResponse Source #

Undocumented member.

GetSmsTemplate

getSmsTemplate_version :: Lens' GetSmsTemplate (Maybe Text) Source #

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.

getSmsTemplate_templateName :: Lens' GetSmsTemplate Text Source #

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

getSmsTemplateResponse_httpStatus :: Lens' GetSmsTemplateResponse Int Source #

The response's http status code.

getSmsTemplateResponse_sMSTemplateResponse :: Lens' GetSmsTemplateResponse SMSTemplateResponse Source #

Undocumented member.

PutEvents

putEvents_applicationId :: Lens' PutEvents Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

putEvents_eventsRequest :: Lens' PutEvents EventsRequest Source #

Undocumented member.

putEventsResponse_httpStatus :: Lens' PutEventsResponse Int Source #

The response's http status code.

putEventsResponse_eventsResponse :: Lens' PutEventsResponse EventsResponse Source #

Undocumented member.

UpdateApplicationSettings

updateApplicationSettings_applicationId :: Lens' UpdateApplicationSettings Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

updateApplicationSettings_writeApplicationSettingsRequest :: Lens' UpdateApplicationSettings WriteApplicationSettingsRequest Source #

Undocumented member.

updateApplicationSettingsResponse_httpStatus :: Lens' UpdateApplicationSettingsResponse Int Source #

The response's http status code.

updateApplicationSettingsResponse_applicationSettingsResource :: Lens' UpdateApplicationSettingsResponse ApplicationSettingsResource Source #

Undocumented member.

GetJourneyExecutionActivityMetrics

getJourneyExecutionActivityMetrics_nextToken :: Lens' GetJourneyExecutionActivityMetrics (Maybe Text) Source #

The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

getJourneyExecutionActivityMetrics_pageSize :: Lens' GetJourneyExecutionActivityMetrics (Maybe Text) Source #

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

getJourneyExecutionActivityMetrics_journeyActivityId :: Lens' GetJourneyExecutionActivityMetrics Text Source #

The unique identifier for the journey activity.

getJourneyExecutionActivityMetrics_applicationId :: Lens' GetJourneyExecutionActivityMetrics Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getJourneyExecutionActivityMetrics_journeyId :: Lens' GetJourneyExecutionActivityMetrics Text Source #

The unique identifier for the journey.

getJourneyExecutionActivityMetricsResponse_httpStatus :: Lens' GetJourneyExecutionActivityMetricsResponse Int Source #

The response's http status code.

getJourneyExecutionActivityMetricsResponse_journeyExecutionActivityMetricsResponse :: Lens' GetJourneyExecutionActivityMetricsResponse JourneyExecutionActivityMetricsResponse Source #

Undocumented member.

GetSegments

getSegments_token :: Lens' GetSegments (Maybe Text) Source #

The NextToken string that specifies which page of results to return in a paginated response.

getSegments_pageSize :: Lens' GetSegments (Maybe Text) Source #

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

getSegments_applicationId :: Lens' GetSegments Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getSegmentsResponse_httpStatus :: Lens' GetSegmentsResponse Int Source #

The response's http status code.

getSegmentsResponse_segmentsResponse :: Lens' GetSegmentsResponse SegmentsResponse Source #

Undocumented member.

GetExportJobs

getExportJobs_token :: Lens' GetExportJobs (Maybe Text) Source #

The NextToken string that specifies which page of results to return in a paginated response.

getExportJobs_pageSize :: Lens' GetExportJobs (Maybe Text) Source #

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

getExportJobs_applicationId :: Lens' GetExportJobs Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getExportJobsResponse_httpStatus :: Lens' GetExportJobsResponse Int Source #

The response's http status code.

getExportJobsResponse_exportJobsResponse :: Lens' GetExportJobsResponse ExportJobsResponse Source #

Undocumented member.

CreateImportJob

createImportJob_applicationId :: Lens' CreateImportJob Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

createImportJob_importJobRequest :: Lens' CreateImportJob ImportJobRequest Source #

Undocumented member.

createImportJobResponse_httpStatus :: Lens' CreateImportJobResponse Int Source #

The response's http status code.

createImportJobResponse_importJobResponse :: Lens' CreateImportJobResponse ImportJobResponse Source #

Undocumented member.

GetRecommenderConfigurations

getRecommenderConfigurations_token :: Lens' GetRecommenderConfigurations (Maybe Text) Source #

The NextToken string that specifies which page of results to return in a paginated response.

getRecommenderConfigurations_pageSize :: Lens' GetRecommenderConfigurations (Maybe Text) Source #

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

getRecommenderConfigurationsResponse_httpStatus :: Lens' GetRecommenderConfigurationsResponse Int Source #

The response's http status code.

getRecommenderConfigurationsResponse_listRecommenderConfigurationsResponse :: Lens' GetRecommenderConfigurationsResponse ListRecommenderConfigurationsResponse Source #

Undocumented member.

DeleteApnsVoipChannel

deleteApnsVoipChannel_applicationId :: Lens' DeleteApnsVoipChannel Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

deleteApnsVoipChannelResponse_httpStatus :: Lens' DeleteApnsVoipChannelResponse Int Source #

The response's http status code.

deleteApnsVoipChannelResponse_aPNSVoipChannelResponse :: Lens' DeleteApnsVoipChannelResponse APNSVoipChannelResponse Source #

Undocumented member.

UpdateApnsVoipChannel

updateApnsVoipChannel_applicationId :: Lens' UpdateApnsVoipChannel Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

updateApnsVoipChannel_aPNSVoipChannelRequest :: Lens' UpdateApnsVoipChannel APNSVoipChannelRequest Source #

Undocumented member.

updateApnsVoipChannelResponse_httpStatus :: Lens' UpdateApnsVoipChannelResponse Int Source #

The response's http status code.

updateApnsVoipChannelResponse_aPNSVoipChannelResponse :: Lens' UpdateApnsVoipChannelResponse APNSVoipChannelResponse Source #

Undocumented member.

SendUsersMessages

sendUsersMessages_applicationId :: Lens' SendUsersMessages Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

sendUsersMessages_sendUsersMessageRequest :: Lens' SendUsersMessages SendUsersMessageRequest Source #

Undocumented member.

sendUsersMessagesResponse_httpStatus :: Lens' SendUsersMessagesResponse Int Source #

The response's http status code.

sendUsersMessagesResponse_sendUsersMessageResponse :: Lens' SendUsersMessagesResponse SendUsersMessageResponse Source #

Undocumented member.

GetApplicationSettings

getApplicationSettings_applicationId :: Lens' GetApplicationSettings Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getApplicationSettingsResponse_httpStatus :: Lens' GetApplicationSettingsResponse Int Source #

The response's http status code.

getApplicationSettingsResponse_applicationSettingsResource :: Lens' GetApplicationSettingsResponse ApplicationSettingsResource Source #

Undocumented member.

DeleteBaiduChannel

deleteBaiduChannel_applicationId :: Lens' DeleteBaiduChannel Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

deleteBaiduChannelResponse_httpStatus :: Lens' DeleteBaiduChannelResponse Int Source #

The response's http status code.

deleteBaiduChannelResponse_baiduChannelResponse :: Lens' DeleteBaiduChannelResponse BaiduChannelResponse Source #

Undocumented member.

UpdateBaiduChannel

updateBaiduChannel_applicationId :: Lens' UpdateBaiduChannel Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

updateBaiduChannel_baiduChannelRequest :: Lens' UpdateBaiduChannel BaiduChannelRequest Source #

Undocumented member.

updateBaiduChannelResponse_httpStatus :: Lens' UpdateBaiduChannelResponse Int Source #

The response's http status code.

updateBaiduChannelResponse_baiduChannelResponse :: Lens' UpdateBaiduChannelResponse BaiduChannelResponse Source #

Undocumented member.

CreateSmsTemplate

createSmsTemplate_templateName :: Lens' CreateSmsTemplate Text Source #

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

createSmsTemplate_sMSTemplateRequest :: Lens' CreateSmsTemplate SMSTemplateRequest Source #

Undocumented member.

createSmsTemplateResponse_httpStatus :: Lens' CreateSmsTemplateResponse Int Source #

The response's http status code.

createSmsTemplateResponse_createTemplateMessageBody :: Lens' CreateSmsTemplateResponse CreateTemplateMessageBody Source #

Undocumented member.

PhoneNumberValidate

phoneNumberValidate_numberValidateRequest :: Lens' PhoneNumberValidate NumberValidateRequest Source #

Undocumented member.

phoneNumberValidateResponse_httpStatus :: Lens' PhoneNumberValidateResponse Int Source #

The response's http status code.

phoneNumberValidateResponse_numberValidateResponse :: Lens' PhoneNumberValidateResponse NumberValidateResponse Source #

Undocumented member.

ListJourneys

listJourneys_token :: Lens' ListJourneys (Maybe Text) Source #

The NextToken string that specifies which page of results to return in a paginated response.

listJourneys_pageSize :: Lens' ListJourneys (Maybe Text) Source #

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

listJourneys_applicationId :: Lens' ListJourneys Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

listJourneysResponse_httpStatus :: Lens' ListJourneysResponse Int Source #

The response's http status code.

listJourneysResponse_journeysResponse :: Lens' ListJourneysResponse JourneysResponse Source #

Undocumented member.

GetApnsVoipChannel

getApnsVoipChannel_applicationId :: Lens' GetApnsVoipChannel Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getApnsVoipChannelResponse_httpStatus :: Lens' GetApnsVoipChannelResponse Int Source #

The response's http status code.

getApnsVoipChannelResponse_aPNSVoipChannelResponse :: Lens' GetApnsVoipChannelResponse APNSVoipChannelResponse Source #

Undocumented member.

GetEmailChannel

getEmailChannel_applicationId :: Lens' GetEmailChannel Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getEmailChannelResponse_httpStatus :: Lens' GetEmailChannelResponse Int Source #

The response's http status code.

getEmailChannelResponse_emailChannelResponse :: Lens' GetEmailChannelResponse EmailChannelResponse Source #

Undocumented member.

Types

ADMChannelRequest

aDMChannelRequest_enabled :: Lens' ADMChannelRequest (Maybe Bool) Source #

Specifies whether to enable the ADM channel for the application.

aDMChannelRequest_clientSecret :: Lens' ADMChannelRequest Text Source #

The Client Secret that you received from Amazon to send messages by using ADM.

aDMChannelRequest_clientId :: Lens' ADMChannelRequest Text Source #

The Client ID that you received from Amazon to send messages by using ADM.

ADMChannelResponse

aDMChannelResponse_lastModifiedDate :: Lens' ADMChannelResponse (Maybe Text) Source #

The date and time when the ADM channel was last modified.

aDMChannelResponse_enabled :: Lens' ADMChannelResponse (Maybe Bool) Source #

Specifies whether the ADM channel is enabled for the application.

aDMChannelResponse_isArchived :: Lens' ADMChannelResponse (Maybe Bool) Source #

Specifies whether the ADM channel is archived.

aDMChannelResponse_applicationId :: Lens' ADMChannelResponse (Maybe Text) Source #

The unique identifier for the application that the ADM channel applies to.

aDMChannelResponse_version :: Lens' ADMChannelResponse (Maybe Int) Source #

The current version of the ADM channel.

aDMChannelResponse_id :: Lens' ADMChannelResponse (Maybe Text) Source #

(Deprecated) An identifier for the ADM channel. This property is retained only for backward compatibility.

aDMChannelResponse_creationDate :: Lens' ADMChannelResponse (Maybe Text) Source #

The date and time when the ADM channel was enabled.

aDMChannelResponse_lastModifiedBy :: Lens' ADMChannelResponse (Maybe Text) Source #

The user who last modified the ADM channel.

aDMChannelResponse_hasCredential :: Lens' ADMChannelResponse (Maybe Bool) Source #

(Not used) This property is retained only for backward compatibility.

aDMChannelResponse_platform :: Lens' ADMChannelResponse Text Source #

The type of messaging or notification platform for the channel. For the ADM channel, this value is ADM.

ADMMessage

aDMMessage_substitutions :: Lens' ADMMessage (Maybe (HashMap Text [Text])) Source #

The default message variables to use in the notification message. You can override the default variables with individual address variables.

aDMMessage_expiresAfter :: Lens' ADMMessage (Maybe Text) Source #

The amount of time, in seconds, that ADM should store the message if the recipient's device is offline. Amazon Pinpoint specifies this value in the expiresAfter parameter when it sends the notification message to ADM.

aDMMessage_md5 :: Lens' ADMMessage (Maybe Text) Source #

The base64-encoded, MD5 checksum of the value specified by the Data property. ADM uses the MD5 value to verify the integrity of the data.

aDMMessage_silentPush :: Lens' ADMMessage (Maybe Bool) Source #

Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.

aDMMessage_imageIconUrl :: Lens' ADMMessage (Maybe Text) Source #

The URL of the large icon image to display in the content view of the push notification.

aDMMessage_rawContent :: Lens' ADMMessage (Maybe Text) Source #

The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

aDMMessage_data :: Lens' ADMMessage (Maybe (HashMap Text Text)) Source #

The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

aDMMessage_smallImageIconUrl :: Lens' ADMMessage (Maybe Text) Source #

The URL of the small icon image to display in the status bar and the content view of the push notification.

aDMMessage_body :: Lens' ADMMessage (Maybe Text) Source #

The body of the notification message.

aDMMessage_url :: Lens' ADMMessage (Maybe Text) Source #

The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

aDMMessage_sound :: Lens' ADMMessage (Maybe Text) Source #

The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

aDMMessage_action :: Lens' ADMMessage (Maybe Action) Source #

The action to occur if the recipient taps the push notification. Valid values are:

OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

aDMMessage_imageUrl :: Lens' ADMMessage (Maybe Text) Source #

The URL of an image to display in the push notification.

aDMMessage_consolidationKey :: Lens' ADMMessage (Maybe Text) Source #

An arbitrary string that indicates that multiple messages are logically the same and that Amazon Device Messaging (ADM) can drop previously enqueued messages in favor of this message.

aDMMessage_title :: Lens' ADMMessage (Maybe Text) Source #

The title to display above the notification message on the recipient's device.

aDMMessage_iconReference :: Lens' ADMMessage (Maybe Text) Source #

The icon image name of the asset saved in your app.

APNSChannelRequest

aPNSChannelRequest_tokenKey :: Lens' APNSChannelRequest (Maybe Text) Source #

The authentication key to use for APNs tokens.

aPNSChannelRequest_privateKey :: Lens' APNSChannelRequest (Maybe Text) Source #

The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.

aPNSChannelRequest_enabled :: Lens' APNSChannelRequest (Maybe Bool) Source #

Specifies whether to enable the APNs channel for the application.

aPNSChannelRequest_teamId :: Lens' APNSChannelRequest (Maybe Text) Source #

The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

aPNSChannelRequest_bundleId :: Lens' APNSChannelRequest (Maybe Text) Source #

The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

aPNSChannelRequest_defaultAuthenticationMethod :: Lens' APNSChannelRequest (Maybe Text) Source #

The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.

aPNSChannelRequest_certificate :: Lens' APNSChannelRequest (Maybe Text) Source #

The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.

aPNSChannelRequest_tokenKeyId :: Lens' APNSChannelRequest (Maybe Text) Source #

The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.

APNSChannelResponse

aPNSChannelResponse_lastModifiedDate :: Lens' APNSChannelResponse (Maybe Text) Source #

The date and time when the APNs channel was last modified.

aPNSChannelResponse_enabled :: Lens' APNSChannelResponse (Maybe Bool) Source #

Specifies whether the APNs channel is enabled for the application.

aPNSChannelResponse_hasTokenKey :: Lens' APNSChannelResponse (Maybe Bool) Source #

Specifies whether the APNs channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

aPNSChannelResponse_defaultAuthenticationMethod :: Lens' APNSChannelResponse (Maybe Text) Source #

The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.

aPNSChannelResponse_isArchived :: Lens' APNSChannelResponse (Maybe Bool) Source #

Specifies whether the APNs channel is archived.

aPNSChannelResponse_applicationId :: Lens' APNSChannelResponse (Maybe Text) Source #

The unique identifier for the application that the APNs channel applies to.

aPNSChannelResponse_version :: Lens' APNSChannelResponse (Maybe Int) Source #

The current version of the APNs channel.

aPNSChannelResponse_id :: Lens' APNSChannelResponse (Maybe Text) Source #

(Deprecated) An identifier for the APNs channel. This property is retained only for backward compatibility.

aPNSChannelResponse_creationDate :: Lens' APNSChannelResponse (Maybe Text) Source #

The date and time when the APNs channel was enabled.

aPNSChannelResponse_lastModifiedBy :: Lens' APNSChannelResponse (Maybe Text) Source #

The user who last modified the APNs channel.

aPNSChannelResponse_hasCredential :: Lens' APNSChannelResponse (Maybe Bool) Source #

(Not used) This property is retained only for backward compatibility.

aPNSChannelResponse_platform :: Lens' APNSChannelResponse Text Source #

The type of messaging or notification platform for the channel. For the APNs channel, this value is APNS.

APNSMessage

aPNSMessage_substitutions :: Lens' APNSMessage (Maybe (HashMap Text [Text])) Source #

The default message variables to use in the notification message. You can override these default variables with individual address variables.

aPNSMessage_silentPush :: Lens' APNSMessage (Maybe Bool) Source #

Specifies whether the notification is a silent push notification. A silent (or background) push notification isn't displayed on recipients' devices. You can use silent push notifications to make small updates to your app, or to display messages in an in-app message center.

Amazon Pinpoint uses this property to determine the correct value for the apns-push-type request header when it sends the notification message to APNs. If you specify a value of true for this property, Amazon Pinpoint sets the value for the apns-push-type header field to background.

If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. For silent (background) notifications, set the value of content-available to 1. Additionally, the message payload for a silent notification can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.

Apple has indicated that they will throttle "excessive" background notifications based on current traffic volumes. To prevent your notifications being throttled, Apple recommends that you send no more than 3 silent push notifications to each recipient per hour.

aPNSMessage_aPNSPushType :: Lens' APNSMessage (Maybe Text) Source #

The type of push notification to send. Valid values are:

alert - For a standard notification that's displayed on recipients' devices and prompts a recipient to interact with the notification.
background - For a silent notification that delivers content in the background and isn't displayed on recipients' devices.
complication - For a notification that contains update information for an app’s complication timeline.
fileprovider - For a notification that signals changes to a File Provider extension.
mdm - For a notification that tells managed devices to contact the MDM server.
voip - For a notification that provides information about an incoming VoIP call.

Amazon Pinpoint specifies this value in the apns-push-type request header when it sends the notification message to APNs. If you don't specify a value for this property, Amazon Pinpoint sets the value to alert or background automatically, based on the value that you specify for the SilentPush or RawContent property of the message.

For more information about the apns-push-type request header, see Sending Notification Requests to APNs on the Apple Developer website.

aPNSMessage_priority :: Lens' APNSMessage (Maybe Text) Source #

para>5 - Low priority, the notification might be delayed, delivered as part of a group, or throttled.

/listitem>

10 - High priority, the notification is sent immediately. This is the default value. A high priority notification should trigger an alert, play a sound, or badge your app's icon on the recipient's device.

/para>

Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification message to APNs.

The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are normal, for 5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts and converts the value to the corresponding APNs value.

aPNSMessage_rawContent :: Lens' APNSMessage (Maybe Text) Source #

The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. The value of the content-available key has to be an integer, and can only be 0 or 1. If you're sending a standard notification, set the value of content-available to 0. If you're sending a silent (background) notification, set the value of content-available to 1. Additionally, silent notification payloads can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.

aPNSMessage_data :: Lens' APNSMessage (Maybe (HashMap Text Text)) Source #

The JSON payload to use for a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

aPNSMessage_body :: Lens' APNSMessage (Maybe Text) Source #

The body of the notification message.

aPNSMessage_category :: Lens' APNSMessage (Maybe Text) Source #

The key that indicates the notification type for the push notification. This key is a value that's defined by the identifier property of one of your app's registered categories.

aPNSMessage_timeToLive :: Lens' APNSMessage (Maybe Int) Source #

The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If this value is 0, APNs treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification message to APNs.

aPNSMessage_url :: Lens' APNSMessage (Maybe Text) Source #

The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

aPNSMessage_sound :: Lens' APNSMessage (Maybe Text) Source #

The key for the sound to play when the recipient receives the push notification. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

aPNSMessage_action :: Lens' APNSMessage (Maybe Action) Source #

The action to occur if the recipient taps the push notification. Valid values are:

OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

aPNSMessage_mediaUrl :: Lens' APNSMessage (Maybe Text) Source #

The URL of an image or video to display in the push notification.

aPNSMessage_preferredAuthenticationMethod :: Lens' APNSMessage (Maybe Text) Source #

The authentication method that you want Amazon Pinpoint to use when authenticating with APNs, CERTIFICATE or TOKEN.

aPNSMessage_badge :: Lens' APNSMessage (Maybe Int) Source #

The key that indicates whether and how to modify the badge of your app's icon when the recipient receives the push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove the badge, set this value to 0.

aPNSMessage_title :: Lens' APNSMessage (Maybe Text) Source #

The title to display above the notification message on the recipient's device.

aPNSMessage_threadId :: Lens' APNSMessage (Maybe Text) Source #

The key that represents your app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.

aPNSMessage_collapseId :: Lens' APNSMessage (Maybe Text) Source #

An arbitrary identifier that, if assigned to multiple messages, APNs uses to coalesce the messages into a single push notification instead of delivering each message individually. This value can't exceed 64 bytes.

Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification message to APNs.

APNSPushNotificationTemplate

aPNSPushNotificationTemplate_rawContent :: Lens' APNSPushNotificationTemplate (Maybe Text) Source #

The raw, JSON-formatted string to use as the payload for push notifications that are based on the message template. If specified, this value overrides all other content for the message template.

aPNSPushNotificationTemplate_body :: Lens' APNSPushNotificationTemplate (Maybe Text) Source #

The message body to use in push notifications that are based on the message template.

aPNSPushNotificationTemplate_url :: Lens' APNSPushNotificationTemplate (Maybe Text) Source #

The URL to open in the recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.

aPNSPushNotificationTemplate_sound :: Lens' APNSPushNotificationTemplate (Maybe Text) Source #

The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

aPNSPushNotificationTemplate_action :: Lens' APNSPushNotificationTemplate (Maybe Action) Source #

The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

aPNSPushNotificationTemplate_mediaUrl :: Lens' APNSPushNotificationTemplate (Maybe Text) Source #

The URL of an image or video to display in push notifications that are based on the message template.

aPNSPushNotificationTemplate_title :: Lens' APNSPushNotificationTemplate (Maybe Text) Source #

The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.

APNSSandboxChannelRequest

aPNSSandboxChannelRequest_tokenKey :: Lens' APNSSandboxChannelRequest (Maybe Text) Source #

The authentication key to use for APNs tokens.

aPNSSandboxChannelRequest_privateKey :: Lens' APNSSandboxChannelRequest (Maybe Text) Source #

The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.

aPNSSandboxChannelRequest_enabled :: Lens' APNSSandboxChannelRequest (Maybe Bool) Source #

Specifies whether to enable the APNs sandbox channel for the application.

aPNSSandboxChannelRequest_teamId :: Lens' APNSSandboxChannelRequest (Maybe Text) Source #

The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

aPNSSandboxChannelRequest_bundleId :: Lens' APNSSandboxChannelRequest (Maybe Text) Source #

The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

aPNSSandboxChannelRequest_defaultAuthenticationMethod :: Lens' APNSSandboxChannelRequest (Maybe Text) Source #

The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment, key or certificate.

aPNSSandboxChannelRequest_certificate :: Lens' APNSSandboxChannelRequest (Maybe Text) Source #

The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.

aPNSSandboxChannelRequest_tokenKeyId :: Lens' APNSSandboxChannelRequest (Maybe Text) Source #

The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.

APNSSandboxChannelResponse

aPNSSandboxChannelResponse_lastModifiedDate :: Lens' APNSSandboxChannelResponse (Maybe Text) Source #

The date and time when the APNs sandbox channel was last modified.

aPNSSandboxChannelResponse_enabled :: Lens' APNSSandboxChannelResponse (Maybe Bool) Source #

Specifies whether the APNs sandbox channel is enabled for the application.

aPNSSandboxChannelResponse_hasTokenKey :: Lens' APNSSandboxChannelResponse (Maybe Bool) Source #

Specifies whether the APNs sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

aPNSSandboxChannelResponse_defaultAuthenticationMethod :: Lens' APNSSandboxChannelResponse (Maybe Text) Source #

The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.

aPNSSandboxChannelResponse_isArchived :: Lens' APNSSandboxChannelResponse (Maybe Bool) Source #

Specifies whether the APNs sandbox channel is archived.

aPNSSandboxChannelResponse_applicationId :: Lens' APNSSandboxChannelResponse (Maybe Text) Source #

The unique identifier for the application that the APNs sandbox channel applies to.

aPNSSandboxChannelResponse_version :: Lens' APNSSandboxChannelResponse (Maybe Int) Source #

The current version of the APNs sandbox channel.

aPNSSandboxChannelResponse_id :: Lens' APNSSandboxChannelResponse (Maybe Text) Source #

(Deprecated) An identifier for the APNs sandbox channel. This property is retained only for backward compatibility.

aPNSSandboxChannelResponse_creationDate :: Lens' APNSSandboxChannelResponse (Maybe Text) Source #

The date and time when the APNs sandbox channel was enabled.

aPNSSandboxChannelResponse_lastModifiedBy :: Lens' APNSSandboxChannelResponse (Maybe Text) Source #

The user who last modified the APNs sandbox channel.

aPNSSandboxChannelResponse_hasCredential :: Lens' APNSSandboxChannelResponse (Maybe Bool) Source #

(Not used) This property is retained only for backward compatibility.

aPNSSandboxChannelResponse_platform :: Lens' APNSSandboxChannelResponse Text Source #

The type of messaging or notification platform for the channel. For the APNs sandbox channel, this value is APNS_SANDBOX.

APNSVoipChannelRequest

aPNSVoipChannelRequest_tokenKey :: Lens' APNSVoipChannelRequest (Maybe Text) Source #

The authentication key to use for APNs tokens.

aPNSVoipChannelRequest_privateKey :: Lens' APNSVoipChannelRequest (Maybe Text) Source #

The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.

aPNSVoipChannelRequest_enabled :: Lens' APNSVoipChannelRequest (Maybe Bool) Source #

Specifies whether to enable the APNs VoIP channel for the application.

aPNSVoipChannelRequest_teamId :: Lens' APNSVoipChannelRequest (Maybe Text) Source #

The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

aPNSVoipChannelRequest_bundleId :: Lens' APNSVoipChannelRequest (Maybe Text) Source #

The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

aPNSVoipChannelRequest_defaultAuthenticationMethod :: Lens' APNSVoipChannelRequest (Maybe Text) Source #

The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.

aPNSVoipChannelRequest_certificate :: Lens' APNSVoipChannelRequest (Maybe Text) Source #

The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.

aPNSVoipChannelRequest_tokenKeyId :: Lens' APNSVoipChannelRequest (Maybe Text) Source #

The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.

APNSVoipChannelResponse

aPNSVoipChannelResponse_lastModifiedDate :: Lens' APNSVoipChannelResponse (Maybe Text) Source #

The date and time when the APNs VoIP channel was last modified.

aPNSVoipChannelResponse_enabled :: Lens' APNSVoipChannelResponse (Maybe Bool) Source #

Specifies whether the APNs VoIP channel is enabled for the application.

aPNSVoipChannelResponse_hasTokenKey :: Lens' APNSVoipChannelResponse (Maybe Bool) Source #

Specifies whether the APNs VoIP channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

aPNSVoipChannelResponse_defaultAuthenticationMethod :: Lens' APNSVoipChannelResponse (Maybe Text) Source #

The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.

aPNSVoipChannelResponse_isArchived :: Lens' APNSVoipChannelResponse (Maybe Bool) Source #

Specifies whether the APNs VoIP channel is archived.

aPNSVoipChannelResponse_applicationId :: Lens' APNSVoipChannelResponse (Maybe Text) Source #

The unique identifier for the application that the APNs VoIP channel applies to.

aPNSVoipChannelResponse_version :: Lens' APNSVoipChannelResponse (Maybe Int) Source #

The current version of the APNs VoIP channel.

aPNSVoipChannelResponse_id :: Lens' APNSVoipChannelResponse (Maybe Text) Source #

(Deprecated) An identifier for the APNs VoIP channel. This property is retained only for backward compatibility.

aPNSVoipChannelResponse_creationDate :: Lens' APNSVoipChannelResponse (Maybe Text) Source #

The date and time when the APNs VoIP channel was enabled.

aPNSVoipChannelResponse_lastModifiedBy :: Lens' APNSVoipChannelResponse (Maybe Text) Source #

The user who last modified the APNs VoIP channel.

aPNSVoipChannelResponse_hasCredential :: Lens' APNSVoipChannelResponse (Maybe Bool) Source #

(Not used) This property is retained only for backward compatibility.

aPNSVoipChannelResponse_platform :: Lens' APNSVoipChannelResponse Text Source #

The type of messaging or notification platform for the channel. For the APNs VoIP channel, this value is APNS_VOIP.

APNSVoipSandboxChannelRequest

aPNSVoipSandboxChannelRequest_tokenKey :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) Source #

The authentication key to use for APNs tokens.

aPNSVoipSandboxChannelRequest_privateKey :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) Source #

The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.

aPNSVoipSandboxChannelRequest_enabled :: Lens' APNSVoipSandboxChannelRequest (Maybe Bool) Source #

Specifies whether the APNs VoIP sandbox channel is enabled for the application.

aPNSVoipSandboxChannelRequest_teamId :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) Source #

The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

aPNSVoipSandboxChannelRequest_bundleId :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) Source #

The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

aPNSVoipSandboxChannelRequest_defaultAuthenticationMethod :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) Source #

The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment for this channel, key or certificate.

aPNSVoipSandboxChannelRequest_certificate :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) Source #

The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.

aPNSVoipSandboxChannelRequest_tokenKeyId :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) Source #

The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.

APNSVoipSandboxChannelResponse

aPNSVoipSandboxChannelResponse_lastModifiedDate :: Lens' APNSVoipSandboxChannelResponse (Maybe Text) Source #

The date and time when the APNs VoIP sandbox channel was last modified.

aPNSVoipSandboxChannelResponse_enabled :: Lens' APNSVoipSandboxChannelResponse (Maybe Bool) Source #

Specifies whether the APNs VoIP sandbox channel is enabled for the application.

aPNSVoipSandboxChannelResponse_hasTokenKey :: Lens' APNSVoipSandboxChannelResponse (Maybe Bool) Source #

Specifies whether the APNs VoIP sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

aPNSVoipSandboxChannelResponse_defaultAuthenticationMethod :: Lens' APNSVoipSandboxChannelResponse (Maybe Text) Source #

The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.

aPNSVoipSandboxChannelResponse_isArchived :: Lens' APNSVoipSandboxChannelResponse (Maybe Bool) Source #

Specifies whether the APNs VoIP sandbox channel is archived.

aPNSVoipSandboxChannelResponse_applicationId :: Lens' APNSVoipSandboxChannelResponse (Maybe Text) Source #

The unique identifier for the application that the APNs VoIP sandbox channel applies to.

aPNSVoipSandboxChannelResponse_version :: Lens' APNSVoipSandboxChannelResponse (Maybe Int) Source #

The current version of the APNs VoIP sandbox channel.

aPNSVoipSandboxChannelResponse_id :: Lens' APNSVoipSandboxChannelResponse (Maybe Text) Source #

(Deprecated) An identifier for the APNs VoIP sandbox channel. This property is retained only for backward compatibility.

aPNSVoipSandboxChannelResponse_creationDate :: Lens' APNSVoipSandboxChannelResponse (Maybe Text) Source #

The date and time when the APNs VoIP sandbox channel was enabled.

aPNSVoipSandboxChannelResponse_lastModifiedBy :: Lens' APNSVoipSandboxChannelResponse (Maybe Text) Source #

The user who last modified the APNs VoIP sandbox channel.

aPNSVoipSandboxChannelResponse_hasCredential :: Lens' APNSVoipSandboxChannelResponse (Maybe Bool) Source #

(Not used) This property is retained only for backward compatibility.

aPNSVoipSandboxChannelResponse_platform :: Lens' APNSVoipSandboxChannelResponse Text Source #

The type of messaging or notification platform for the channel. For the APNs VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.

ActivitiesResponse

activitiesResponse_nextToken :: Lens' ActivitiesResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

activitiesResponse_item :: Lens' ActivitiesResponse [ActivityResponse] Source #

An array of responses, one for each activity that was performed by the campaign.

Activity

activity_conditionalSplit :: Lens' Activity (Maybe ConditionalSplitActivity) Source #

The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.

activity_email :: Lens' Activity (Maybe EmailMessageActivity) Source #

The settings for an email activity. This type of activity sends an email message to participants.

activity_multiCondition :: Lens' Activity (Maybe MultiConditionalSplitActivity) Source #

The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.

activity_contactCenter :: Lens' Activity (Maybe ContactCenterActivity) Source #

The settings for a connect activity. This type of activity initiates a contact center call to participants.

activity_custom :: Lens' Activity (Maybe CustomMessageActivity) Source #

The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.

activity_wait :: Lens' Activity (Maybe WaitActivity) Source #

The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

activity_randomSplit :: Lens' Activity (Maybe RandomSplitActivity) Source #

The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.

activity_holdout :: Lens' Activity (Maybe HoldoutActivity) Source #

The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.

activity_sms :: Lens' Activity (Maybe SMSMessageActivity) Source #

The settings for an SMS activity. This type of activity sends a text message to participants.

activity_push :: Lens' Activity (Maybe PushMessageActivity) Source #

The settings for a push notification activity. This type of activity sends a push notification to participants.

activity_description :: Lens' Activity (Maybe Text) Source #

The custom description of the activity.

ActivityResponse

activityResponse_state :: Lens' ActivityResponse (Maybe Text) Source #

The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.

activityResponse_start :: Lens' ActivityResponse (Maybe Text) Source #

The actual start time, in ISO 8601 format, of the activity.

activityResponse_timezonesCompletedCount :: Lens' ActivityResponse (Maybe Int) Source #

The total number of time zones that were completed.

activityResponse_timezonesTotalCount :: Lens' ActivityResponse (Maybe Int) Source #

The total number of unique time zones that are in the segment for the campaign.

activityResponse_result :: Lens' ActivityResponse (Maybe Text) Source #

Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.

activityResponse_treatmentId :: Lens' ActivityResponse (Maybe Text) Source #

The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

activityResponse_successfulEndpointCount :: Lens' ActivityResponse (Maybe Int) Source #

The total number of endpoints that the campaign successfully delivered messages to.

activityResponse_end :: Lens' ActivityResponse (Maybe Text) Source #

The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.

activityResponse_totalEndpointCount :: Lens' ActivityResponse (Maybe Int) Source #

The total number of endpoints that the campaign attempted to deliver messages to.

activityResponse_scheduledStart :: Lens' ActivityResponse (Maybe Text) Source #

The scheduled start time, in ISO 8601 format, for the activity.

activityResponse_campaignId :: Lens' ActivityResponse Text Source #

The unique identifier for the campaign that the activity applies to.

activityResponse_id :: Lens' ActivityResponse Text Source #

The unique identifier for the activity.

activityResponse_applicationId :: Lens' ActivityResponse Text Source #

The unique identifier for the application that the campaign applies to.

AddressConfiguration

addressConfiguration_substitutions :: Lens' AddressConfiguration (Maybe (HashMap Text [Text])) Source #

A map of the message variables to merge with the variables specified by properties of the DefaultMessage object. The variables specified in this map take precedence over all other variables.

addressConfiguration_titleOverride :: Lens' AddressConfiguration (Maybe Text) Source #

The message title to use instead of the default message title. This value overrides the default message title.

addressConfiguration_context :: Lens' AddressConfiguration (Maybe (HashMap Text Text)) Source #

An object that maps custom attributes to attributes for the address and is attached to the message. Attribute names are case sensitive.

For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.

addressConfiguration_rawContent :: Lens' AddressConfiguration (Maybe Text) Source #

The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.

addressConfiguration_bodyOverride :: Lens' AddressConfiguration (Maybe Text) Source #

The message body to use instead of the default message body. This value overrides the default message body.

addressConfiguration_channelType :: Lens' AddressConfiguration (Maybe ChannelType) Source #

The channel to use when sending the message.

AndroidPushNotificationTemplate

androidPushNotificationTemplate_imageIconUrl :: Lens' AndroidPushNotificationTemplate (Maybe Text) Source #

The URL of the large icon image to display in the content view of a push notification that's based on the message template.

androidPushNotificationTemplate_rawContent :: Lens' AndroidPushNotificationTemplate (Maybe Text) Source #

The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.

androidPushNotificationTemplate_smallImageIconUrl :: Lens' AndroidPushNotificationTemplate (Maybe Text) Source #

The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.

androidPushNotificationTemplate_body :: Lens' AndroidPushNotificationTemplate (Maybe Text) Source #

The message body to use in a push notification that's based on the message template.

androidPushNotificationTemplate_url :: Lens' AndroidPushNotificationTemplate (Maybe Text) Source #

The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.

androidPushNotificationTemplate_sound :: Lens' AndroidPushNotificationTemplate (Maybe Text) Source #

The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

androidPushNotificationTemplate_action :: Lens' AndroidPushNotificationTemplate (Maybe Action) Source #

The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

androidPushNotificationTemplate_imageUrl :: Lens' AndroidPushNotificationTemplate (Maybe Text) Source #

The URL of an image to display in a push notification that's based on the message template.

androidPushNotificationTemplate_title :: Lens' AndroidPushNotificationTemplate (Maybe Text) Source #

The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.

ApplicationDateRangeKpiResponse

applicationDateRangeKpiResponse_nextToken :: Lens' ApplicationDateRangeKpiResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Application Metrics resource because the resource returns all results in a single page.

applicationDateRangeKpiResponse_kpiResult :: Lens' ApplicationDateRangeKpiResponse BaseKpiResult Source #

An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

applicationDateRangeKpiResponse_kpiName :: Lens' ApplicationDateRangeKpiResponse Text Source #

The name of the metric, also referred to as a /key performance indicator (KPI)/, that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.

applicationDateRangeKpiResponse_endTime :: Lens' ApplicationDateRangeKpiResponse UTCTime Source #

The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

applicationDateRangeKpiResponse_startTime :: Lens' ApplicationDateRangeKpiResponse UTCTime Source #

The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

applicationDateRangeKpiResponse_applicationId :: Lens' ApplicationDateRangeKpiResponse Text Source #

The unique identifier for the application that the metric applies to.

ApplicationResponse

applicationResponse_tags :: Lens' ApplicationResponse (Maybe (HashMap Text Text)) Source #

A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.

applicationResponse_id :: Lens' ApplicationResponse Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

applicationResponse_arn :: Lens' ApplicationResponse Text Source #

The Amazon Resource Name (ARN) of the application.

applicationResponse_name :: Lens' ApplicationResponse Text Source #

The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.

ApplicationSettingsResource

applicationSettingsResource_lastModifiedDate :: Lens' ApplicationSettingsResource (Maybe Text) Source #

The date and time, in ISO 8601 format, when the application's settings were last modified.

applicationSettingsResource_limits :: Lens' ApplicationSettingsResource (Maybe CampaignLimits) Source #

The default sending limits for campaigns in the application.

applicationSettingsResource_quietTime :: Lens' ApplicationSettingsResource (Maybe QuietTime) Source #

The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:

The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).

If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.

applicationSettingsResource_campaignHook :: Lens' ApplicationSettingsResource (Maybe CampaignHook) Source #

The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.

applicationSettingsResource_applicationId :: Lens' ApplicationSettingsResource Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

ApplicationsResponse

applicationsResponse_nextToken :: Lens' ApplicationsResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

applicationsResponse_item :: Lens' ApplicationsResponse (Maybe [ApplicationResponse]) Source #

An array of responses, one for each application that was returned.

AttributeDimension

attributeDimension_attributeType :: Lens' AttributeDimension (Maybe AttributeType) Source #

The type of segment dimension to use. Valid values are:

INCLUSIVE - endpoints that have attributes matching the values are included in the segment.

EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.

CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.

BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.

AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.

ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.

BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.

attributeDimension_values :: Lens' AttributeDimension [Text] Source #

The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

AttributesResource

attributesResource_attributes :: Lens' AttributesResource (Maybe [Text]) Source #

An array that specifies the names of the attributes that were removed from the endpoints.

attributesResource_attributeType :: Lens' AttributesResource Text Source #

The type of attribute or attributes that were removed from the endpoints. Valid values are:

endpoint-custom-attributes - Custom attributes that describe endpoints.
endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints.
endpoint-user-attributes - Custom attributes that describe users.

attributesResource_applicationId :: Lens' AttributesResource Text Source #

The unique identifier for the application.

BaiduChannelRequest

baiduChannelRequest_enabled :: Lens' BaiduChannelRequest (Maybe Bool) Source #

Specifies whether to enable the Baidu channel for the application.

baiduChannelRequest_secretKey :: Lens' BaiduChannelRequest Text Source #

The secret key that you received from the Baidu Cloud Push service to communicate with the service.

baiduChannelRequest_apiKey :: Lens' BaiduChannelRequest Text Source #

The API key that you received from the Baidu Cloud Push service to communicate with the service.

BaiduChannelResponse

baiduChannelResponse_lastModifiedDate :: Lens' BaiduChannelResponse (Maybe Text) Source #

The date and time when the Baidu channel was last modified.

baiduChannelResponse_enabled :: Lens' BaiduChannelResponse (Maybe Bool) Source #

Specifies whether the Baidu channel is enabled for the application.

baiduChannelResponse_isArchived :: Lens' BaiduChannelResponse (Maybe Bool) Source #

Specifies whether the Baidu channel is archived.

baiduChannelResponse_applicationId :: Lens' BaiduChannelResponse (Maybe Text) Source #

The unique identifier for the application that the Baidu channel applies to.

baiduChannelResponse_version :: Lens' BaiduChannelResponse (Maybe Int) Source #

The current version of the Baidu channel.

baiduChannelResponse_id :: Lens' BaiduChannelResponse (Maybe Text) Source #

(Deprecated) An identifier for the Baidu channel. This property is retained only for backward compatibility.

baiduChannelResponse_creationDate :: Lens' BaiduChannelResponse (Maybe Text) Source #

The date and time when the Baidu channel was enabled.

baiduChannelResponse_lastModifiedBy :: Lens' BaiduChannelResponse (Maybe Text) Source #

The user who last modified the Baidu channel.

baiduChannelResponse_hasCredential :: Lens' BaiduChannelResponse (Maybe Bool) Source #

(Not used) This property is retained only for backward compatibility.

baiduChannelResponse_credential :: Lens' BaiduChannelResponse Text Source #

The API key that you received from the Baidu Cloud Push service to communicate with the service.

baiduChannelResponse_platform :: Lens' BaiduChannelResponse Text Source #

The type of messaging or notification platform for the channel. For the Baidu channel, this value is BAIDU.

BaiduMessage

baiduMessage_substitutions :: Lens' BaiduMessage (Maybe (HashMap Text [Text])) Source #

The default message variables to use in the notification message. You can override the default variables with individual address variables.

baiduMessage_silentPush :: Lens' BaiduMessage (Maybe Bool) Source #

Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.

baiduMessage_imageIconUrl :: Lens' BaiduMessage (Maybe Text) Source #

The URL of the large icon image to display in the content view of the push notification.

baiduMessage_rawContent :: Lens' BaiduMessage (Maybe Text) Source #

The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

baiduMessage_data :: Lens' BaiduMessage (Maybe (HashMap Text Text)) Source #

The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

baiduMessage_smallImageIconUrl :: Lens' BaiduMessage (Maybe Text) Source #

The URL of the small icon image to display in the status bar and the content view of the push notification.

baiduMessage_body :: Lens' BaiduMessage (Maybe Text) Source #

The body of the notification message.

baiduMessage_timeToLive :: Lens' BaiduMessage (Maybe Int) Source #

The amount of time, in seconds, that the Baidu Cloud Push service should store the message if the recipient's device is offline. The default value and maximum supported time is 604,800 seconds (7 days).

baiduMessage_url :: Lens' BaiduMessage (Maybe Text) Source #

The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

baiduMessage_sound :: Lens' BaiduMessage (Maybe Text) Source #

The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

baiduMessage_action :: Lens' BaiduMessage (Maybe Action) Source #

The action to occur if the recipient taps the push notification. Valid values are:

OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

baiduMessage_imageUrl :: Lens' BaiduMessage (Maybe Text) Source #

The URL of an image to display in the push notification.

baiduMessage_title :: Lens' BaiduMessage (Maybe Text) Source #

The title to display above the notification message on the recipient's device.

baiduMessage_iconReference :: Lens' BaiduMessage (Maybe Text) Source #

The icon image name of the asset saved in your app.

BaseKpiResult

baseKpiResult_rows :: Lens' BaseKpiResult [ResultRow] Source #

An array of objects that provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.

CampaignCustomMessage

campaignCustomMessage_data :: Lens' CampaignCustomMessage (Maybe Text) Source #

The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.

CampaignDateRangeKpiResponse

campaignDateRangeKpiResponse_nextToken :: Lens' CampaignDateRangeKpiResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Campaign Metrics resource because the resource returns all results in a single page.

campaignDateRangeKpiResponse_kpiResult :: Lens' CampaignDateRangeKpiResponse BaseKpiResult Source #

An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

campaignDateRangeKpiResponse_kpiName :: Lens' CampaignDateRangeKpiResponse Text Source #

The name of the metric, also referred to as a /key performance indicator (KPI)/, that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.

campaignDateRangeKpiResponse_endTime :: Lens' CampaignDateRangeKpiResponse UTCTime Source #

The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

campaignDateRangeKpiResponse_campaignId :: Lens' CampaignDateRangeKpiResponse Text Source #

The unique identifier for the campaign that the metric applies to.

campaignDateRangeKpiResponse_startTime :: Lens' CampaignDateRangeKpiResponse UTCTime Source #

The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

campaignDateRangeKpiResponse_applicationId :: Lens' CampaignDateRangeKpiResponse Text Source #

The unique identifier for the application that the metric applies to.

CampaignEmailMessage

campaignEmailMessage_body :: Lens' CampaignEmailMessage (Maybe Text) Source #

The body of the email for recipients whose email clients don't render HTML content.

campaignEmailMessage_fromAddress :: Lens' CampaignEmailMessage (Maybe Text) Source #

The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.

campaignEmailMessage_htmlBody :: Lens' CampaignEmailMessage (Maybe Text) Source #

The body of the email, in HTML format, for recipients whose email clients render HTML content.

campaignEmailMessage_title :: Lens' CampaignEmailMessage (Maybe Text) Source #

The subject line, or title, of the email.

CampaignEventFilter

campaignEventFilter_filterType :: Lens' CampaignEventFilter FilterType Source #

The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Events resource) occurs.

campaignEventFilter_dimensions :: Lens' CampaignEventFilter EventDimensions Source #

The dimension settings of the event filter for the campaign.

CampaignHook

campaignHook_lambdaFunctionName :: Lens' CampaignHook (Maybe Text) Source #

The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.

campaignHook_mode :: Lens' CampaignHook (Maybe Mode) Source #

The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:

FILTER - Invoke the function to customize the segment that's used by a campaign.
DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.

campaignHook_webUrl :: Lens' CampaignHook (Maybe Text) Source #

The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.

CampaignInAppMessage

campaignInAppMessage_layout :: Lens' CampaignInAppMessage (Maybe Layout) Source #

In-app message layout.

campaignInAppMessage_body :: Lens' CampaignInAppMessage (Maybe Text) Source #

The message body of the notification, the email body or the text message.

campaignInAppMessage_content :: Lens' CampaignInAppMessage (Maybe [InAppMessageContent]) Source #

In-app message content.

campaignInAppMessage_customConfig :: Lens' CampaignInAppMessage (Maybe (HashMap Text Text)) Source #

Custom config to be sent to client.

CampaignLimits

campaignLimits_messagesPerSecond :: Lens' CampaignLimits (Maybe Int) Source #

The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 50. The maximum value is 20,000.

campaignLimits_daily :: Lens' CampaignLimits (Maybe Int) Source #

The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.

campaignLimits_total :: Lens' CampaignLimits (Maybe Int) Source #

The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.

campaignLimits_session :: Lens' CampaignLimits (Maybe Int) Source #

The maximum total number of messages that the campaign can send per user session.

campaignLimits_maximumDuration :: Lens' CampaignLimits (Maybe Int) Source #

The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.

CampaignResponse

campaignResponse_customDeliveryConfiguration :: Lens' CampaignResponse (Maybe CustomDeliveryConfiguration) Source #

The delivery configuration settings for sending the campaign through a custom channel.

campaignResponse_state :: Lens' CampaignResponse (Maybe CampaignState) Source #

The current status of the campaign.

campaignResponse_priority :: Lens' CampaignResponse (Maybe Int) Source #

Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.

campaignResponse_schedule :: Lens' CampaignResponse (Maybe Schedule) Source #

The schedule settings for the campaign.

campaignResponse_templateConfiguration :: Lens' CampaignResponse (Maybe TemplateConfiguration) Source #

The message template that’s used for the campaign.

campaignResponse_hook :: Lens' CampaignResponse (Maybe CampaignHook) Source #

The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.

campaignResponse_treatmentName :: Lens' CampaignResponse (Maybe Text) Source #

The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.

campaignResponse_limits :: Lens' CampaignResponse (Maybe CampaignLimits) Source #

The messaging limits for the campaign.

campaignResponse_isPaused :: Lens' CampaignResponse (Maybe Bool) Source #

Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.

campaignResponse_defaultState :: Lens' CampaignResponse (Maybe CampaignState) Source #

The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.

campaignResponse_name :: Lens' CampaignResponse (Maybe Text) Source #

The name of the campaign.

campaignResponse_version :: Lens' CampaignResponse (Maybe Int) Source #

The version number of the campaign.

campaignResponse_holdoutPercent :: Lens' CampaignResponse (Maybe Int) Source #

The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

campaignResponse_treatmentDescription :: Lens' CampaignResponse (Maybe Text) Source #

The custom description of the default treatment for the campaign.

campaignResponse_messageConfiguration :: Lens' CampaignResponse (Maybe MessageConfiguration) Source #

The message configuration settings for the campaign.

campaignResponse_description :: Lens' CampaignResponse (Maybe Text) Source #

The custom description of the campaign.

campaignResponse_additionalTreatments :: Lens' CampaignResponse (Maybe [TreatmentResource]) Source #

An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.

campaignResponse_tags :: Lens' CampaignResponse (Maybe (HashMap Text Text)) Source #

A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.

campaignResponse_lastModifiedDate :: Lens' CampaignResponse Text Source #

The date, in ISO 8601 format, when the campaign was last modified.

campaignResponse_creationDate :: Lens' CampaignResponse Text Source #

The date, in ISO 8601 format, when the campaign was created.

campaignResponse_segmentId :: Lens' CampaignResponse Text Source #

The unique identifier for the segment that's associated with the campaign.

campaignResponse_segmentVersion :: Lens' CampaignResponse Int Source #

The version number of the segment that's associated with the campaign.

campaignResponse_id :: Lens' CampaignResponse Text Source #

The unique identifier for the campaign.

campaignResponse_arn :: Lens' CampaignResponse Text Source #

The Amazon Resource Name (ARN) of the campaign.

campaignResponse_applicationId :: Lens' CampaignResponse Text Source #

The unique identifier for the application that the campaign applies to.

CampaignSmsMessage

campaignSmsMessage_originationNumber :: Lens' CampaignSmsMessage (Maybe Text) Source #

The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.

campaignSmsMessage_templateId :: Lens' CampaignSmsMessage (Maybe Text) Source #

The template ID received from the regulatory body for sending SMS in your country.

campaignSmsMessage_body :: Lens' CampaignSmsMessage (Maybe Text) Source #

The body of the SMS message.

campaignSmsMessage_messageType :: Lens' CampaignSmsMessage (Maybe MessageType) Source #

The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

campaignSmsMessage_senderId :: Lens' CampaignSmsMessage (Maybe Text) Source #

The sender ID to display on recipients' devices when they receive the SMS message.

campaignSmsMessage_entityId :: Lens' CampaignSmsMessage (Maybe Text) Source #

The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

CampaignState

campaignState_campaignStatus :: Lens' CampaignState (Maybe CampaignStatus) Source #

The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.

If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.

CampaignsResponse

campaignsResponse_nextToken :: Lens' CampaignsResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

campaignsResponse_item :: Lens' CampaignsResponse [CampaignResponse] Source #

An array of responses, one for each campaign that's associated with the application.

ChannelResponse

channelResponse_lastModifiedDate :: Lens' ChannelResponse (Maybe Text) Source #

The date and time, in ISO 8601 format, when the channel was last modified.

channelResponse_enabled :: Lens' ChannelResponse (Maybe Bool) Source #

Specifies whether the channel is enabled for the application.

channelResponse_isArchived :: Lens' ChannelResponse (Maybe Bool) Source #

Specifies whether the channel is archived.

channelResponse_applicationId :: Lens' ChannelResponse (Maybe Text) Source #

The unique identifier for the application.

channelResponse_version :: Lens' ChannelResponse (Maybe Int) Source #

The current version of the channel.

channelResponse_id :: Lens' ChannelResponse (Maybe Text) Source #

(Deprecated) An identifier for the channel. This property is retained only for backward compatibility.

channelResponse_creationDate :: Lens' ChannelResponse (Maybe Text) Source #

The date and time, in ISO 8601 format, when the channel was enabled.

channelResponse_lastModifiedBy :: Lens' ChannelResponse (Maybe Text) Source #

The user who last modified the channel.

channelResponse_hasCredential :: Lens' ChannelResponse (Maybe Bool) Source #

(Not used) This property is retained only for backward compatibility.

ChannelsResponse

channelsResponse_channels :: Lens' ChannelsResponse (HashMap Text ChannelResponse) Source #

A map that contains a multipart response for each channel. For each item in this object, the ChannelType is the key and the Channel is the value.

Condition

condition_operator :: Lens' Condition (Maybe Operator) Source #

Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.

condition_conditions :: Lens' Condition (Maybe [SimpleCondition]) Source #

The conditions to evaluate for the activity.

ConditionalSplitActivity

conditionalSplitActivity_evaluationWaitTime :: Lens' ConditionalSplitActivity (Maybe WaitTime) Source #

The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.

conditionalSplitActivity_trueActivity :: Lens' ConditionalSplitActivity (Maybe Text) Source #

The unique identifier for the activity to perform if the conditions are met.

conditionalSplitActivity_falseActivity :: Lens' ConditionalSplitActivity (Maybe Text) Source #

The unique identifier for the activity to perform if the conditions aren't met.

conditionalSplitActivity_condition :: Lens' ConditionalSplitActivity (Maybe Condition) Source #

The conditions that define the paths for the activity, and the relationship between the conditions.

ContactCenterActivity

contactCenterActivity_nextActivity :: Lens' ContactCenterActivity (Maybe Text) Source #

The unique identifier for the next activity to perform after the this activity.

CreateApplicationRequest

createApplicationRequest_tags :: Lens' CreateApplicationRequest (Maybe (HashMap Text Text)) Source #

A string-to-string map of key-value pairs that defines the tags to associate with the application. Each tag consists of a required tag key and an associated tag value.

createApplicationRequest_name :: Lens' CreateApplicationRequest Text Source #

The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.

CreateRecommenderConfiguration

createRecommenderConfiguration_recommendationTransformerUri :: Lens' CreateRecommenderConfiguration (Maybe Text) Source #

The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model.

createRecommenderConfiguration_recommendationsDisplayName :: Lens' CreateRecommenderConfiguration (Maybe Text) Source #

A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.

createRecommenderConfiguration_recommendationProviderIdType :: Lens' CreateRecommenderConfiguration (Maybe Text) Source #

The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:

PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.
PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.

createRecommenderConfiguration_attributes :: Lens' CreateRecommenderConfiguration (Maybe (HashMap Text Text)) Source #

A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.

In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:

An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.
An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).

This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.

createRecommenderConfiguration_name :: Lens' CreateRecommenderConfiguration (Maybe Text) Source #

A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).

createRecommenderConfiguration_description :: Lens' CreateRecommenderConfiguration (Maybe Text) Source #

A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.

createRecommenderConfiguration_recommendationsPerMessage :: Lens' CreateRecommenderConfiguration (Maybe Int) Source #

The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.

To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

createRecommenderConfiguration_recommendationProviderUri :: Lens' CreateRecommenderConfiguration Text Source #

The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign.

createRecommenderConfiguration_recommendationProviderRoleArn :: Lens' CreateRecommenderConfiguration Text Source #

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.

CreateTemplateMessageBody

createTemplateMessageBody_requestID :: Lens' CreateTemplateMessageBody (Maybe Text) Source #

The unique identifier for the request to create the message template.

createTemplateMessageBody_arn :: Lens' CreateTemplateMessageBody (Maybe Text) Source #

The Amazon Resource Name (ARN) of the message template that was created.

createTemplateMessageBody_message :: Lens' CreateTemplateMessageBody (Maybe Text) Source #

The message that's returned from the API for the request to create the message template.

CustomDeliveryConfiguration

customDeliveryConfiguration_endpointTypes :: Lens' CustomDeliveryConfiguration (Maybe [EndpointTypesElement]) Source #

The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

customDeliveryConfiguration_deliveryUri :: Lens' CustomDeliveryConfiguration Text Source #

The destination to send the campaign or treatment to. This value can be one of the following:

The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.

CustomMessageActivity

customMessageActivity_templateName :: Lens' CustomMessageActivity (Maybe Text) Source #

The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.

customMessageActivity_templateVersion :: Lens' CustomMessageActivity (Maybe Text) Source #

The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

customMessageActivity_endpointTypes :: Lens' CustomMessageActivity (Maybe [EndpointTypesElement]) Source #

The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

customMessageActivity_nextActivity :: Lens' CustomMessageActivity (Maybe Text) Source #

The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.

customMessageActivity_deliveryUri :: Lens' CustomMessageActivity (Maybe Text) Source #

The destination to send the campaign or treatment to. This value can be one of the following:

The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.

customMessageActivity_messageConfig :: Lens' CustomMessageActivity (Maybe JourneyCustomMessage) Source #

Specifies the message data included in a custom channel message that's sent to participants in a journey.

DefaultButtonConfiguration

defaultButtonConfiguration_link :: Lens' DefaultButtonConfiguration (Maybe Text) Source #

Button destination.

defaultButtonConfiguration_backgroundColor :: Lens' DefaultButtonConfiguration (Maybe Text) Source #

The background color of the button.

defaultButtonConfiguration_borderRadius :: Lens' DefaultButtonConfiguration (Maybe Int) Source #

The border radius of the button.

defaultButtonConfiguration_textColor :: Lens' DefaultButtonConfiguration (Maybe Text) Source #

The text color of the button.

defaultButtonConfiguration_buttonAction :: Lens' DefaultButtonConfiguration ButtonAction Source #

Action triggered by the button.

defaultButtonConfiguration_text :: Lens' DefaultButtonConfiguration Text Source #

Button text.

DefaultMessage

defaultMessage_substitutions :: Lens' DefaultMessage (Maybe (HashMap Text [Text])) Source #

The default message variables to use in the message. You can override these default variables with individual address variables.

defaultMessage_body :: Lens' DefaultMessage (Maybe Text) Source #

The default body of the message.

DefaultPushNotificationMessage

defaultPushNotificationMessage_substitutions :: Lens' DefaultPushNotificationMessage (Maybe (HashMap Text [Text])) Source #

The default message variables to use in the notification message. You can override the default variables with individual address variables.

defaultPushNotificationMessage_silentPush :: Lens' DefaultPushNotificationMessage (Maybe Bool) Source #

Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center.

defaultPushNotificationMessage_data :: Lens' DefaultPushNotificationMessage (Maybe (HashMap Text Text)) Source #

The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

defaultPushNotificationMessage_body :: Lens' DefaultPushNotificationMessage (Maybe Text) Source #

The default body of the notification message.

defaultPushNotificationMessage_url :: Lens' DefaultPushNotificationMessage (Maybe Text) Source #

The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

defaultPushNotificationMessage_action :: Lens' DefaultPushNotificationMessage (Maybe Action) Source #

The default action to occur if a recipient taps the push notification. Valid values are:

OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

defaultPushNotificationMessage_title :: Lens' DefaultPushNotificationMessage (Maybe Text) Source #

The default title to display above the notification message on a recipient's device.

DefaultPushNotificationTemplate

defaultPushNotificationTemplate_body :: Lens' DefaultPushNotificationTemplate (Maybe Text) Source #

The message body to use in push notifications that are based on the message template.

defaultPushNotificationTemplate_url :: Lens' DefaultPushNotificationTemplate (Maybe Text) Source #

The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.

defaultPushNotificationTemplate_sound :: Lens' DefaultPushNotificationTemplate (Maybe Text) Source #

The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

defaultPushNotificationTemplate_action :: Lens' DefaultPushNotificationTemplate (Maybe Action) Source #

The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

defaultPushNotificationTemplate_title :: Lens' DefaultPushNotificationTemplate (Maybe Text) Source #

The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.

DirectMessageConfiguration

directMessageConfiguration_aPNSMessage :: Lens' DirectMessageConfiguration (Maybe APNSMessage) Source #

The default push notification message for the APNs (Apple Push Notification service) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).

directMessageConfiguration_gCMMessage :: Lens' DirectMessageConfiguration (Maybe GCMMessage) Source #

The default push notification message for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default push notification message (DefaultPushNotificationMessage).

directMessageConfiguration_defaultMessage :: Lens' DirectMessageConfiguration (Maybe DefaultMessage) Source #

The default message for all channels.

directMessageConfiguration_aDMMessage :: Lens' DirectMessageConfiguration (Maybe ADMMessage) Source #

The default push notification message for the ADM (Amazon Device Messaging) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).

directMessageConfiguration_sMSMessage :: Lens' DirectMessageConfiguration (Maybe SMSMessage) Source #

The default message for the SMS channel. This message overrides the default message (DefaultMessage).

directMessageConfiguration_emailMessage :: Lens' DirectMessageConfiguration (Maybe EmailMessage) Source #

The default message for the email channel. This message overrides the default message (DefaultMessage).

directMessageConfiguration_voiceMessage :: Lens' DirectMessageConfiguration (Maybe VoiceMessage) Source #

The default message for the voice channel. This message overrides the default message (DefaultMessage).

directMessageConfiguration_baiduMessage :: Lens' DirectMessageConfiguration (Maybe BaiduMessage) Source #

The default push notification message for the Baidu (Baidu Cloud Push) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).

directMessageConfiguration_defaultPushNotificationMessage :: Lens' DirectMessageConfiguration (Maybe DefaultPushNotificationMessage) Source #

The default push notification message for all push notification channels.

EmailChannelRequest

emailChannelRequest_enabled :: Lens' EmailChannelRequest (Maybe Bool) Source #

Specifies whether to enable the email channel for the application.

emailChannelRequest_configurationSet :: Lens' EmailChannelRequest (Maybe Text) Source #

The Amazon SES configuration set that you want to apply to messages that you send through the channel.

emailChannelRequest_roleArn :: Lens' EmailChannelRequest (Maybe Text) Source #

The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.

emailChannelRequest_fromAddress :: Lens' EmailChannelRequest Text Source #

The verified email address that you want to send email from when you send email through the channel.

emailChannelRequest_identity :: Lens' EmailChannelRequest Text Source #

The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use when you send email through the channel.

EmailChannelResponse

emailChannelResponse_messagesPerSecond :: Lens' EmailChannelResponse (Maybe Int) Source #

The maximum number of emails that can be sent through the channel each second.

emailChannelResponse_lastModifiedDate :: Lens' EmailChannelResponse (Maybe Text) Source #

The date and time, in ISO 8601 format, when the email channel was last modified.

emailChannelResponse_enabled :: Lens' EmailChannelResponse (Maybe Bool) Source #

Specifies whether the email channel is enabled for the application.

emailChannelResponse_fromAddress :: Lens' EmailChannelResponse (Maybe Text) Source #

The verified email address that email is sent from when you send email through the channel.

emailChannelResponse_isArchived :: Lens' EmailChannelResponse (Maybe Bool) Source #

Specifies whether the email channel is archived.

emailChannelResponse_applicationId :: Lens' EmailChannelResponse (Maybe Text) Source #

The unique identifier for the application that the email channel applies to.

emailChannelResponse_version :: Lens' EmailChannelResponse (Maybe Int) Source #

The current version of the email channel.

emailChannelResponse_configurationSet :: Lens' EmailChannelResponse (Maybe Text) Source #

The Amazon SES configuration set that's applied to messages that are sent through the channel.

emailChannelResponse_id :: Lens' EmailChannelResponse (Maybe Text) Source #

(Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.

emailChannelResponse_creationDate :: Lens' EmailChannelResponse (Maybe Text) Source #

The date and time, in ISO 8601 format, when the email channel was enabled.

emailChannelResponse_lastModifiedBy :: Lens' EmailChannelResponse (Maybe Text) Source #

The user who last modified the email channel.

emailChannelResponse_identity :: Lens' EmailChannelResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that's used when you send email through the channel.

emailChannelResponse_hasCredential :: Lens' EmailChannelResponse (Maybe Bool) Source #

(Not used) This property is retained only for backward compatibility.

emailChannelResponse_roleArn :: Lens' EmailChannelResponse (Maybe Text) Source #

The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.

emailChannelResponse_platform :: Lens' EmailChannelResponse Text Source #

The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.

EmailMessage

emailMessage_substitutions :: Lens' EmailMessage (Maybe (HashMap Text [Text])) Source #

The default message variables to use in the email message. You can override the default variables with individual address variables.

emailMessage_body :: Lens' EmailMessage (Maybe Text) Source #

The body of the email message.

emailMessage_fromAddress :: Lens' EmailMessage (Maybe Text) Source #

The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.

emailMessage_rawEmail :: Lens' EmailMessage (Maybe RawEmail) Source #

The email message, represented as a raw MIME message.

emailMessage_feedbackForwardingAddress :: Lens' EmailMessage (Maybe Text) Source #

The email address to forward bounces and complaints to, if feedback forwarding is enabled.

emailMessage_simpleEmail :: Lens' EmailMessage (Maybe SimpleEmail) Source #

The email message, composed of a subject, a text part, and an HTML part.

emailMessage_replyToAddresses :: Lens' EmailMessage (Maybe [Text]) Source #

The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply.

EmailMessageActivity

emailMessageActivity_templateName :: Lens' EmailMessageActivity (Maybe Text) Source #

The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.

emailMessageActivity_templateVersion :: Lens' EmailMessageActivity (Maybe Text) Source #

The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

emailMessageActivity_nextActivity :: Lens' EmailMessageActivity (Maybe Text) Source #

The unique identifier for the next activity to perform, after the message is sent.

emailMessageActivity_messageConfig :: Lens' EmailMessageActivity (Maybe JourneyEmailMessage) Source #

Specifies the sender address for an email message that's sent to participants in the journey.

EmailTemplateRequest

emailTemplateRequest_subject :: Lens' EmailTemplateRequest (Maybe Text) Source #

The subject line, or title, to use in email messages that are based on the message template.

emailTemplateRequest_textPart :: Lens' EmailTemplateRequest (Maybe Text) Source #

The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.

emailTemplateRequest_templateDescription :: Lens' EmailTemplateRequest (Maybe Text) Source #

A custom description of the message template.

emailTemplateRequest_defaultSubstitutions :: Lens' EmailTemplateRequest (Maybe Text) Source #

A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

emailTemplateRequest_htmlPart :: Lens' EmailTemplateRequest (Maybe Text) Source #

The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.

emailTemplateRequest_recommenderId :: Lens' EmailTemplateRequest (Maybe Text) Source #

The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

emailTemplateRequest_tags :: Lens' EmailTemplateRequest (Maybe (HashMap Text Text)) Source #

A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

EmailTemplateResponse

emailTemplateResponse_subject :: Lens' EmailTemplateResponse (Maybe Text) Source #

The subject line, or title, that's used in email messages that are based on the message template.

emailTemplateResponse_textPart :: Lens' EmailTemplateResponse (Maybe Text) Source #

The message body, in plain text format, that's used in email messages that are based on the message template.

emailTemplateResponse_arn :: Lens' EmailTemplateResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the message template.

emailTemplateResponse_templateDescription :: Lens' EmailTemplateResponse (Maybe Text) Source #

The custom description of the message template.

emailTemplateResponse_defaultSubstitutions :: Lens' EmailTemplateResponse (Maybe Text) Source #

The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.

emailTemplateResponse_version :: Lens' EmailTemplateResponse (Maybe Text) Source #

The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.

emailTemplateResponse_htmlPart :: Lens' EmailTemplateResponse (Maybe Text) Source #

The message body, in HTML format, that's used in email messages that are based on the message template.

emailTemplateResponse_recommenderId :: Lens' EmailTemplateResponse (Maybe Text) Source #

The unique identifier for the recommender model that's used by the message template.

emailTemplateResponse_tags :: Lens' EmailTemplateResponse (Maybe (HashMap Text Text)) Source #

A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

emailTemplateResponse_lastModifiedDate :: Lens' EmailTemplateResponse Text Source #

The date, in ISO 8601 format, when the message template was last modified.

emailTemplateResponse_creationDate :: Lens' EmailTemplateResponse Text Source #

The date, in ISO 8601 format, when the message template was created.

emailTemplateResponse_templateName :: Lens' EmailTemplateResponse Text Source #

The name of the message template.

emailTemplateResponse_templateType :: Lens' EmailTemplateResponse TemplateType Source #

The type of channel that the message template is designed for. For an email template, this value is EMAIL.

EndpointBatchItem

endpointBatchItem_requestId :: Lens' EndpointBatchItem (Maybe Text) Source #

The unique identifier for the request to create or update the endpoint.

endpointBatchItem_metrics :: Lens' EndpointBatchItem (Maybe (HashMap Text Double)) Source #

One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

endpointBatchItem_location :: Lens' EndpointBatchItem (Maybe EndpointLocation) Source #

The geographic information for the endpoint.

endpointBatchItem_demographic :: Lens' EndpointBatchItem (Maybe EndpointDemographic) Source #

The demographic information for the endpoint, such as the time zone and platform.

endpointBatchItem_address :: Lens' EndpointBatchItem (Maybe Text) Source #

The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.

endpointBatchItem_effectiveDate :: Lens' EndpointBatchItem (Maybe Text) Source #

The date and time, in ISO 8601 format, when the endpoint was created or updated.

endpointBatchItem_user :: Lens' EndpointBatchItem (Maybe EndpointUser) Source #

One or more custom attributes that describe the user who's associated with the endpoint.

endpointBatchItem_attributes :: Lens' EndpointBatchItem (Maybe (HashMap Text [Text])) Source #

One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.

An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.

endpointBatchItem_endpointStatus :: Lens' EndpointBatchItem (Maybe Text) Source #

Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

endpointBatchItem_optOut :: Lens' EndpointBatchItem (Maybe Text) Source #

Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

endpointBatchItem_id :: Lens' EndpointBatchItem (Maybe Text) Source #

The unique identifier for the endpoint in the context of the batch.

endpointBatchItem_channelType :: Lens' EndpointBatchItem (Maybe ChannelType) Source #

The channel to use when sending messages or push notifications to the endpoint.

EndpointBatchRequest

endpointBatchRequest_item :: Lens' EndpointBatchRequest [EndpointBatchItem] Source #

An array that defines the endpoints to create or update and, for each endpoint, the property values to set or change. An array can contain a maximum of 100 items.

EndpointDemographic

endpointDemographic_platform :: Lens' EndpointDemographic (Maybe Text) Source #

The platform of the endpoint device, such as ios.

endpointDemographic_platformVersion :: Lens' EndpointDemographic (Maybe Text) Source #

The platform version of the endpoint device.

endpointDemographic_locale :: Lens' EndpointDemographic (Maybe Text) Source #

The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.

endpointDemographic_appVersion :: Lens' EndpointDemographic (Maybe Text) Source #

The version of the app that's associated with the endpoint.

endpointDemographic_model :: Lens' EndpointDemographic (Maybe Text) Source #

The model name or number of the endpoint device, such as iPhone or SM-G900F.

endpointDemographic_make :: Lens' EndpointDemographic (Maybe Text) Source #

The manufacturer of the endpoint device, such as apple or samsung.

endpointDemographic_modelVersion :: Lens' EndpointDemographic (Maybe Text) Source #

The model version of the endpoint device.

endpointDemographic_timezone :: Lens' EndpointDemographic (Maybe Text) Source #

The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.

EndpointItemResponse

endpointItemResponse_message :: Lens' EndpointItemResponse (Maybe Text) Source #

The custom message that's returned in the response as a result of processing the endpoint data.

endpointItemResponse_statusCode :: Lens' EndpointItemResponse (Maybe Int) Source #

The status code that's returned in the response as a result of processing the endpoint data.

EndpointLocation

endpointLocation_postalCode :: Lens' EndpointLocation (Maybe Text) Source #

The postal or ZIP code for the area where the endpoint is located.

endpointLocation_latitude :: Lens' EndpointLocation (Maybe Double) Source #

The latitude coordinate of the endpoint location, rounded to one decimal place.

endpointLocation_country :: Lens' EndpointLocation (Maybe Text) Source #

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.

endpointLocation_city :: Lens' EndpointLocation (Maybe Text) Source #

The name of the city where the endpoint is located.

endpointLocation_region :: Lens' EndpointLocation (Maybe Text) Source #

The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.

endpointLocation_longitude :: Lens' EndpointLocation (Maybe Double) Source #

The longitude coordinate of the endpoint location, rounded to one decimal place.

EndpointMessageResult

endpointMessageResult_address :: Lens' EndpointMessageResult (Maybe Text) Source #

The endpoint address that the message was delivered to.

endpointMessageResult_statusMessage :: Lens' EndpointMessageResult (Maybe Text) Source #

The status message for delivering the message.

endpointMessageResult_updatedToken :: Lens' EndpointMessageResult (Maybe Text) Source #

For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.

endpointMessageResult_messageId :: Lens' EndpointMessageResult (Maybe Text) Source #

The unique identifier for the message that was sent.

endpointMessageResult_deliveryStatus :: Lens' EndpointMessageResult DeliveryStatus Source #

The delivery status of the message. Possible values are:

DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
OPT_OUT - The user who's associated with the endpoint has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again.
SUCCESSFUL - The message was successfully delivered to the endpoint.
TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.
THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint.
TIMEOUT - The message couldn't be sent within the timeout period.
UNKNOWN_FAILURE - An unknown error occurred.

endpointMessageResult_statusCode :: Lens' EndpointMessageResult Int Source #

The downstream service status code for delivering the message.

EndpointRequest

endpointRequest_requestId :: Lens' EndpointRequest (Maybe Text) Source #

The unique identifier for the most recent request to update the endpoint.

endpointRequest_metrics :: Lens' EndpointRequest (Maybe (HashMap Text Double)) Source #

One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

endpointRequest_location :: Lens' EndpointRequest (Maybe EndpointLocation) Source #

The geographic information for the endpoint.

endpointRequest_demographic :: Lens' EndpointRequest (Maybe EndpointDemographic) Source #

The demographic information for the endpoint, such as the time zone and platform.

endpointRequest_address :: Lens' EndpointRequest (Maybe Text) Source #

The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.

endpointRequest_effectiveDate :: Lens' EndpointRequest (Maybe Text) Source #

The date and time, in ISO 8601 format, when the endpoint is updated.

endpointRequest_user :: Lens' EndpointRequest (Maybe EndpointUser) Source #

One or more custom attributes that describe the user who's associated with the endpoint.

endpointRequest_attributes :: Lens' EndpointRequest (Maybe (HashMap Text [Text])) Source #

One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.

An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.

endpointRequest_endpointStatus :: Lens' EndpointRequest (Maybe Text) Source #

Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

endpointRequest_optOut :: Lens' EndpointRequest (Maybe Text) Source #

Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

endpointRequest_channelType :: Lens' EndpointRequest (Maybe ChannelType) Source #

The channel to use when sending messages or push notifications to the endpoint.

EndpointResponse

endpointResponse_requestId :: Lens' EndpointResponse (Maybe Text) Source #

The unique identifier for the most recent request to update the endpoint.

endpointResponse_metrics :: Lens' EndpointResponse (Maybe (HashMap Text Double)) Source #

One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

endpointResponse_location :: Lens' EndpointResponse (Maybe EndpointLocation) Source #

The geographic information for the endpoint.

endpointResponse_demographic :: Lens' EndpointResponse (Maybe EndpointDemographic) Source #

The demographic information for the endpoint, such as the time zone and platform.

endpointResponse_cohortId :: Lens' EndpointResponse (Maybe Text) Source #

A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.

endpointResponse_address :: Lens' EndpointResponse (Maybe Text) Source #

The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.

endpointResponse_effectiveDate :: Lens' EndpointResponse (Maybe Text) Source #

The date and time, in ISO 8601 format, when the endpoint was last updated.

endpointResponse_user :: Lens' EndpointResponse (Maybe EndpointUser) Source #

One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

endpointResponse_applicationId :: Lens' EndpointResponse (Maybe Text) Source #

The unique identifier for the application that's associated with the endpoint.

endpointResponse_attributes :: Lens' EndpointResponse (Maybe (HashMap Text [Text])) Source #

One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments.

endpointResponse_endpointStatus :: Lens' EndpointResponse (Maybe Text) Source #

Specifies whether messages or push notifications are sent to the endpoint. Possible values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

endpointResponse_optOut :: Lens' EndpointResponse (Maybe Text) Source #

Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

endpointResponse_id :: Lens' EndpointResponse (Maybe Text) Source #

The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.

endpointResponse_creationDate :: Lens' EndpointResponse (Maybe Text) Source #

The date and time, in ISO 8601 format, when the endpoint was created.

endpointResponse_channelType :: Lens' EndpointResponse (Maybe ChannelType) Source #

The channel that's used when sending messages or push notifications to the endpoint.

EndpointSendConfiguration

endpointSendConfiguration_substitutions :: Lens' EndpointSendConfiguration (Maybe (HashMap Text [Text])) Source #

A map of the message variables to merge with the variables specified for the default message (DefaultMessage.Substitutions). The variables specified in this map take precedence over all other variables.

endpointSendConfiguration_titleOverride :: Lens' EndpointSendConfiguration (Maybe Text) Source #

The title or subject line of the message. If specified, this value overrides the default message title or subject line.

endpointSendConfiguration_context :: Lens' EndpointSendConfiguration (Maybe (HashMap Text Text)) Source #

A map of custom attributes to attach to the message for the address. Attribute names are case sensitive.

For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.

endpointSendConfiguration_rawContent :: Lens' EndpointSendConfiguration (Maybe Text) Source #

The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.

endpointSendConfiguration_bodyOverride :: Lens' EndpointSendConfiguration (Maybe Text) Source #

The body of the message. If specified, this value overrides the default message body.

EndpointUser

endpointUser_userAttributes :: Lens' EndpointUser (Maybe (HashMap Text [Text])) Source #

One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.

An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.

endpointUser_userId :: Lens' EndpointUser (Maybe Text) Source #

The unique identifier for the user.

EndpointsResponse

endpointsResponse_item :: Lens' EndpointsResponse [EndpointResponse] Source #

An array of responses, one for each endpoint that's associated with the user ID.

Event

event_clientSdkVersion :: Lens' Event (Maybe Text) Source #

The version of the SDK that's running on the client device.

event_metrics :: Lens' Event (Maybe (HashMap Text Double)) Source #

One or more custom metrics that are associated with the event.

event_appVersionCode :: Lens' Event (Maybe Text) Source #

The version number of the app that's recording the event.

event_appTitle :: Lens' Event (Maybe Text) Source #

The title of the app that's recording the event.

event_appPackageName :: Lens' Event (Maybe Text) Source #

The package name of the app that's recording the event.

event_attributes :: Lens' Event (Maybe (HashMap Text Text)) Source #

One or more custom attributes that are associated with the event.

event_sdkName :: Lens' Event (Maybe Text) Source #

The name of the SDK that's being used to record the event.

event_session :: Lens' Event (Maybe Session) Source #

Information about the session in which the event occurred.

event_eventType :: Lens' Event Text Source #

The name of the event.

event_timestamp :: Lens' Event Text Source #

The date and time, in ISO 8601 format, when the event occurred.

EventCondition

eventCondition_dimensions :: Lens' EventCondition (Maybe EventDimensions) Source #

The dimensions for the event filter to use for the activity.

eventCondition_messageActivity :: Lens' EventCondition (Maybe Text) Source #

The message identifier (message_id) for the message to use when determining whether message events meet the condition.

EventDimensions

eventDimensions_metrics :: Lens' EventDimensions (Maybe (HashMap Text MetricDimension)) Source #

One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

eventDimensions_eventType :: Lens' EventDimensions (Maybe SetDimension) Source #

The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide.

eventDimensions_attributes :: Lens' EventDimensions (Maybe (HashMap Text AttributeDimension)) Source #

One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

EventFilter

eventFilter_filterType :: Lens' EventFilter FilterType Source #

The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.

eventFilter_dimensions :: Lens' EventFilter EventDimensions Source #

The dimensions for the event filter to use for the campaign or the journey activity.

EventItemResponse

eventItemResponse_message :: Lens' EventItemResponse (Maybe Text) Source #

A custom message that's returned in the response as a result of processing the event.

eventItemResponse_statusCode :: Lens' EventItemResponse (Maybe Int) Source #

The status code that's returned in the response as a result of processing the event. Possible values are: 202, for events that were accepted; and, 400, for events that weren't valid.

EventStartCondition

eventStartCondition_eventFilter :: Lens' EventStartCondition (Maybe EventFilter) Source #

Undocumented member.

eventStartCondition_segmentId :: Lens' EventStartCondition (Maybe Text) Source #

Undocumented member.

EventStream

eventStream_lastUpdatedBy :: Lens' EventStream (Maybe Text) Source #

The IAM user who last modified the event stream.

eventStream_lastModifiedDate :: Lens' EventStream (Maybe Text) Source #

The date, in ISO 8601 format, when the event stream was last modified.

eventStream_externalId :: Lens' EventStream (Maybe Text) Source #

(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

eventStream_applicationId :: Lens' EventStream Text Source #

The unique identifier for the application to publish event data for.

eventStream_roleArn :: Lens' EventStream Text Source #

The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.

eventStream_destinationStreamArn :: Lens' EventStream Text Source #

The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream to publish event data to.

For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name

For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name

EventsBatch

eventsBatch_endpoint :: Lens' EventsBatch PublicEndpoint Source #

A set of properties and attributes that are associated with the endpoint.

eventsBatch_events :: Lens' EventsBatch (HashMap Text Event) Source #

A set of properties that are associated with the event.

EventsRequest

eventsRequest_batchItem :: Lens' EventsRequest (HashMap Text EventsBatch) Source #

The batch of events to process. For each item in a batch, the endpoint ID acts as a key that has an EventsBatch object as its value.

EventsResponse

eventsResponse_results :: Lens' EventsResponse (Maybe (HashMap Text ItemResponse)) Source #

A map that contains a multipart response for each endpoint. For each item in this object, the endpoint ID is the key and the item response is the value. If no item response exists, the value can also be one of the following: 202, the request was processed successfully; or 400, the payload wasn't valid or required fields were missing.

ExportJobRequest

exportJobRequest_segmentId :: Lens' ExportJobRequest (Maybe Text) Source #

The identifier for the segment to export endpoint definitions from. If you don't specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with the application.

exportJobRequest_segmentVersion :: Lens' ExportJobRequest (Maybe Int) Source #

The version of the segment to export endpoint definitions from, if specified.

exportJobRequest_s3UrlPrefix :: Lens' ExportJobRequest Text Source #

The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where you want to export endpoint definitions to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

exportJobRequest_roleArn :: Lens' ExportJobRequest Text Source #

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to.

ExportJobResource

exportJobResource_segmentId :: Lens' ExportJobResource (Maybe Text) Source #

The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.

exportJobResource_segmentVersion :: Lens' ExportJobResource (Maybe Int) Source #

The version of the segment that the endpoint definitions were exported from.

exportJobResource_s3UrlPrefix :: Lens' ExportJobResource Text Source #

The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

exportJobResource_roleArn :: Lens' ExportJobResource Text Source #

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location where the endpoint definitions were exported to.

ExportJobResponse

exportJobResponse_completedPieces :: Lens' ExportJobResponse (Maybe Int) Source #

The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.

exportJobResponse_failedPieces :: Lens' ExportJobResponse (Maybe Int) Source #

The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.

exportJobResponse_totalProcessed :: Lens' ExportJobResponse (Maybe Int) Source #

The total number of endpoint definitions that were processed by the export job.

exportJobResponse_failures :: Lens' ExportJobResponse (Maybe [Text]) Source #

An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.

exportJobResponse_totalPieces :: Lens' ExportJobResponse (Maybe Int) Source #

The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.

exportJobResponse_completionDate :: Lens' ExportJobResponse (Maybe Text) Source #

The date, in ISO 8601 format, when the export job was completed.

exportJobResponse_totalFailures :: Lens' ExportJobResponse (Maybe Int) Source #

The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.

exportJobResponse_jobStatus :: Lens' ExportJobResponse JobStatus Source #

The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.

exportJobResponse_creationDate :: Lens' ExportJobResponse Text Source #

The date, in ISO 8601 format, when the export job was created.

exportJobResponse_type :: Lens' ExportJobResponse Text Source #

The job type. This value is EXPORT for export jobs.

exportJobResponse_definition :: Lens' ExportJobResponse ExportJobResource Source #

The resource settings that apply to the export job.

exportJobResponse_id :: Lens' ExportJobResponse Text Source #

The unique identifier for the export job.

exportJobResponse_applicationId :: Lens' ExportJobResponse Text Source #

The unique identifier for the application that's associated with the export job.

ExportJobsResponse

exportJobsResponse_nextToken :: Lens' ExportJobsResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

exportJobsResponse_item :: Lens' ExportJobsResponse [ExportJobResponse] Source #

An array of responses, one for each export job that's associated with the application (Export Jobs resource) or segment (Segment Export Jobs resource).

GCMChannelRequest

gCMChannelRequest_enabled :: Lens' GCMChannelRequest (Maybe Bool) Source #

Specifies whether to enable the GCM channel for the application.

gCMChannelRequest_apiKey :: Lens' GCMChannelRequest Text Source #

The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.

GCMChannelResponse

gCMChannelResponse_lastModifiedDate :: Lens' GCMChannelResponse (Maybe Text) Source #

The date and time when the GCM channel was last modified.

gCMChannelResponse_enabled :: Lens' GCMChannelResponse (Maybe Bool) Source #

Specifies whether the GCM channel is enabled for the application.

gCMChannelResponse_isArchived :: Lens' GCMChannelResponse (Maybe Bool) Source #

Specifies whether the GCM channel is archived.

gCMChannelResponse_applicationId :: Lens' GCMChannelResponse (Maybe Text) Source #

The unique identifier for the application that the GCM channel applies to.

gCMChannelResponse_version :: Lens' GCMChannelResponse (Maybe Int) Source #

The current version of the GCM channel.

gCMChannelResponse_id :: Lens' GCMChannelResponse (Maybe Text) Source #

(Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility.

gCMChannelResponse_creationDate :: Lens' GCMChannelResponse (Maybe Text) Source #

The date and time when the GCM channel was enabled.

gCMChannelResponse_lastModifiedBy :: Lens' GCMChannelResponse (Maybe Text) Source #

The user who last modified the GCM channel.

gCMChannelResponse_hasCredential :: Lens' GCMChannelResponse (Maybe Bool) Source #

(Not used) This property is retained only for backward compatibility.

gCMChannelResponse_credential :: Lens' GCMChannelResponse Text Source #

The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.

gCMChannelResponse_platform :: Lens' GCMChannelResponse Text Source #

The type of messaging or notification platform for the channel. For the GCM channel, this value is GCM.

GCMMessage

gCMMessage_substitutions :: Lens' GCMMessage (Maybe (HashMap Text [Text])) Source #

The default message variables to use in the notification message. You can override the default variables with individual address variables.

gCMMessage_silentPush :: Lens' GCMMessage (Maybe Bool) Source #

Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.

gCMMessage_imageIconUrl :: Lens' GCMMessage (Maybe Text) Source #

The URL of the large icon image to display in the content view of the push notification.

gCMMessage_priority :: Lens' GCMMessage (Maybe Text) Source #

para>normal - The notification might be delayed. Delivery is optimized for battery usage on the recipient's device. Use this value unless immediate delivery is required.

/listitem>

high - The notification is sent immediately and might wake a sleeping device.

/para>

Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM.

The equivalent values for Apple Push Notification service (APNs) are 5, for normal, and 10, for high. If you specify an APNs value for this property, Amazon Pinpoint accepts and converts the value to the corresponding FCM value.

gCMMessage_rawContent :: Lens' GCMMessage (Maybe Text) Source #

The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

gCMMessage_data :: Lens' GCMMessage (Maybe (HashMap Text Text)) Source #

The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

gCMMessage_restrictedPackageName :: Lens' GCMMessage (Maybe Text) Source #

The package name of the application where registration tokens must match in order for the recipient to receive the message.

gCMMessage_smallImageIconUrl :: Lens' GCMMessage (Maybe Text) Source #

The URL of the small icon image to display in the status bar and the content view of the push notification.

gCMMessage_body :: Lens' GCMMessage (Maybe Text) Source #

The body of the notification message.

gCMMessage_timeToLive :: Lens' GCMMessage (Maybe Int) Source #

The amount of time, in seconds, that FCM should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If you don't specify this value, FCM defaults to the maximum value, which is 2,419,200 seconds (28 days).

Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM.

gCMMessage_url :: Lens' GCMMessage (Maybe Text) Source #

The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

gCMMessage_sound :: Lens' GCMMessage (Maybe Text) Source #

The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

gCMMessage_action :: Lens' GCMMessage (Maybe Action) Source #

The action to occur if the recipient taps the push notification. Valid values are:

OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

gCMMessage_collapseKey :: Lens' GCMMessage (Maybe Text) Source #

An arbitrary string that identifies a group of messages that can be collapsed to ensure that only the last message is sent when delivery can resume. This helps avoid sending too many instances of the same messages when the recipient's device comes online again or becomes active.

Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) collapse_key parameter when it sends the notification message to FCM.

gCMMessage_imageUrl :: Lens' GCMMessage (Maybe Text) Source #

The URL of an image to display in the push notification.

gCMMessage_title :: Lens' GCMMessage (Maybe Text) Source #

The title to display above the notification message on the recipient's device.

gCMMessage_iconReference :: Lens' GCMMessage (Maybe Text) Source #

The icon image name of the asset saved in your app.

GPSCoordinates

gPSCoordinates_latitude :: Lens' GPSCoordinates Double Source #

The latitude coordinate of the location.

gPSCoordinates_longitude :: Lens' GPSCoordinates Double Source #

The longitude coordinate of the location.

GPSPointDimension

gPSPointDimension_rangeInKilometers :: Lens' GPSPointDimension (Maybe Double) Source #

The range, in kilometers, from the GPS coordinates.

gPSPointDimension_coordinates :: Lens' GPSPointDimension GPSCoordinates Source #

The GPS coordinates to measure distance from.

HoldoutActivity

holdoutActivity_nextActivity :: Lens' HoldoutActivity (Maybe Text) Source #

The unique identifier for the next activity to perform, after performing the holdout activity.

holdoutActivity_percentage :: Lens' HoldoutActivity Int Source #

The percentage of participants who shouldn't continue the journey.

To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.

ImportJobRequest

importJobRequest_segmentName :: Lens' ImportJobRequest (Maybe Text) Source #

A custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.

importJobRequest_defineSegment :: Lens' ImportJobRequest (Maybe Bool) Source #

Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.

importJobRequest_registerEndpoints :: Lens' ImportJobRequest (Maybe Bool) Source #

Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.

importJobRequest_externalId :: Lens' ImportJobRequest (Maybe Text) Source #

(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

importJobRequest_segmentId :: Lens' ImportJobRequest (Maybe Text) Source #

The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment.

importJobRequest_format :: Lens' ImportJobRequest DefinitionFormat Source #

The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.

importJobRequest_s3Url :: Lens' ImportJobRequest Text Source #

The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.

The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.

importJobRequest_roleArn :: Lens' ImportJobRequest Text Source #

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

ImportJobResource

importJobResource_segmentName :: Lens' ImportJobResource (Maybe Text) Source #

The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.

importJobResource_defineSegment :: Lens' ImportJobResource (Maybe Bool) Source #

Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.

importJobResource_registerEndpoints :: Lens' ImportJobResource (Maybe Bool) Source #

Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.

importJobResource_externalId :: Lens' ImportJobResource (Maybe Text) Source #

(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

importJobResource_segmentId :: Lens' ImportJobResource (Maybe Text) Source #

The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.

importJobResource_format :: Lens' ImportJobResource DefinitionFormat Source #

The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.

If the files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.

importJobResource_s3Url :: Lens' ImportJobResource Text Source #

The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.

The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.

importJobResource_roleArn :: Lens' ImportJobResource Text Source #

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

ImportJobResponse

importJobResponse_completedPieces :: Lens' ImportJobResponse (Maybe Int) Source #

The number of pieces that were processed successfully (completed) by the import job, as of the time of the request.

importJobResponse_failedPieces :: Lens' ImportJobResponse (Maybe Int) Source #

The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the request.

importJobResponse_totalProcessed :: Lens' ImportJobResponse (Maybe Int) Source #

The total number of endpoint definitions that were processed by the import job.

importJobResponse_failures :: Lens' ImportJobResponse (Maybe [Text]) Source #

An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the import job, if any.

importJobResponse_totalPieces :: Lens' ImportJobResponse (Maybe Int) Source #

The total number of pieces that must be processed to complete the import job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the import job.

importJobResponse_completionDate :: Lens' ImportJobResponse (Maybe Text) Source #

The date, in ISO 8601 format, when the import job was completed.

importJobResponse_totalFailures :: Lens' ImportJobResponse (Maybe Int) Source #

The total number of endpoint definitions that weren't processed successfully (failed) by the import job, typically because an error, such as a syntax error, occurred.

importJobResponse_jobStatus :: Lens' ImportJobResponse JobStatus Source #

The status of the import job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.

importJobResponse_creationDate :: Lens' ImportJobResponse Text Source #

The date, in ISO 8601 format, when the import job was created.

importJobResponse_type :: Lens' ImportJobResponse Text Source #

The job type. This value is IMPORT for import jobs.

importJobResponse_definition :: Lens' ImportJobResponse ImportJobResource Source #

The resource settings that apply to the import job.

importJobResponse_id :: Lens' ImportJobResponse Text Source #

The unique identifier for the import job.

importJobResponse_applicationId :: Lens' ImportJobResponse Text Source #

The unique identifier for the application that's associated with the import job.

ImportJobsResponse

importJobsResponse_nextToken :: Lens' ImportJobsResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

importJobsResponse_item :: Lens' ImportJobsResponse [ImportJobResponse] Source #

An array of responses, one for each import job that's associated with the application (Import Jobs resource) or segment (Segment Import Jobs resource).

InAppCampaignSchedule

inAppCampaignSchedule_endDate :: Lens' InAppCampaignSchedule (Maybe Text) Source #

The scheduled time after which the in-app message should not be shown. Timestamp is in ISO 8601 format.

inAppCampaignSchedule_quietTime :: Lens' InAppCampaignSchedule (Maybe QuietTime) Source #

Time during which the in-app message should not be shown to the user.

inAppCampaignSchedule_eventFilter :: Lens' InAppCampaignSchedule (Maybe CampaignEventFilter) Source #

The event filter the SDK has to use to show the in-app message in the application.

InAppMessage

inAppMessage_layout :: Lens' InAppMessage (Maybe Layout) Source #

The layout of the message.

inAppMessage_content :: Lens' InAppMessage (Maybe [InAppMessageContent]) Source #

In-app message content.

inAppMessage_customConfig :: Lens' InAppMessage (Maybe (HashMap Text Text)) Source #

Custom config to be sent to SDK.

InAppMessageBodyConfig

inAppMessageBodyConfig_alignment :: Lens' InAppMessageBodyConfig Alignment Source #

The alignment of the text. Valid values: LEFT, CENTER, RIGHT.

inAppMessageBodyConfig_textColor :: Lens' InAppMessageBodyConfig Text Source #

The text color.

inAppMessageBodyConfig_body :: Lens' InAppMessageBodyConfig Text Source #

Message Body.

InAppMessageButton

inAppMessageButton_ios :: Lens' InAppMessageButton (Maybe OverrideButtonConfiguration) Source #

Default button content.

inAppMessageButton_defaultConfig :: Lens' InAppMessageButton (Maybe DefaultButtonConfiguration) Source #

Default button content.

inAppMessageButton_web :: Lens' InAppMessageButton (Maybe OverrideButtonConfiguration) Source #

Default button content.

inAppMessageButton_android :: Lens' InAppMessageButton (Maybe OverrideButtonConfiguration) Source #

Default button content.

InAppMessageCampaign

inAppMessageCampaign_sessionCap :: Lens' InAppMessageCampaign (Maybe Int) Source #

Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.

inAppMessageCampaign_priority :: Lens' InAppMessageCampaign (Maybe Int) Source #

Priority of the in-app message.

inAppMessageCampaign_schedule :: Lens' InAppMessageCampaign (Maybe InAppCampaignSchedule) Source #

Schedule of the campaign.

inAppMessageCampaign_campaignId :: Lens' InAppMessageCampaign (Maybe Text) Source #

Campaign id of the corresponding campaign.

inAppMessageCampaign_treatmentId :: Lens' InAppMessageCampaign (Maybe Text) Source #

Treatment id of the campaign.

inAppMessageCampaign_inAppMessage :: Lens' InAppMessageCampaign (Maybe InAppMessage) Source #

In-app message content with all fields required for rendering an in-app message.

inAppMessageCampaign_totalCap :: Lens' InAppMessageCampaign (Maybe Int) Source #

Total cap which controls the number of times an in-app message can be shown to the endpoint.

inAppMessageCampaign_dailyCap :: Lens' InAppMessageCampaign (Maybe Int) Source #

Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.

InAppMessageContent

inAppMessageContent_primaryBtn :: Lens' InAppMessageContent (Maybe InAppMessageButton) Source #

The first button inside the message.

inAppMessageContent_bodyConfig :: Lens' InAppMessageContent (Maybe InAppMessageBodyConfig) Source #

The configuration for the message body.

inAppMessageContent_backgroundColor :: Lens' InAppMessageContent (Maybe Text) Source #

The background color for the message.

inAppMessageContent_imageUrl :: Lens' InAppMessageContent (Maybe Text) Source #

The image url for the background of message.

inAppMessageContent_secondaryBtn :: Lens' InAppMessageContent (Maybe InAppMessageButton) Source #

The second button inside message.

inAppMessageContent_headerConfig :: Lens' InAppMessageContent (Maybe InAppMessageHeaderConfig) Source #

The configuration for the message header.

InAppMessageHeaderConfig

inAppMessageHeaderConfig_alignment :: Lens' InAppMessageHeaderConfig Alignment Source #

The alignment of the text. Valid values: LEFT, CENTER, RIGHT.

inAppMessageHeaderConfig_header :: Lens' InAppMessageHeaderConfig Text Source #

Message Header.

inAppMessageHeaderConfig_textColor :: Lens' InAppMessageHeaderConfig Text Source #

The text color.

InAppMessagesResponse

inAppMessagesResponse_inAppMessageCampaigns :: Lens' InAppMessagesResponse (Maybe [InAppMessageCampaign]) Source #

List of targeted in-app message campaigns.

InAppTemplateRequest

inAppTemplateRequest_layout :: Lens' InAppTemplateRequest (Maybe Layout) Source #

The layout of the message.

inAppTemplateRequest_templateDescription :: Lens' InAppTemplateRequest (Maybe Text) Source #

The description of the template.

inAppTemplateRequest_content :: Lens' InAppTemplateRequest (Maybe [InAppMessageContent]) Source #

The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.

inAppTemplateRequest_customConfig :: Lens' InAppTemplateRequest (Maybe (HashMap Text Text)) Source #

Custom config to be sent to client.

inAppTemplateRequest_tags :: Lens' InAppTemplateRequest (Maybe (HashMap Text Text)) Source #

A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

InAppTemplateResponse

inAppTemplateResponse_layout :: Lens' InAppTemplateResponse (Maybe Layout) Source #

The layout of the message.

inAppTemplateResponse_arn :: Lens' InAppTemplateResponse (Maybe Text) Source #

The resource arn of the template.

inAppTemplateResponse_templateDescription :: Lens' InAppTemplateResponse (Maybe Text) Source #

The description of the template.

inAppTemplateResponse_content :: Lens' InAppTemplateResponse (Maybe [InAppMessageContent]) Source #

The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.

inAppTemplateResponse_customConfig :: Lens' InAppTemplateResponse (Maybe (HashMap Text Text)) Source #

Custom config to be sent to client.

inAppTemplateResponse_version :: Lens' InAppTemplateResponse (Maybe Text) Source #

The version id of the template.

inAppTemplateResponse_tags :: Lens' InAppTemplateResponse (Maybe (HashMap Text Text)) Source #

A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

inAppTemplateResponse_lastModifiedDate :: Lens' InAppTemplateResponse Text Source #

The last modified date of the template.

inAppTemplateResponse_creationDate :: Lens' InAppTemplateResponse Text Source #

The creation date of the template.

inAppTemplateResponse_templateName :: Lens' InAppTemplateResponse Text Source #

The name of the template.

inAppTemplateResponse_templateType :: Lens' InAppTemplateResponse TemplateType Source #

The type of the template.

ItemResponse

itemResponse_endpointItemResponse :: Lens' ItemResponse (Maybe EndpointItemResponse) Source #

The response that was received after the endpoint data was accepted.

itemResponse_eventsItemResponse :: Lens' ItemResponse (Maybe (HashMap Text EventItemResponse)) Source #

A multipart response object that contains a key and a value for each event in the request. In each object, the event ID is the key and an EventItemResponse object is the value.

JourneyChannelSettings

journeyChannelSettings_connectCampaignArn :: Lens' JourneyChannelSettings (Maybe Text) Source #

Amazon Resource Name (ARN) of the Connect Campaign.

journeyChannelSettings_connectCampaignExecutionRoleArn :: Lens' JourneyChannelSettings (Maybe Text) Source #

IAM role ARN to be assumed when invoking Connect campaign execution APIs for dialing.

JourneyCustomMessage

journeyCustomMessage_data :: Lens' JourneyCustomMessage (Maybe Text) Source #

The message content that's passed to an AWS Lambda function or to a web hook.

JourneyDateRangeKpiResponse

journeyDateRangeKpiResponse_nextToken :: Lens' JourneyDateRangeKpiResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Journey Engagement Metrics resource because the resource returns all results in a single page.

journeyDateRangeKpiResponse_kpiResult :: Lens' JourneyDateRangeKpiResponse BaseKpiResult Source #

An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

journeyDateRangeKpiResponse_kpiName :: Lens' JourneyDateRangeKpiResponse Text Source #

The name of the metric, also referred to as a /key performance indicator (KPI)/, that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.

journeyDateRangeKpiResponse_journeyId :: Lens' JourneyDateRangeKpiResponse Text Source #

The unique identifier for the journey that the metric applies to.

journeyDateRangeKpiResponse_endTime :: Lens' JourneyDateRangeKpiResponse UTCTime Source #

The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

journeyDateRangeKpiResponse_startTime :: Lens' JourneyDateRangeKpiResponse UTCTime Source #

The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

journeyDateRangeKpiResponse_applicationId :: Lens' JourneyDateRangeKpiResponse Text Source #

The unique identifier for the application that the metric applies to.

JourneyEmailMessage

journeyEmailMessage_fromAddress :: Lens' JourneyEmailMessage (Maybe Text) Source #

The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.

JourneyExecutionActivityMetricsResponse

journeyExecutionActivityMetricsResponse_metrics :: Lens' JourneyExecutionActivityMetricsResponse (HashMap Text Text) Source #

A JSON object that contains the results of the query. The results vary depending on the type of activity (ActivityType). For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.

journeyExecutionActivityMetricsResponse_journeyId :: Lens' JourneyExecutionActivityMetricsResponse Text Source #

The unique identifier for the journey that the metric applies to.

journeyExecutionActivityMetricsResponse_lastEvaluatedTime :: Lens' JourneyExecutionActivityMetricsResponse Text Source #

The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity and updated the data for the metric.

journeyExecutionActivityMetricsResponse_journeyActivityId :: Lens' JourneyExecutionActivityMetricsResponse Text Source #

The unique identifier for the activity that the metric applies to.

journeyExecutionActivityMetricsResponse_activityType :: Lens' JourneyExecutionActivityMetricsResponse Text Source #

The type of activity that the metric applies to. Possible values are:

CONDITIONAL_SPLIT - For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey.
HOLDOUT - For a holdout activity, which is an activity that stops a journey for a specified percentage of participants.
MESSAGE - For an email activity, which is an activity that sends an email message to participants.
MULTI_CONDITIONAL_SPLIT - For a multivariate split activity, which is an activity that sends participants down one of as many as five paths in a journey.
RANDOM_SPLIT - For a random split activity, which is an activity that sends specified percentages of participants down one of as many as five paths in a journey.
WAIT - For a wait activity, which is an activity that waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

journeyExecutionActivityMetricsResponse_applicationId :: Lens' JourneyExecutionActivityMetricsResponse Text Source #

The unique identifier for the application that the metric applies to.

JourneyExecutionMetricsResponse

journeyExecutionMetricsResponse_metrics :: Lens' JourneyExecutionMetricsResponse (HashMap Text Text) Source #

A JSON object that contains the results of the query. For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.

journeyExecutionMetricsResponse_journeyId :: Lens' JourneyExecutionMetricsResponse Text Source #

The unique identifier for the journey that the metric applies to.

journeyExecutionMetricsResponse_lastEvaluatedTime :: Lens' JourneyExecutionMetricsResponse Text Source #

The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey and updated the data for the metric.

journeyExecutionMetricsResponse_applicationId :: Lens' JourneyExecutionMetricsResponse Text Source #

The unique identifier for the application that the metric applies to.

JourneyLimits

journeyLimits_messagesPerSecond :: Lens' JourneyLimits (Maybe Int) Source #

The maximum number of messages that the journey can send each second.

journeyLimits_endpointReentryCap :: Lens' JourneyLimits (Maybe Int) Source #

The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.

journeyLimits_endpointReentryInterval :: Lens' JourneyLimits (Maybe Text) Source #

Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601 format, such as PT1H.

journeyLimits_dailyCap :: Lens' JourneyLimits (Maybe Int) Source #

The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.

JourneyPushMessage

journeyPushMessage_timeToLive :: Lens' JourneyPushMessage (Maybe Text) Source #

The number of seconds that the push notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

JourneyResponse

journeyResponse_state :: Lens' JourneyResponse (Maybe State) Source #

The current status of the journey. Possible values are:

DRAFT - The journey is being developed and hasn't been published yet.
ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.
COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.
CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.
CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may continue the journey.

journeyResponse_lastModifiedDate :: Lens' JourneyResponse (Maybe Text) Source #

The date, in ISO 8601 format, when the journey was last modified.

journeyResponse_schedule :: Lens' JourneyResponse (Maybe JourneySchedule) Source #

The schedule settings for the journey.

journeyResponse_localTime :: Lens' JourneyResponse (Maybe Bool) Source #

Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.

journeyResponse_activities :: Lens' JourneyResponse (Maybe (HashMap Text Activity)) Source #

A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity.

journeyResponse_refreshOnSegmentUpdate :: Lens' JourneyResponse (Maybe Bool) Source #

Specifies whether a journey should be refreshed on segment update.

journeyResponse_limits :: Lens' JourneyResponse (Maybe JourneyLimits) Source #

The messaging and entry limits for the journey.

journeyResponse_waitForQuietTime :: Lens' JourneyResponse (Maybe Bool) Source #

Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.

journeyResponse_quietTime :: Lens' JourneyResponse (Maybe QuietTime) Source #

The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:

The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.

If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.

journeyResponse_startActivity :: Lens' JourneyResponse (Maybe Text) Source #

The unique identifier for the first activity in the journey.

journeyResponse_creationDate :: Lens' JourneyResponse (Maybe Text) Source #

The date, in ISO 8601 format, when the journey was created.

journeyResponse_startCondition :: Lens' JourneyResponse (Maybe StartCondition) Source #

The segment that defines which users are participants in the journey.

journeyResponse_journeyChannelSettings :: Lens' JourneyResponse (Maybe JourneyChannelSettings) Source #

The channel-specific configurations for the journey.

journeyResponse_refreshFrequency :: Lens' JourneyResponse (Maybe Text) Source #

The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

journeyResponse_tags :: Lens' JourneyResponse (Maybe (HashMap Text Text)) Source #

This object is not used or supported.

journeyResponse_name :: Lens' JourneyResponse Text Source #

The name of the journey.

journeyResponse_id :: Lens' JourneyResponse Text Source #

The unique identifier for the journey.

journeyResponse_applicationId :: Lens' JourneyResponse Text Source #

The unique identifier for the application that the journey applies to.

JourneySMSMessage

journeySMSMessage_originationNumber :: Lens' JourneySMSMessage (Maybe Text) Source #

The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.

journeySMSMessage_templateId :: Lens' JourneySMSMessage (Maybe Text) Source #

The template ID received from the regulatory body for sending SMS in your country.

journeySMSMessage_messageType :: Lens' JourneySMSMessage (Maybe MessageType) Source #

The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

journeySMSMessage_senderId :: Lens' JourneySMSMessage (Maybe Text) Source #

The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.

journeySMSMessage_entityId :: Lens' JourneySMSMessage (Maybe Text) Source #

The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

JourneySchedule

journeySchedule_startTime :: Lens' JourneySchedule (Maybe UTCTime) Source #

The scheduled time, in ISO 8601 format, when the journey began or will begin.

journeySchedule_endTime :: Lens' JourneySchedule (Maybe UTCTime) Source #

The scheduled time, in ISO 8601 format, when the journey ended or will end.

journeySchedule_timezone :: Lens' JourneySchedule (Maybe Text) Source #

The starting UTC offset for the journey schedule, if the value of the journey's LocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.

JourneyStateRequest

journeyStateRequest_state :: Lens' JourneyStateRequest (Maybe State) Source #

The status of the journey. Currently, Supported values are ACTIVE, PAUSED, and CANCELLED

If you cancel a journey, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Amazon Pinpoint also continues to collect and aggregate analytics data for those activities, until they are complete, and any activities that were complete when you cancelled the journey.

After you cancel a journey, you can't add, change, or remove any activities from the journey. In addition, Amazon Pinpoint stops evaluating the journey and doesn't perform any activities that haven't started.

When the journey is paused, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Endpoints will stop entering journeys when the journey is paused and will resume entering the journey after the journey is resumed. For wait activities, wait time is paused when the journey is paused. Currently, PAUSED only supports journeys with a segment refresh interval.

JourneysResponse

journeysResponse_nextToken :: Lens' JourneysResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

journeysResponse_item :: Lens' JourneysResponse [JourneyResponse] Source #

An array of responses, one for each journey that's associated with the application.

ListRecommenderConfigurationsResponse

listRecommenderConfigurationsResponse_nextToken :: Lens' ListRecommenderConfigurationsResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

listRecommenderConfigurationsResponse_item :: Lens' ListRecommenderConfigurationsResponse [RecommenderConfigurationResponse] Source #

An array of responses, one for each recommender model configuration that's associated with your Amazon Pinpoint account.

Message

message_silentPush :: Lens' Message (Maybe Bool) Source #

Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

message_imageIconUrl :: Lens' Message (Maybe Text) Source #

The URL of the image to display as the push-notification icon, such as the icon for the app.

message_rawContent :: Lens' Message (Maybe Text) Source #

The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

message_body :: Lens' Message (Maybe Text) Source #

The body of the notification message. The maximum number of characters is 200.

message_timeToLive :: Lens' Message (Maybe Int) Source #

The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

message_imageSmallIconUrl :: Lens' Message (Maybe Text) Source #

The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

message_jsonBody :: Lens' Message (Maybe Text) Source #

The JSON payload to use for a silent push notification.

message_url :: Lens' Message (Maybe Text) Source #

The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

message_action :: Lens' Message (Maybe Action) Source #

The action to occur if a recipient taps the push notification. Valid values are:

OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

message_imageUrl :: Lens' Message (Maybe Text) Source #

The URL of an image to display in the push notification.

message_mediaUrl :: Lens' Message (Maybe Text) Source #

The URL of the image or video to display in the push notification.

message_title :: Lens' Message (Maybe Text) Source #

The title to display above the notification message on a recipient's device.

MessageBody

messageBody_requestID :: Lens' MessageBody (Maybe Text) Source #

The unique identifier for the request or response.

messageBody_message :: Lens' MessageBody (Maybe Text) Source #

The message that's returned from the API.

MessageConfiguration

messageConfiguration_aPNSMessage :: Lens' MessageConfiguration (Maybe Message) Source #

The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.

messageConfiguration_gCMMessage :: Lens' MessageConfiguration (Maybe Message) Source #

The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.

messageConfiguration_defaultMessage :: Lens' MessageConfiguration (Maybe Message) Source #

The default message that the campaign sends through all the channels that are configured for the campaign.

messageConfiguration_customMessage :: Lens' MessageConfiguration (Maybe CampaignCustomMessage) Source #

The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.

messageConfiguration_aDMMessage :: Lens' MessageConfiguration (Maybe Message) Source #

The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.

messageConfiguration_sMSMessage :: Lens' MessageConfiguration (Maybe CampaignSmsMessage) Source #

The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.

messageConfiguration_emailMessage :: Lens' MessageConfiguration (Maybe CampaignEmailMessage) Source #

The message that the campaign sends through the email channel. If specified, this message overrides the default message.

messageConfiguration_inAppMessage :: Lens' MessageConfiguration (Maybe CampaignInAppMessage) Source #

The in-app message configuration.

messageConfiguration_baiduMessage :: Lens' MessageConfiguration (Maybe Message) Source #

The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.

MessageRequest

messageRequest_traceId :: Lens' MessageRequest (Maybe Text) Source #

The unique identifier for tracing the message. This identifier is visible to message recipients.

messageRequest_context :: Lens' MessageRequest (Maybe (HashMap Text Text)) Source #

A map of custom attributes to attach to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.

messageRequest_addresses :: Lens' MessageRequest (Maybe (HashMap Text AddressConfiguration)) Source #

A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address. You can use an AddressConfiguration object to tailor the message for an address by specifying settings such as content overrides and message variables.

messageRequest_templateConfiguration :: Lens' MessageRequest (Maybe TemplateConfiguration) Source #

The message template to use for the message.

messageRequest_endpoints :: Lens' MessageRequest (Maybe (HashMap Text EndpointSendConfiguration)) Source #

A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. You can use an EndpointSendConfiguration object to tailor the message for an endpoint by specifying settings such as content overrides and message variables.

messageRequest_messageConfiguration :: Lens' MessageRequest DirectMessageConfiguration Source #

The settings and content for the default message and any default messages that you defined for specific channels.

MessageResponse

messageResponse_requestId :: Lens' MessageResponse (Maybe Text) Source #

The identifier for the original request that the message was delivered for.

messageResponse_result :: Lens' MessageResponse (Maybe (HashMap Text MessageResult)) Source #

A map that contains a multipart response for each address (email address, phone number, or push notification token) that the message was sent to. In the map, the address is the key and the result is the value.

messageResponse_endpointResult :: Lens' MessageResponse (Maybe (HashMap Text EndpointMessageResult)) Source #

A map that contains a multipart response for each address that the message was sent to. In the map, the endpoint ID is the key and the result is the value.

messageResponse_applicationId :: Lens' MessageResponse Text Source #

The unique identifier for the application that was used to send the message.

MessageResult

messageResult_statusMessage :: Lens' MessageResult (Maybe Text) Source #

The status message for delivering the message.

messageResult_updatedToken :: Lens' MessageResult (Maybe Text) Source #

For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.

messageResult_messageId :: Lens' MessageResult (Maybe Text) Source #

The unique identifier for the message that was sent.

messageResult_deliveryStatus :: Lens' MessageResult DeliveryStatus Source #

The delivery status of the message. Possible values are:

DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.
SUCCESSFUL - The message was successfully delivered to the endpoint address.
TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.
THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.
TIMEOUT - The message couldn't be sent within the timeout period.
UNKNOWN_FAILURE - An unknown error occurred.

messageResult_statusCode :: Lens' MessageResult Int Source #

The downstream service status code for delivering the message.

MetricDimension

metricDimension_comparisonOperator :: Lens' MetricDimension Text Source #

The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

metricDimension_value :: Lens' MetricDimension Double Source #

The value to compare.

MultiConditionalBranch

multiConditionalBranch_nextActivity :: Lens' MultiConditionalBranch (Maybe Text) Source #

The unique identifier for the next activity to perform, after completing the activity for the path.

multiConditionalBranch_condition :: Lens' MultiConditionalBranch (Maybe SimpleCondition) Source #

The condition to evaluate for the activity path.

MultiConditionalSplitActivity

multiConditionalSplitActivity_branches :: Lens' MultiConditionalSplitActivity (Maybe [MultiConditionalBranch]) Source #

The paths for the activity, including the conditions for entering each path and the activity to perform for each path.

multiConditionalSplitActivity_evaluationWaitTime :: Lens' MultiConditionalSplitActivity (Maybe WaitTime) Source #

The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.

multiConditionalSplitActivity_defaultActivity :: Lens' MultiConditionalSplitActivity (Maybe Text) Source #

The unique identifier for the activity to perform for participants who don't meet any of the conditions specified for other paths in the activity.

NumberValidateRequest

numberValidateRequest_isoCountryCode :: Lens' NumberValidateRequest (Maybe Text) Source #

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.

numberValidateRequest_phoneNumber :: Lens' NumberValidateRequest (Maybe Text) Source #

The phone number to retrieve information about. The phone number that you provide should include a valid numeric country code. Otherwise, the operation might result in an error.

NumberValidateResponse

numberValidateResponse_carrier :: Lens' NumberValidateResponse (Maybe Text) Source #

The carrier or service provider that the phone number is currently registered with. In some countries and regions, this value may be the carrier or service provider that the phone number was originally registered with.

numberValidateResponse_county :: Lens' NumberValidateResponse (Maybe Text) Source #

The name of the county where the phone number was originally registered.

numberValidateResponse_country :: Lens' NumberValidateResponse (Maybe Text) Source #

The name of the country or region where the phone number was originally registered.

numberValidateResponse_countryCodeNumeric :: Lens' NumberValidateResponse (Maybe Text) Source #

The numeric code for the country or region where the phone number was originally registered.

numberValidateResponse_zipCode :: Lens' NumberValidateResponse (Maybe Text) Source #

The postal or ZIP code for the location where the phone number was originally registered.

numberValidateResponse_originalPhoneNumber :: Lens' NumberValidateResponse (Maybe Text) Source #

The phone number that was sent in the request body.

numberValidateResponse_phoneTypeCode :: Lens' NumberValidateResponse (Maybe Int) Source #

The phone type, represented by an integer. Valid values are: 0 (mobile), 1 (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 (prepaid).

numberValidateResponse_phoneType :: Lens' NumberValidateResponse (Maybe Text) Source #

The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP, INVALID, PREPAID, and OTHER.

numberValidateResponse_city :: Lens' NumberValidateResponse (Maybe Text) Source #

The name of the city where the phone number was originally registered.

numberValidateResponse_countryCodeIso2 :: Lens' NumberValidateResponse (Maybe Text) Source #

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.

numberValidateResponse_timezone :: Lens' NumberValidateResponse (Maybe Text) Source #

The time zone for the location where the phone number was originally registered.

numberValidateResponse_originalCountryCodeIso2 :: Lens' NumberValidateResponse (Maybe Text) Source #

The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body.

numberValidateResponse_cleansedPhoneNumberNational :: Lens' NumberValidateResponse (Maybe Text) Source #

The cleansed phone number, in the format for the location where the phone number was originally registered.

numberValidateResponse_cleansedPhoneNumberE164 :: Lens' NumberValidateResponse (Maybe Text) Source #

The cleansed phone number, in E.164 format, for the location where the phone number was originally registered.

OverrideButtonConfiguration

overrideButtonConfiguration_link :: Lens' OverrideButtonConfiguration (Maybe Text) Source #

Button destination.

overrideButtonConfiguration_buttonAction :: Lens' OverrideButtonConfiguration ButtonAction Source #

Action triggered by the button.

PublicEndpoint

publicEndpoint_requestId :: Lens' PublicEndpoint (Maybe Text) Source #

A unique identifier that's generated each time the endpoint is updated.

publicEndpoint_metrics :: Lens' PublicEndpoint (Maybe (HashMap Text Double)) Source #

One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

publicEndpoint_location :: Lens' PublicEndpoint (Maybe EndpointLocation) Source #

The geographic information for the endpoint.

publicEndpoint_demographic :: Lens' PublicEndpoint (Maybe EndpointDemographic) Source #

The demographic information for the endpoint, such as the time zone and platform.

publicEndpoint_address :: Lens' PublicEndpoint (Maybe Text) Source #

The unique identifier for the recipient, such as a device token, email address, or mobile phone number.

publicEndpoint_effectiveDate :: Lens' PublicEndpoint (Maybe Text) Source #

The date and time, in ISO 8601 format, when the endpoint was last updated.

publicEndpoint_user :: Lens' PublicEndpoint (Maybe EndpointUser) Source #

One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

publicEndpoint_attributes :: Lens' PublicEndpoint (Maybe (HashMap Text [Text])) Source #

One or more custom attributes that describe the endpoint by associating a name with an array of values. You can use these attributes as filter criteria when you create segments.

publicEndpoint_endpointStatus :: Lens' PublicEndpoint (Maybe Text) Source #

Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

publicEndpoint_optOut :: Lens' PublicEndpoint (Maybe Text) Source #

Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

publicEndpoint_channelType :: Lens' PublicEndpoint (Maybe ChannelType) Source #

The channel that's used when sending messages or push notifications to the endpoint.

PushMessageActivity

pushMessageActivity_templateName :: Lens' PushMessageActivity (Maybe Text) Source #

The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.

pushMessageActivity_templateVersion :: Lens' PushMessageActivity (Maybe Text) Source #

The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

pushMessageActivity_nextActivity :: Lens' PushMessageActivity (Maybe Text) Source #

The unique identifier for the next activity to perform, after the message is sent.

pushMessageActivity_messageConfig :: Lens' PushMessageActivity (Maybe JourneyPushMessage) Source #

Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.

PushNotificationTemplateRequest

pushNotificationTemplateRequest_default :: Lens' PushNotificationTemplateRequest (Maybe DefaultPushNotificationTemplate) Source #

The default message template to use for push notification channels.

pushNotificationTemplateRequest_templateDescription :: Lens' PushNotificationTemplateRequest (Maybe Text) Source #

A custom description of the message template.

pushNotificationTemplateRequest_gcm :: Lens' PushNotificationTemplateRequest (Maybe AndroidPushNotificationTemplate) Source #

The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

pushNotificationTemplateRequest_apns :: Lens' PushNotificationTemplateRequest (Maybe APNSPushNotificationTemplate) Source #

The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

pushNotificationTemplateRequest_defaultSubstitutions :: Lens' PushNotificationTemplateRequest (Maybe Text) Source #

A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

pushNotificationTemplateRequest_adm :: Lens' PushNotificationTemplateRequest (Maybe AndroidPushNotificationTemplate) Source #

The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

pushNotificationTemplateRequest_baidu :: Lens' PushNotificationTemplateRequest (Maybe AndroidPushNotificationTemplate) Source #

The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

pushNotificationTemplateRequest_recommenderId :: Lens' PushNotificationTemplateRequest (Maybe Text) Source #

The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

pushNotificationTemplateRequest_tags :: Lens' PushNotificationTemplateRequest (Maybe (HashMap Text Text)) Source #

A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

PushNotificationTemplateResponse

pushNotificationTemplateResponse_arn :: Lens' PushNotificationTemplateResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the message template.

pushNotificationTemplateResponse_default :: Lens' PushNotificationTemplateResponse (Maybe DefaultPushNotificationTemplate) Source #

The default message template that's used for push notification channels.

pushNotificationTemplateResponse_templateDescription :: Lens' PushNotificationTemplateResponse (Maybe Text) Source #

The custom description of the message template.

pushNotificationTemplateResponse_gcm :: Lens' PushNotificationTemplateResponse (Maybe AndroidPushNotificationTemplate) Source #

The message template that's used for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

pushNotificationTemplateResponse_apns :: Lens' PushNotificationTemplateResponse (Maybe APNSPushNotificationTemplate) Source #

The message template that's used for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

pushNotificationTemplateResponse_defaultSubstitutions :: Lens' PushNotificationTemplateResponse (Maybe Text) Source #

The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.

pushNotificationTemplateResponse_version :: Lens' PushNotificationTemplateResponse (Maybe Text) Source #

The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.

pushNotificationTemplateResponse_adm :: Lens' PushNotificationTemplateResponse (Maybe AndroidPushNotificationTemplate) Source #

The message template that's used for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

pushNotificationTemplateResponse_baidu :: Lens' PushNotificationTemplateResponse (Maybe AndroidPushNotificationTemplate) Source #

The message template that's used for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

pushNotificationTemplateResponse_recommenderId :: Lens' PushNotificationTemplateResponse (Maybe Text) Source #

The unique identifier for the recommender model that's used by the message template.

pushNotificationTemplateResponse_tags :: Lens' PushNotificationTemplateResponse (Maybe (HashMap Text Text)) Source #

A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

pushNotificationTemplateResponse_lastModifiedDate :: Lens' PushNotificationTemplateResponse Text Source #

The date, in ISO 8601 format, when the message template was last modified.

pushNotificationTemplateResponse_creationDate :: Lens' PushNotificationTemplateResponse Text Source #

The date, in ISO 8601 format, when the message template was created.

pushNotificationTemplateResponse_templateType :: Lens' PushNotificationTemplateResponse TemplateType Source #

The type of channel that the message template is designed for. For a push notification template, this value is PUSH.

pushNotificationTemplateResponse_templateName :: Lens' PushNotificationTemplateResponse Text Source #

The name of the message template.

QuietTime

quietTime_start :: Lens' QuietTime (Maybe Text) Source #

The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

quietTime_end :: Lens' QuietTime (Maybe Text) Source #

The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

RandomSplitActivity

randomSplitActivity_branches :: Lens' RandomSplitActivity (Maybe [RandomSplitEntry]) Source #

The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.

RandomSplitEntry

randomSplitEntry_nextActivity :: Lens' RandomSplitEntry (Maybe Text) Source #

The unique identifier for the next activity to perform, after completing the activity for the path.

randomSplitEntry_percentage :: Lens' RandomSplitEntry (Maybe Int) Source #

The percentage of participants to send down the activity path.

To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.

RawEmail

rawEmail_data :: Lens' RawEmail (Maybe ByteString) Source #

The email message, represented as a raw MIME message. The entire message must be base64 encoded.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

RecencyDimension

recencyDimension_duration :: Lens' RecencyDimension Duration Source #

The duration to use when determining whether an endpoint is active or inactive.

recencyDimension_recencyType :: Lens' RecencyDimension RecencyType Source #

The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

RecommenderConfigurationResponse

recommenderConfigurationResponse_recommendationTransformerUri :: Lens' RecommenderConfigurationResponse (Maybe Text) Source #

The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to perform additional processing of recommendation data that it retrieves from the recommender model.

recommenderConfigurationResponse_recommendationsDisplayName :: Lens' RecommenderConfigurationResponse (Maybe Text) Source #

The custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console.

This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

recommenderConfigurationResponse_recommendationProviderIdType :: Lens' RecommenderConfigurationResponse (Maybe Text) Source #

The type of Amazon Pinpoint ID that's associated with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Possible values are:

PINPOINT_ENDPOINT_ID - Each user in the model is associated with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.
PINPOINT_USER_ID - Each user in the model is associated with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If this value is specified, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.

recommenderConfigurationResponse_attributes :: Lens' RecommenderConfigurationResponse (Maybe (HashMap Text Text)) Source #

A map that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.

This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

recommenderConfigurationResponse_name :: Lens' RecommenderConfigurationResponse (Maybe Text) Source #

The custom name of the configuration for the recommender model.

recommenderConfigurationResponse_description :: Lens' RecommenderConfigurationResponse (Maybe Text) Source #

The custom description of the configuration for the recommender model.

recommenderConfigurationResponse_recommendationsPerMessage :: Lens' RecommenderConfigurationResponse (Maybe Int) Source #

The number of recommended items that are retrieved from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables.

recommenderConfigurationResponse_recommendationProviderUri :: Lens' RecommenderConfigurationResponse Text Source #

The Amazon Resource Name (ARN) of the recommender model that Amazon Pinpoint retrieves the recommendation data from. This value is the ARN of an Amazon Personalize campaign.

recommenderConfigurationResponse_lastModifiedDate :: Lens' RecommenderConfigurationResponse Text Source #

The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.

recommenderConfigurationResponse_creationDate :: Lens' RecommenderConfigurationResponse Text Source #

The date, in extended ISO 8601 format, when the configuration was created for the recommender model.

recommenderConfigurationResponse_recommendationProviderRoleArn :: Lens' RecommenderConfigurationResponse Text Source #

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.

recommenderConfigurationResponse_id :: Lens' RecommenderConfigurationResponse Text Source #

The unique identifier for the recommender model configuration.

ResultRow

resultRow_groupedBys :: Lens' ResultRow [ResultRowValue] Source #

An array of objects that defines the field and field values that were used to group data in a result set that contains multiple results. This value is null if the data in a result set isn’t grouped.

resultRow_values :: Lens' ResultRow [ResultRowValue] Source #

An array of objects that provides pre-aggregated values for a standard metric that applies to an application, campaign, or journey.

ResultRowValue

resultRowValue_type :: Lens' ResultRowValue Text Source #

The data type of the value specified by the Value property.

resultRowValue_value :: Lens' ResultRowValue Text Source #

In a Values object, the value for the metric that the query retrieved data for. In a GroupedBys object, the value for the field that was used to group data in a result set that contains multiple results (Values objects).

resultRowValue_key :: Lens' ResultRowValue Text Source #

The friendly name of the metric whose value is specified by the Value property.

SMSChannelRequest

sMSChannelRequest_shortCode :: Lens' SMSChannelRequest (Maybe Text) Source #

The registered short code that you want to use when you send messages through the SMS channel.

sMSChannelRequest_enabled :: Lens' SMSChannelRequest (Maybe Bool) Source #

Specifies whether to enable the SMS channel for the application.

sMSChannelRequest_senderId :: Lens' SMSChannelRequest (Maybe Text) Source #

The identity that you want to display on recipients' devices when they receive messages from the SMS channel.

SMSChannelResponse

sMSChannelResponse_shortCode :: Lens' SMSChannelResponse (Maybe Text) Source #

The registered short code to use when you send messages through the SMS channel.

sMSChannelResponse_lastModifiedDate :: Lens' SMSChannelResponse (Maybe Text) Source #

The date and time, in ISO 8601 format, when the SMS channel was last modified.

sMSChannelResponse_enabled :: Lens' SMSChannelResponse (Maybe Bool) Source #

Specifies whether the SMS channel is enabled for the application.

sMSChannelResponse_senderId :: Lens' SMSChannelResponse (Maybe Text) Source #

The identity that displays on recipients' devices when they receive messages from the SMS channel.

sMSChannelResponse_transactionalMessagesPerSecond :: Lens' SMSChannelResponse (Maybe Int) Source #

The maximum number of transactional messages that you can send through the SMS channel each second.

sMSChannelResponse_promotionalMessagesPerSecond :: Lens' SMSChannelResponse (Maybe Int) Source #

The maximum number of promotional messages that you can send through the SMS channel each second.

sMSChannelResponse_isArchived :: Lens' SMSChannelResponse (Maybe Bool) Source #

Specifies whether the SMS channel is archived.

sMSChannelResponse_applicationId :: Lens' SMSChannelResponse (Maybe Text) Source #

The unique identifier for the application that the SMS channel applies to.

sMSChannelResponse_version :: Lens' SMSChannelResponse (Maybe Int) Source #

The current version of the SMS channel.

sMSChannelResponse_id :: Lens' SMSChannelResponse (Maybe Text) Source #

(Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.

sMSChannelResponse_creationDate :: Lens' SMSChannelResponse (Maybe Text) Source #

The date and time, in ISO 8601 format, when the SMS channel was enabled.

sMSChannelResponse_lastModifiedBy :: Lens' SMSChannelResponse (Maybe Text) Source #

The user who last modified the SMS channel.

sMSChannelResponse_hasCredential :: Lens' SMSChannelResponse (Maybe Bool) Source #

(Not used) This property is retained only for backward compatibility.

sMSChannelResponse_platform :: Lens' SMSChannelResponse Text Source #

The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.

SMSMessage

sMSMessage_substitutions :: Lens' SMSMessage (Maybe (HashMap Text [Text])) Source #

The message variables to use in the SMS message. You can override the default variables with individual address variables.

sMSMessage_originationNumber :: Lens' SMSMessage (Maybe Text) Source #

The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.

sMSMessage_templateId :: Lens' SMSMessage (Maybe Text) Source #

The template ID received from the regulatory body for sending SMS in your country.

sMSMessage_body :: Lens' SMSMessage (Maybe Text) Source #

The body of the SMS message.

sMSMessage_messageType :: Lens' SMSMessage (Maybe MessageType) Source #

The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

sMSMessage_senderId :: Lens' SMSMessage (Maybe Text) Source #

The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.

sMSMessage_mediaUrl :: Lens' SMSMessage (Maybe Text) Source #

This field is reserved for future use.

sMSMessage_entityId :: Lens' SMSMessage (Maybe Text) Source #

The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

sMSMessage_keyword :: Lens' SMSMessage (Maybe Text) Source #

The SMS program name that you provided to AWS Support when you requested your dedicated number.

SMSMessageActivity

sMSMessageActivity_templateName :: Lens' SMSMessageActivity (Maybe Text) Source #

The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.

sMSMessageActivity_templateVersion :: Lens' SMSMessageActivity (Maybe Text) Source #

The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

sMSMessageActivity_nextActivity :: Lens' SMSMessageActivity (Maybe Text) Source #

The unique identifier for the next activity to perform, after the message is sent.

sMSMessageActivity_messageConfig :: Lens' SMSMessageActivity (Maybe JourneySMSMessage) Source #

Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.

SMSTemplateRequest

sMSTemplateRequest_body :: Lens' SMSTemplateRequest (Maybe Text) Source #

The message body to use in text messages that are based on the message template.

sMSTemplateRequest_templateDescription :: Lens' SMSTemplateRequest (Maybe Text) Source #

A custom description of the message template.

sMSTemplateRequest_defaultSubstitutions :: Lens' SMSTemplateRequest (Maybe Text) Source #

A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

sMSTemplateRequest_recommenderId :: Lens' SMSTemplateRequest (Maybe Text) Source #

The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

sMSTemplateRequest_tags :: Lens' SMSTemplateRequest (Maybe (HashMap Text Text)) Source #

A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

SMSTemplateResponse

sMSTemplateResponse_arn :: Lens' SMSTemplateResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the message template.

sMSTemplateResponse_body :: Lens' SMSTemplateResponse (Maybe Text) Source #

The message body that's used in text messages that are based on the message template.

sMSTemplateResponse_templateDescription :: Lens' SMSTemplateResponse (Maybe Text) Source #

The custom description of the message template.

sMSTemplateResponse_defaultSubstitutions :: Lens' SMSTemplateResponse (Maybe Text) Source #

The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.

sMSTemplateResponse_version :: Lens' SMSTemplateResponse (Maybe Text) Source #

The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.

sMSTemplateResponse_recommenderId :: Lens' SMSTemplateResponse (Maybe Text) Source #

The unique identifier for the recommender model that's used by the message template.

sMSTemplateResponse_tags :: Lens' SMSTemplateResponse (Maybe (HashMap Text Text)) Source #

A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

sMSTemplateResponse_lastModifiedDate :: Lens' SMSTemplateResponse Text Source #

The date, in ISO 8601 format, when the message template was last modified.

sMSTemplateResponse_creationDate :: Lens' SMSTemplateResponse Text Source #

The date, in ISO 8601 format, when the message template was created.

sMSTemplateResponse_templateName :: Lens' SMSTemplateResponse Text Source #

The name of the message template.

sMSTemplateResponse_templateType :: Lens' SMSTemplateResponse TemplateType Source #

The type of channel that the message template is designed for. For an SMS template, this value is SMS.

Schedule

schedule_frequency :: Lens' Schedule (Maybe Frequency) Source #

Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

schedule_quietTime :: Lens' Schedule (Maybe QuietTime) Source #

The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

schedule_eventFilter :: Lens' Schedule (Maybe CampaignEventFilter) Source #

The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.

schedule_isLocalTime :: Lens' Schedule (Maybe Bool) Source #

Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

schedule_endTime :: Lens' Schedule (Maybe Text) Source #

The scheduled time, in ISO 8601 format, when the campaign ended or will end.

schedule_timezone :: Lens' Schedule (Maybe Text) Source #

The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

schedule_startTime :: Lens' Schedule Text Source #

The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.

SegmentBehaviors

segmentBehaviors_recency :: Lens' SegmentBehaviors (Maybe RecencyDimension) Source #

The dimension settings that are based on how recently an endpoint was active.

SegmentCondition

segmentCondition_segmentId :: Lens' SegmentCondition Text Source #

The unique identifier for the segment to associate with the activity.

SegmentDemographics

segmentDemographics_platform :: Lens' SegmentDemographics (Maybe SetDimension) Source #

The device platform criteria for the segment.

segmentDemographics_appVersion :: Lens' SegmentDemographics (Maybe SetDimension) Source #

The app version criteria for the segment.

segmentDemographics_channel :: Lens' SegmentDemographics (Maybe SetDimension) Source #

The channel criteria for the segment.

segmentDemographics_model :: Lens' SegmentDemographics (Maybe SetDimension) Source #

The device model criteria for the segment.

segmentDemographics_make :: Lens' SegmentDemographics (Maybe SetDimension) Source #

The device make criteria for the segment.

segmentDemographics_deviceType :: Lens' SegmentDemographics (Maybe SetDimension) Source #

The device type criteria for the segment.

SegmentDimensions

segmentDimensions_metrics :: Lens' SegmentDimensions (Maybe (HashMap Text MetricDimension)) Source #

One or more custom metrics to use as criteria for the segment.

segmentDimensions_location :: Lens' SegmentDimensions (Maybe SegmentLocation) Source #

The location-based criteria, such as region or GPS coordinates, for the segment.

segmentDimensions_demographic :: Lens' SegmentDimensions (Maybe SegmentDemographics) Source #

The demographic-based criteria, such as device platform, for the segment.

segmentDimensions_userAttributes :: Lens' SegmentDimensions (Maybe (HashMap Text AttributeDimension)) Source #

One or more custom user attributes to use as criteria for the segment.

segmentDimensions_behavior :: Lens' SegmentDimensions (Maybe SegmentBehaviors) Source #

The behavior-based criteria, such as how recently users have used your app, for the segment.

segmentDimensions_attributes :: Lens' SegmentDimensions (Maybe (HashMap Text AttributeDimension)) Source #

One or more custom attributes to use as criteria for the segment.

SegmentGroup

segmentGroup_sourceSegments :: Lens' SegmentGroup (Maybe [SegmentReference]) Source #

The base segment to build the segment on. A base segment, also referred to as a source segment, defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.

You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.

segmentGroup_sourceType :: Lens' SegmentGroup (Maybe SourceType) Source #

Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.

segmentGroup_type :: Lens' SegmentGroup (Maybe Type) Source #

Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.

segmentGroup_dimensions :: Lens' SegmentGroup (Maybe [SegmentDimensions]) Source #

An array that defines the dimensions for the segment.

SegmentGroupList

segmentGroupList_include :: Lens' SegmentGroupList (Maybe Include) Source #

Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.

segmentGroupList_groups :: Lens' SegmentGroupList (Maybe [SegmentGroup]) Source #

An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.

SegmentImportResource

segmentImportResource_channelCounts :: Lens' SegmentImportResource (Maybe (HashMap Text Int)) Source #

The number of channel types in the endpoint definitions that were imported to create the segment.

segmentImportResource_format :: Lens' SegmentImportResource DefinitionFormat Source #

The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.

segmentImportResource_s3Url :: Lens' SegmentImportResource Text Source #

The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.

segmentImportResource_size :: Lens' SegmentImportResource Int Source #

The number of endpoint definitions that were imported successfully to create the segment.

segmentImportResource_externalId :: Lens' SegmentImportResource Text Source #

(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

segmentImportResource_roleArn :: Lens' SegmentImportResource Text Source #

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

SegmentLocation

segmentLocation_country :: Lens' SegmentLocation (Maybe SetDimension) Source #

The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

segmentLocation_gPSPoint :: Lens' SegmentLocation (Maybe GPSPointDimension) Source #

The GPS location and range for the segment.

SegmentReference

segmentReference_version :: Lens' SegmentReference (Maybe Int) Source #

The version number of the segment.

segmentReference_id :: Lens' SegmentReference Text Source #

The unique identifier for the segment.

SegmentResponse

segmentResponse_lastModifiedDate :: Lens' SegmentResponse (Maybe Text) Source #

The date and time when the segment was last modified.

segmentResponse_segmentGroups :: Lens' SegmentResponse (Maybe SegmentGroupList) Source #

A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.

segmentResponse_name :: Lens' SegmentResponse (Maybe Text) Source #

The name of the segment.

segmentResponse_version :: Lens' SegmentResponse (Maybe Int) Source #

The version number of the segment.

segmentResponse_importDefinition :: Lens' SegmentResponse (Maybe SegmentImportResource) Source #

The settings for the import job that's associated with the segment.

segmentResponse_dimensions :: Lens' SegmentResponse (Maybe SegmentDimensions) Source #

The dimension settings for the segment.

segmentResponse_tags :: Lens' SegmentResponse (Maybe (HashMap Text Text)) Source #

A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.

segmentResponse_segmentType :: Lens' SegmentResponse SegmentType Source #

The segment type. Valid values are:

DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.
IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.

segmentResponse_creationDate :: Lens' SegmentResponse Text Source #

The date and time when the segment was created.

segmentResponse_id :: Lens' SegmentResponse Text Source #

The unique identifier for the segment.

segmentResponse_arn :: Lens' SegmentResponse Text Source #

The Amazon Resource Name (ARN) of the segment.

segmentResponse_applicationId :: Lens' SegmentResponse Text Source #

The unique identifier for the application that the segment is associated with.

SegmentsResponse

segmentsResponse_nextToken :: Lens' SegmentsResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

segmentsResponse_item :: Lens' SegmentsResponse [SegmentResponse] Source #

An array of responses, one for each segment that's associated with the application (Segments resource) or each version of a segment that's associated with the application (Segment Versions resource).

SendUsersMessageRequest

sendUsersMessageRequest_traceId :: Lens' SendUsersMessageRequest (Maybe Text) Source #

The unique identifier for tracing the message. This identifier is visible to message recipients.

sendUsersMessageRequest_context :: Lens' SendUsersMessageRequest (Maybe (HashMap Text Text)) Source #

A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.

sendUsersMessageRequest_templateConfiguration :: Lens' SendUsersMessageRequest (Maybe TemplateConfiguration) Source #

The message template to use for the message.

sendUsersMessageRequest_messageConfiguration :: Lens' SendUsersMessageRequest DirectMessageConfiguration Source #

The settings and content for the default message and any default messages that you defined for specific channels.

sendUsersMessageRequest_users :: Lens' SendUsersMessageRequest (HashMap Text EndpointSendConfiguration) Source #

A map that associates user IDs with EndpointSendConfiguration objects. You can use an EndpointSendConfiguration object to tailor the message for a user by specifying settings such as content overrides and message variables.

SendUsersMessageResponse

sendUsersMessageResponse_requestId :: Lens' SendUsersMessageResponse (Maybe Text) Source #

The unique identifier that was assigned to the message request.

sendUsersMessageResponse_result :: Lens' SendUsersMessageResponse (Maybe (HashMap Text (HashMap Text EndpointMessageResult))) Source #

An object that indicates which endpoints the message was sent to, for each user. The object lists user IDs and, for each user ID, provides the endpoint IDs that the message was sent to. For each endpoint ID, it provides an EndpointMessageResult object.

sendUsersMessageResponse_applicationId :: Lens' SendUsersMessageResponse Text Source #

The unique identifier for the application that was used to send the message.

Session

session_stopTimestamp :: Lens' Session (Maybe Text) Source #

The date and time when the session ended.

session_duration :: Lens' Session (Maybe Int) Source #

The duration of the session, in milliseconds.

session_startTimestamp :: Lens' Session Text Source #

The date and time when the session began.

session_id :: Lens' Session Text Source #

The unique identifier for the session.

SetDimension

setDimension_dimensionType :: Lens' SetDimension (Maybe DimensionType) Source #

The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

setDimension_values :: Lens' SetDimension [Text] Source #

The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

SimpleCondition

simpleCondition_segmentDimensions :: Lens' SimpleCondition (Maybe SegmentDimensions) Source #

The dimension settings for the segment that's associated with the activity.

simpleCondition_eventCondition :: Lens' SimpleCondition (Maybe EventCondition) Source #

The dimension settings for the event that's associated with the activity.

simpleCondition_segmentCondition :: Lens' SimpleCondition (Maybe SegmentCondition) Source #

The segment that's associated with the activity.

SimpleEmail

simpleEmail_subject :: Lens' SimpleEmail (Maybe SimpleEmailPart) Source #

The subject line, or title, of the email.

simpleEmail_textPart :: Lens' SimpleEmail (Maybe SimpleEmailPart) Source #

The body of the email message, in plain text format. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.

simpleEmail_htmlPart :: Lens' SimpleEmail (Maybe SimpleEmailPart) Source #

The body of the email message, in HTML format. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.

SimpleEmailPart

simpleEmailPart_data :: Lens' SimpleEmailPart (Maybe Text) Source #

The textual data of the message content.

simpleEmailPart_charset :: Lens' SimpleEmailPart (Maybe Text) Source #

The applicable character set for the message content.

StartCondition

startCondition_segmentStartCondition :: Lens' StartCondition (Maybe SegmentCondition) Source #

The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.

startCondition_eventStartCondition :: Lens' StartCondition (Maybe EventStartCondition) Source #

Undocumented member.

startCondition_description :: Lens' StartCondition (Maybe Text) Source #

The custom description of the condition.

TagsModel

tagsModel_tags :: Lens' TagsModel (HashMap Text Text) Source #

A string-to-string map of key-value pairs that defines the tags for an application, campaign, message template, or segment. Each of these resources can have a maximum of 50 tags.

Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

Template

template_name :: Lens' Template (Maybe Text) Source #

The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

template_version :: Lens' Template (Maybe Text) Source #

The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

TemplateActiveVersionRequest

templateActiveVersionRequest_version :: Lens' TemplateActiveVersionRequest (Maybe Text) Source #

The version of the message template to use as the active version of the template. Valid values are: latest, for the most recent version of the template; or, the unique identifier for any existing version of the template. If you specify an identifier, the value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

TemplateConfiguration

templateConfiguration_sMSTemplate :: Lens' TemplateConfiguration (Maybe Template) Source #

The SMS template to use for the message.

templateConfiguration_voiceTemplate :: Lens' TemplateConfiguration (Maybe Template) Source #

The voice template to use for the message. This object isn't supported for campaigns.

templateConfiguration_pushTemplate :: Lens' TemplateConfiguration (Maybe Template) Source #

The push notification template to use for the message.

templateConfiguration_emailTemplate :: Lens' TemplateConfiguration (Maybe Template) Source #

The email template to use for the message.

TemplateCreateMessageBody

templateCreateMessageBody_requestID :: Lens' TemplateCreateMessageBody (Maybe Text) Source #

The unique identifier for the request to create the message template.

templateCreateMessageBody_arn :: Lens' TemplateCreateMessageBody (Maybe Text) Source #

The Amazon Resource Name (ARN) of the message template that was created.

templateCreateMessageBody_message :: Lens' TemplateCreateMessageBody (Maybe Text) Source #

The message that's returned from the API for the request to create the message template.

TemplateResponse

templateResponse_arn :: Lens' TemplateResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the message template. This value isn't included in a TemplateResponse object. To retrieve the ARN of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the ARN for.

templateResponse_templateDescription :: Lens' TemplateResponse (Maybe Text) Source #

The custom description of the message template. This value isn't included in a TemplateResponse object. To retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description for.

templateResponse_defaultSubstitutions :: Lens' TemplateResponse (Maybe Text) Source #

The JSON object that specifies the default values that are used for message variables in the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.

templateResponse_version :: Lens' TemplateResponse (Maybe Text) Source #

The unique identifier, as an integer, for the active version of the message template.

templateResponse_tags :: Lens' TemplateResponse (Maybe (HashMap Text Text)) Source #

A map of key-value pairs that identifies the tags that are associated with the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.

templateResponse_lastModifiedDate :: Lens' TemplateResponse Text Source #

The date, in ISO 8601 format, when the message template was last modified.

templateResponse_creationDate :: Lens' TemplateResponse Text Source #

The date, in ISO 8601 format, when the message template was created.

templateResponse_templateName :: Lens' TemplateResponse Text Source #

The name of the message template.

templateResponse_templateType :: Lens' TemplateResponse TemplateType Source #

The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.

TemplateVersionResponse

templateVersionResponse_templateDescription :: Lens' TemplateVersionResponse (Maybe Text) Source #

The custom description of the version of the message template.

templateVersionResponse_defaultSubstitutions :: Lens' TemplateVersionResponse (Maybe Text) Source #

A JSON object that specifies the default values that are used for message variables in the version of the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.

templateVersionResponse_version :: Lens' TemplateVersionResponse (Maybe Text) Source #

The unique identifier for the version of the message template. This value is an integer that Amazon Pinpoint automatically increments and assigns to each new version of a template.

templateVersionResponse_lastModifiedDate :: Lens' TemplateVersionResponse Text Source #

The date, in ISO 8601 format, when the version of the message template was last modified.

templateVersionResponse_creationDate :: Lens' TemplateVersionResponse Text Source #

The date, in ISO 8601 format, when the version of the message template was created.

templateVersionResponse_templateName :: Lens' TemplateVersionResponse Text Source #

The name of the message template.

templateVersionResponse_templateType :: Lens' TemplateVersionResponse Text Source #

The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.

TemplateVersionsResponse

templateVersionsResponse_requestID :: Lens' TemplateVersionsResponse (Maybe Text) Source #

The unique identifier for the request to retrieve information about all the versions of the message template.

templateVersionsResponse_nextToken :: Lens' TemplateVersionsResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

templateVersionsResponse_message :: Lens' TemplateVersionsResponse (Maybe Text) Source #

The message that's returned from the API for the request to retrieve information about all the versions of the message template.

templateVersionsResponse_item :: Lens' TemplateVersionsResponse [TemplateVersionResponse] Source #

An array of responses, one for each version of the message template.

TemplatesResponse

templatesResponse_nextToken :: Lens' TemplatesResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

templatesResponse_item :: Lens' TemplatesResponse [TemplateResponse] Source #

An array of responses, one for each message template that's associated with your Amazon Pinpoint account and meets any filter criteria that you specified in the request.

TreatmentResource

treatmentResource_customDeliveryConfiguration :: Lens' TreatmentResource (Maybe CustomDeliveryConfiguration) Source #

The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.

treatmentResource_state :: Lens' TreatmentResource (Maybe CampaignState) Source #

The current status of the treatment.

treatmentResource_schedule :: Lens' TreatmentResource (Maybe Schedule) Source #

The schedule settings for the treatment.

treatmentResource_templateConfiguration :: Lens' TreatmentResource (Maybe TemplateConfiguration) Source #

The message template to use for the treatment.

treatmentResource_treatmentName :: Lens' TreatmentResource (Maybe Text) Source #

The custom name of the treatment.

treatmentResource_treatmentDescription :: Lens' TreatmentResource (Maybe Text) Source #

The custom description of the treatment.

treatmentResource_messageConfiguration :: Lens' TreatmentResource (Maybe MessageConfiguration) Source #

The message configuration settings for the treatment.

treatmentResource_id :: Lens' TreatmentResource Text Source #

The unique identifier for the treatment.

treatmentResource_sizePercent :: Lens' TreatmentResource Int Source #

The allocated percentage of users (segment members) that the treatment is sent to.

UpdateAttributesRequest

updateAttributesRequest_blacklist :: Lens' UpdateAttributesRequest (Maybe [Text]) Source #

An array of the attributes to remove from all the endpoints that are associated with the application. The array can specify the complete, exact name of each attribute to remove or it can specify a glob pattern that an attribute name must match in order for the attribute to be removed.

UpdateRecommenderConfiguration

updateRecommenderConfiguration_recommendationTransformerUri :: Lens' UpdateRecommenderConfiguration (Maybe Text) Source #

The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model.

updateRecommenderConfiguration_recommendationsDisplayName :: Lens' UpdateRecommenderConfiguration (Maybe Text) Source #

A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.

updateRecommenderConfiguration_recommendationProviderIdType :: Lens' UpdateRecommenderConfiguration (Maybe Text) Source #

The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:

PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.
PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.

updateRecommenderConfiguration_attributes :: Lens' UpdateRecommenderConfiguration (Maybe (HashMap Text Text)) Source #

A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.

In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:

An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.
An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).

This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.

updateRecommenderConfiguration_name :: Lens' UpdateRecommenderConfiguration (Maybe Text) Source #

A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).

updateRecommenderConfiguration_description :: Lens' UpdateRecommenderConfiguration (Maybe Text) Source #

A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.

updateRecommenderConfiguration_recommendationsPerMessage :: Lens' UpdateRecommenderConfiguration (Maybe Int) Source #

The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.

To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

updateRecommenderConfiguration_recommendationProviderUri :: Lens' UpdateRecommenderConfiguration Text Source #

The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign.

updateRecommenderConfiguration_recommendationProviderRoleArn :: Lens' UpdateRecommenderConfiguration Text Source #

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.

VoiceChannelRequest

voiceChannelRequest_enabled :: Lens' VoiceChannelRequest (Maybe Bool) Source #

Specifies whether to enable the voice channel for the application.

VoiceChannelResponse

voiceChannelResponse_lastModifiedDate :: Lens' VoiceChannelResponse (Maybe Text) Source #

The date and time, in ISO 8601 format, when the voice channel was last modified.

voiceChannelResponse_enabled :: Lens' VoiceChannelResponse (Maybe Bool) Source #

Specifies whether the voice channel is enabled for the application.

voiceChannelResponse_isArchived :: Lens' VoiceChannelResponse (Maybe Bool) Source #

Specifies whether the voice channel is archived.

voiceChannelResponse_applicationId :: Lens' VoiceChannelResponse (Maybe Text) Source #

The unique identifier for the application that the voice channel applies to.

voiceChannelResponse_version :: Lens' VoiceChannelResponse (Maybe Int) Source #

The current version of the voice channel.

voiceChannelResponse_id :: Lens' VoiceChannelResponse (Maybe Text) Source #

(Deprecated) An identifier for the voice channel. This property is retained only for backward compatibility.

voiceChannelResponse_creationDate :: Lens' VoiceChannelResponse (Maybe Text) Source #

The date and time, in ISO 8601 format, when the voice channel was enabled.

voiceChannelResponse_lastModifiedBy :: Lens' VoiceChannelResponse (Maybe Text) Source #

The user who last modified the voice channel.

voiceChannelResponse_hasCredential :: Lens' VoiceChannelResponse (Maybe Bool) Source #

(Not used) This property is retained only for backward compatibility.

voiceChannelResponse_platform :: Lens' VoiceChannelResponse Text Source #

The type of messaging or notification platform for the channel. For the voice channel, this value is VOICE.

VoiceMessage

voiceMessage_substitutions :: Lens' VoiceMessage (Maybe (HashMap Text [Text])) Source #

The default message variables to use in the voice message. You can override the default variables with individual address variables.

voiceMessage_languageCode :: Lens' VoiceMessage (Maybe Text) Source #

The code for the language to use when synthesizing the text of the message script. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.

voiceMessage_originationNumber :: Lens' VoiceMessage (Maybe Text) Source #

The long code to send the voice message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message.

voiceMessage_body :: Lens' VoiceMessage (Maybe Text) Source #

The text of the script to use for the voice message.

voiceMessage_voiceId :: Lens' VoiceMessage (Maybe Text) Source #

The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.

VoiceTemplateRequest

voiceTemplateRequest_languageCode :: Lens' VoiceTemplateRequest (Maybe Text) Source #

The code for the language to use when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.

voiceTemplateRequest_body :: Lens' VoiceTemplateRequest (Maybe Text) Source #

The text of the script to use in messages that are based on the message template, in plain text format.

voiceTemplateRequest_templateDescription :: Lens' VoiceTemplateRequest (Maybe Text) Source #

A custom description of the message template.

voiceTemplateRequest_defaultSubstitutions :: Lens' VoiceTemplateRequest (Maybe Text) Source #

A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

voiceTemplateRequest_voiceId :: Lens' VoiceTemplateRequest (Maybe Text) Source #

The name of the voice to use when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.

voiceTemplateRequest_tags :: Lens' VoiceTemplateRequest (Maybe (HashMap Text Text)) Source #

A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

VoiceTemplateResponse

voiceTemplateResponse_languageCode :: Lens' VoiceTemplateResponse (Maybe Text) Source #

The code for the language that's used when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.

voiceTemplateResponse_arn :: Lens' VoiceTemplateResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the message template.

voiceTemplateResponse_body :: Lens' VoiceTemplateResponse (Maybe Text) Source #

The text of the script that's used in messages that are based on the message template, in plain text format.

voiceTemplateResponse_templateDescription :: Lens' VoiceTemplateResponse (Maybe Text) Source #

The custom description of the message template.

voiceTemplateResponse_defaultSubstitutions :: Lens' VoiceTemplateResponse (Maybe Text) Source #

The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.

voiceTemplateResponse_version :: Lens' VoiceTemplateResponse (Maybe Text) Source #

The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.

voiceTemplateResponse_voiceId :: Lens' VoiceTemplateResponse (Maybe Text) Source #

The name of the voice that's used when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.

voiceTemplateResponse_tags :: Lens' VoiceTemplateResponse (Maybe (HashMap Text Text)) Source #

A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

voiceTemplateResponse_lastModifiedDate :: Lens' VoiceTemplateResponse Text Source #

The date, in ISO 8601 format, when the message template was last modified.

voiceTemplateResponse_creationDate :: Lens' VoiceTemplateResponse Text Source #

The date, in ISO 8601 format, when the message template was created.

voiceTemplateResponse_templateName :: Lens' VoiceTemplateResponse Text Source #

The name of the message template.

voiceTemplateResponse_templateType :: Lens' VoiceTemplateResponse TemplateType Source #

The type of channel that the message template is designed for. For a voice template, this value is VOICE.

WaitActivity

waitActivity_nextActivity :: Lens' WaitActivity (Maybe Text) Source #

The unique identifier for the next activity to perform, after performing the wait activity.

waitActivity_waitTime :: Lens' WaitActivity (Maybe WaitTime) Source #

The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.

WaitTime

waitTime_waitFor :: Lens' WaitTime (Maybe Text) Source #

The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.

waitTime_waitUntil :: Lens' WaitTime (Maybe Text) Source #

The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.

WriteApplicationSettingsRequest

writeApplicationSettingsRequest_eventTaggingEnabled :: Lens' WriteApplicationSettingsRequest (Maybe Bool) Source #

Undocumented member.

writeApplicationSettingsRequest_cloudWatchMetricsEnabled :: Lens' WriteApplicationSettingsRequest (Maybe Bool) Source #

Specifies whether to enable application-related alarms in Amazon CloudWatch.

writeApplicationSettingsRequest_limits :: Lens' WriteApplicationSettingsRequest (Maybe CampaignLimits) Source #

The default sending limits for campaigns in the application. To override these limits and define custom limits for a specific campaign or journey, use the Campaign resource or the Journey resource, respectively.

writeApplicationSettingsRequest_quietTime :: Lens' WriteApplicationSettingsRequest (Maybe QuietTime) Source #

The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:

The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).
The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).

If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.

To override the default quiet time settings for a specific campaign or journey, use the Campaign resource or the Journey resource to define a custom quiet time for the campaign or journey.

writeApplicationSettingsRequest_campaignHook :: Lens' WriteApplicationSettingsRequest (Maybe CampaignHook) Source #

The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.

To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the Campaign resource.

WriteCampaignRequest

writeCampaignRequest_customDeliveryConfiguration :: Lens' WriteCampaignRequest (Maybe CustomDeliveryConfiguration) Source #

The delivery configuration settings for sending the campaign through a custom channel. This object is required if the MessageConfiguration object for the campaign specifies a CustomMessage object.

writeCampaignRequest_priority :: Lens' WriteCampaignRequest (Maybe Int) Source #

Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.

writeCampaignRequest_schedule :: Lens' WriteCampaignRequest (Maybe Schedule) Source #

The schedule settings for the campaign.

writeCampaignRequest_templateConfiguration :: Lens' WriteCampaignRequest (Maybe TemplateConfiguration) Source #

The message template to use for the campaign.

writeCampaignRequest_hook :: Lens' WriteCampaignRequest (Maybe CampaignHook) Source #

The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.

writeCampaignRequest_treatmentName :: Lens' WriteCampaignRequest (Maybe Text) Source #

A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.

writeCampaignRequest_limits :: Lens' WriteCampaignRequest (Maybe CampaignLimits) Source #

The messaging limits for the campaign.

writeCampaignRequest_isPaused :: Lens' WriteCampaignRequest (Maybe Bool) Source #

Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.

writeCampaignRequest_name :: Lens' WriteCampaignRequest (Maybe Text) Source #

A custom name for the campaign.

writeCampaignRequest_holdoutPercent :: Lens' WriteCampaignRequest (Maybe Int) Source #

The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

writeCampaignRequest_treatmentDescription :: Lens' WriteCampaignRequest (Maybe Text) Source #

A custom description of the default treatment for the campaign.

writeCampaignRequest_messageConfiguration :: Lens' WriteCampaignRequest (Maybe MessageConfiguration) Source #

The message configuration settings for the campaign.

writeCampaignRequest_description :: Lens' WriteCampaignRequest (Maybe Text) Source #

A custom description of the campaign.

writeCampaignRequest_segmentId :: Lens' WriteCampaignRequest (Maybe Text) Source #

The unique identifier for the segment to associate with the campaign.

writeCampaignRequest_additionalTreatments :: Lens' WriteCampaignRequest (Maybe [WriteTreatmentResource]) Source #

An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.

writeCampaignRequest_tags :: Lens' WriteCampaignRequest (Maybe (HashMap Text Text)) Source #

A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value.

writeCampaignRequest_segmentVersion :: Lens' WriteCampaignRequest (Maybe Int) Source #

The version of the segment to associate with the campaign.

WriteEventStream

writeEventStream_roleArn :: Lens' WriteEventStream Text Source #

The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.

writeEventStream_destinationStreamArn :: Lens' WriteEventStream Text Source #

The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream that you want to publish event data to.

For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name

For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name

WriteJourneyRequest

writeJourneyRequest_state :: Lens' WriteJourneyRequest (Maybe State) Source #

The status of the journey. Valid values are:

DRAFT - Saves the journey and doesn't publish it.
ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.

PAUSED, CANCELLED, COMPLETED, and CLOSED states are not supported in requests to create or update a journey. To cancel, pause, or resume a journey, use the Journey State resource.

writeJourneyRequest_lastModifiedDate :: Lens' WriteJourneyRequest (Maybe Text) Source #

The date, in ISO 8601 format, when the journey was last modified.

writeJourneyRequest_schedule :: Lens' WriteJourneyRequest (Maybe JourneySchedule) Source #

The schedule settings for the journey.

writeJourneyRequest_localTime :: Lens' WriteJourneyRequest (Maybe Bool) Source #

Specifies whether the journey's scheduled start and end times use each participant's local time. To base the schedule on each participant's local time, set this value to true.

writeJourneyRequest_activities :: Lens' WriteJourneyRequest (Maybe (HashMap Text Activity)) Source #

A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity. An activity identifier can contain a maximum of 100 characters. The characters must be alphanumeric characters.

writeJourneyRequest_refreshOnSegmentUpdate :: Lens' WriteJourneyRequest (Maybe Bool) Source #

Specifies whether a journey should be refreshed on segment update.

writeJourneyRequest_limits :: Lens' WriteJourneyRequest (Maybe JourneyLimits) Source #

The messaging and entry limits for the journey.

writeJourneyRequest_waitForQuietTime :: Lens' WriteJourneyRequest (Maybe Bool) Source #

Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.

writeJourneyRequest_quietTime :: Lens' WriteJourneyRequest (Maybe QuietTime) Source #

The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:

The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.

If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.

writeJourneyRequest_startActivity :: Lens' WriteJourneyRequest (Maybe Text) Source #

The unique identifier for the first activity in the journey. The identifier for this activity can contain a maximum of 128 characters. The characters must be alphanumeric characters.

writeJourneyRequest_creationDate :: Lens' WriteJourneyRequest (Maybe Text) Source #

The date, in ISO 8601 format, when the journey was created.

writeJourneyRequest_startCondition :: Lens' WriteJourneyRequest (Maybe StartCondition) Source #

The segment that defines which users are participants in the journey.

writeJourneyRequest_refreshFrequency :: Lens' WriteJourneyRequest (Maybe Text) Source #

The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

writeJourneyRequest_name :: Lens' WriteJourneyRequest Text Source #

The name of the journey. A journey name can contain a maximum of 150 characters. The characters can be alphanumeric characters or symbols, such as underscores (_) or hyphens (-). A journey name can't contain any spaces.

WriteSegmentRequest

writeSegmentRequest_segmentGroups :: Lens' WriteSegmentRequest (Maybe SegmentGroupList) Source #

The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.

writeSegmentRequest_name :: Lens' WriteSegmentRequest (Maybe Text) Source #

The name of the segment.

writeSegmentRequest_dimensions :: Lens' WriteSegmentRequest (Maybe SegmentDimensions) Source #

The criteria that define the dimensions for the segment.

writeSegmentRequest_tags :: Lens' WriteSegmentRequest (Maybe (HashMap Text Text)) Source #

A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value.

WriteTreatmentResource

writeTreatmentResource_customDeliveryConfiguration :: Lens' WriteTreatmentResource (Maybe CustomDeliveryConfiguration) Source #

The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.

writeTreatmentResource_schedule :: Lens' WriteTreatmentResource (Maybe Schedule) Source #

The schedule settings for the treatment.

writeTreatmentResource_templateConfiguration :: Lens' WriteTreatmentResource (Maybe TemplateConfiguration) Source #

The message template to use for the treatment.

writeTreatmentResource_treatmentName :: Lens' WriteTreatmentResource (Maybe Text) Source #

A custom name for the treatment.

writeTreatmentResource_treatmentDescription :: Lens' WriteTreatmentResource (Maybe Text) Source #

A custom description of the treatment.

writeTreatmentResource_messageConfiguration :: Lens' WriteTreatmentResource (Maybe MessageConfiguration) Source #

The message configuration settings for the treatment.

writeTreatmentResource_sizePercent :: Lens' WriteTreatmentResource Int Source #

The allocated percentage of users (segment members) to send the treatment to.