pinpoint

Implementation details for API pinpoint

Coverage Overview


AvailabilityTesting*
OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
CreateApp✔️pro✔️✔️✔️✔️Show Tests
CreateCampaign
CreateEmailTemplate
CreateExportJob
CreateImportJob
CreateInAppTemplate
CreateJourney
CreatePushTemplate
CreateRecommenderConfiguration
CreateSegment
CreateSmsTemplate
CreateVoiceTemplate
DeleteAdmChannel
DeleteApnsChannel
DeleteApnsSandboxChannel
DeleteApnsVoipChannel
DeleteApnsVoipSandboxChannel
DeleteApp✔️pro✔️✔️✔️✔️Show Tests
DeleteBaiduChannel
DeleteCampaign
DeleteEmailChannel
DeleteEmailTemplate
DeleteEndpoint
DeleteEventStream✔️pro✔️
DeleteGcmChannel
DeleteInAppTemplate
DeleteJourney
DeletePushTemplate
DeleteRecommenderConfiguration
DeleteSegment
DeleteSmsChannel
DeleteSmsTemplate
DeleteUserEndpoints
DeleteVoiceChannel
DeleteVoiceTemplate
GetAdmChannel
GetApnsChannel
GetApnsSandboxChannel
GetApnsVoipChannel
GetApnsVoipSandboxChannel
GetApp✔️pro✔️✔️✔️✔️Show Tests
GetApplicationDateRangeKpi
GetApplicationSettings✔️pro✔️
GetApps✔️pro✔️
GetBaiduChannel
GetCampaign
GetCampaignActivities
GetCampaignDateRangeKpi
GetCampaignVersion
GetCampaignVersions
GetCampaigns
GetChannels
GetEmailChannel
GetEmailTemplate
GetEndpoint
GetEventStream✔️pro✔️
GetExportJob
GetExportJobs
GetGcmChannel
GetImportJob
GetImportJobs
GetInAppMessages
GetInAppTemplate
GetJourney
GetJourneyDateRangeKpi
GetJourneyExecutionActivityMetrics
GetJourneyExecutionMetrics
GetJourneyRunExecutionActivityMetrics
GetJourneyRunExecutionMetrics
GetJourneyRuns
GetPushTemplate
GetRecommenderConfiguration
GetRecommenderConfigurations
GetSegment
GetSegmentExportJobs
GetSegmentImportJobs
GetSegmentVersion
GetSegmentVersions
GetSegments
GetSmsChannel
GetSmsTemplate
GetUserEndpoints
GetVoiceChannel
GetVoiceTemplate
ListJourneys
ListTagsForResource✔️pro✔️
ListTemplateVersions
ListTemplates
PhoneNumberValidate
PutEventStream✔️pro✔️
PutEvents
RemoveAttributes
SendMessages
SendOTPMessage
SendUsersMessages
TagResource✔️pro✔️
UntagResource✔️pro✔️
UpdateAdmChannel
UpdateApnsChannel
UpdateApnsSandboxChannel
UpdateApnsVoipChannel
UpdateApnsVoipSandboxChannel
UpdateApplicationSettings✔️pro✔️
UpdateBaiduChannel
UpdateCampaign
UpdateEmailChannel
UpdateEmailTemplate
UpdateEndpoint
UpdateEndpointsBatch
UpdateGcmChannel
UpdateInAppTemplate
UpdateJourney
UpdateJourneyState
UpdatePushTemplate
UpdateRecommenderConfiguration
UpdateSegment
UpdateSmsChannel
UpdateSmsTemplate
UpdateTemplateActiveVersion
UpdateVoiceChannel
UpdateVoiceTemplate
VerifyOTPMessage

Terminology

  • Internal Test Suite: tested by LocalStack's internal integration test suite
  • External Test Suite: covered by an external integration test suite, that runs against LocalStack
  • Terraform Validated: operation tested with Terraform
  • AWS Validated: the integration test that includes this operation call was validated against AWS
  • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

Testing Details

This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

How to read the test details?

For each operation we put up a list of the related integration test cases.
Those operation calls have been recorded during the exeuction of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

  • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
  • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
    • test name
    • status code returned (which is the expected one for the test case)
    • information about validation:
      • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
      • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


CreateApp

Parameters: CreateApplicationRequest
  • LocalStack Pro
    • test_pinpoint_app_operations LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpoint::test_pinpoint_app_operations HTTP Status Code: 201 AWS validated Snapshot Tested

DeleteApp

Parameters: ApplicationId
  • LocalStack Pro
    • test_pinpoint_app_operations LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpoint::test_pinpoint_app_operations HTTP Status Code: 200 AWS validated Snapshot Tested

GetApp

Parameters: ApplicationId
  • LocalStack Pro
    • test_pinpoint_app_operations LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpoint::test_pinpoint_app_operations HTTP Status Code: 200 AWS validated Snapshot Tested


Last modified February 5, 2024: update generated parity coverage docs (#1056) (03947bf90)