pinpoint
Implementation details for API pinpoint
Coverage Overview
| Availability | Testing* | |||||||
|---|---|---|---|---|---|---|---|---|
| Operation | Implemented | Image | Internal Test Suite | External Test Suite | Terraform Validated | AWS Validated | Snapshot Tested | Details |
| 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 | ✔️ | pro | ✔️ | ✔️ | Show Tests | |||
| DeleteEventStream | ✔️ | pro | ✔️ | |||||
| DeleteGcmChannel | ||||||||
| DeleteInAppTemplate | ||||||||
| DeleteJourney | ||||||||
| DeletePushTemplate | ||||||||
| DeleteRecommenderConfiguration | ||||||||
| DeleteSegment | ||||||||
| DeleteSmsChannel | ✔️ | pro | ✔️ | ✔️ | ✔️ | Show Tests | ||
| 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 | ✔️ | pro | ✔️ | ✔️ | Show Tests | |||
| 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 | ✔️ | pro | ✔️ | ✔️ | ✔️ | Show Tests | ||
| GetSmsTemplate | ||||||||
| GetUserEndpoints | ||||||||
| GetVoiceChannel | ||||||||
| GetVoiceTemplate | ||||||||
| ListJourneys | ||||||||
| ListTagsForResource | ✔️ | pro | ✔️ | |||||
| ListTemplateVersions | ||||||||
| ListTemplates | ||||||||
| PhoneNumberValidate | ||||||||
| PutEventStream | ✔️ | pro | ✔️ | |||||
| PutEvents | ||||||||
| RemoveAttributes | ||||||||
| SendMessages | ||||||||
| SendOTPMessage | ✔️ | pro | ✔️ | ✔️ | ✔️ | Show Tests | ||
| SendUsersMessages | ||||||||
| TagResource | ✔️ | pro | ✔️ | |||||
| UntagResource | ✔️ | pro | ✔️ | |||||
| UpdateAdmChannel | ||||||||
| UpdateApnsChannel | ||||||||
| UpdateApnsSandboxChannel | ||||||||
| UpdateApnsVoipChannel | ||||||||
| UpdateApnsVoipSandboxChannel | ||||||||
| UpdateApplicationSettings | ✔️ | pro | ✔️ | |||||
| UpdateBaiduChannel | ||||||||
| UpdateCampaign | ||||||||
| UpdateEmailChannel | ||||||||
| UpdateEmailTemplate | ||||||||
| UpdateEndpoint | ✔️ | pro | ✔️ | ✔️ | Show Tests | |||
| UpdateEndpointsBatch | ||||||||
| UpdateGcmChannel | ||||||||
| UpdateInAppTemplate | ||||||||
| UpdateJourney | ||||||||
| UpdateJourneyState | ||||||||
| UpdatePushTemplate | ||||||||
| UpdateRecommenderConfiguration | ||||||||
| UpdateSegment | ||||||||
| UpdateSmsChannel | ✔️ | pro | ✔️ | ✔️ | ✔️ | Show Tests | ||
| UpdateSmsTemplate | ||||||||
| UpdateTemplateActiveVersion | ||||||||
| UpdateVoiceChannel | ||||||||
| UpdateVoiceTemplate | ||||||||
| VerifyOTPMessage | ✔️ | pro | ✔️ | ✔️ | ✔️ | Show Tests | ||
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 execution 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.
Those operation calls have been recorded during the execution 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_debug_endpoint LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestOTP::test_debug_endpoint HTTP Status Code: 201
- test_otp_happy_path LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestOTP::test_otp_happy_path HTTP Status Code: 201
- test_otp_validation_maximum_attempts LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestOTP::test_otp_validation_maximum_attempts HTTP Status Code: 201
- test_otp_validation_outside_validity LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestOTP::test_otp_validation_outside_validity HTTP Status Code: 201
- test_send_otp_message_request_validation LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestOTP::test_send_otp_message_request_validation HTTP Status Code: 201 AWS validated Snapshot Tested
- test_verify_otp_message_request_validation LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestOTP::test_verify_otp_message_request_validation HTTP Status Code: 201 AWS validated Snapshot Tested
- 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
- test_crud LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpointEndpoints::test_crud HTTP Status Code: 201 AWS validated
- test_delete_app_also_deletes_endpoints LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpointEndpoints::test_delete_app_also_deletes_endpoints HTTP Status Code: 201 AWS validated
- test_pinpoint_sms_channel_lifecycle LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpointSMSChannel::test_pinpoint_sms_channel_lifecycle HTTP Status Code: 201 AWS validated Snapshot Tested
- test_pinpoint_sms_channel_multiple_delete LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpointSMSChannel::test_pinpoint_sms_channel_multiple_delete HTTP Status Code: 201 AWS validated Snapshot Tested
- test_pinpoint_sms_channel_versions LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpointSMSChannel::test_pinpoint_sms_channel_versions HTTP Status Code: 201 AWS validated Snapshot Tested
- test_pinpoint_update_sms_channel_validation LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpointSMSChannel::test_pinpoint_update_sms_channel_validation HTTP Status Code: 201 AWS validated Snapshot Tested
DeleteApp
Parameters: ApplicationId
- LocalStack Pro
- test_debug_endpoint LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestOTP::test_debug_endpoint HTTP Status Code: 200
- test_otp_happy_path LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestOTP::test_otp_happy_path HTTP Status Code: 200
- test_otp_validation_maximum_attempts LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestOTP::test_otp_validation_maximum_attempts HTTP Status Code: 200
- test_otp_validation_outside_validity LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestOTP::test_otp_validation_outside_validity HTTP Status Code: 200
- test_send_otp_message_request_validation LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestOTP::test_send_otp_message_request_validation HTTP Status Code: 200 AWS validated Snapshot Tested
- test_verify_otp_message_request_validation LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestOTP::test_verify_otp_message_request_validation HTTP Status Code: 200 AWS validated Snapshot Tested
- 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
- test_crud LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpointEndpoints::test_crud HTTP Status Code: 200 AWS validated
- test_delete_app_also_deletes_endpoints LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpointEndpoints::test_delete_app_also_deletes_endpoints HTTP Status Code: 200 AWS validated
- test_pinpoint_sms_channel_lifecycle LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpointSMSChannel::test_pinpoint_sms_channel_lifecycle HTTP Status Code: 200 AWS validated Snapshot Tested
- test_pinpoint_sms_channel_multiple_delete LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpointSMSChannel::test_pinpoint_sms_channel_multiple_delete HTTP Status Code: 200 AWS validated Snapshot Tested
- test_pinpoint_sms_channel_versions LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpointSMSChannel::test_pinpoint_sms_channel_versions HTTP Status Code: 200 AWS validated Snapshot Tested
- test_pinpoint_update_sms_channel_validation LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpointSMSChannel::test_pinpoint_update_sms_channel_validation HTTP Status Code: 200 AWS validated Snapshot Tested
- test_debug_endpoint LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestOTP::test_debug_endpoint HTTP Status Code: 404 (NotFoundException)
- test_pinpoint_app_operations LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpoint::test_pinpoint_app_operations HTTP Status Code: 404 (NotFoundException) AWS validated Snapshot Tested
- test_pinpoint_app_operations_on_non_existent_app LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpoint::test_pinpoint_app_operations_on_non_existent_app HTTP Status Code: 404 (NotFoundException) AWS validated Snapshot Tested
DeleteEndpoint
Parameters: ApplicationId, EndpointId
- LocalStack Pro
- test_crud LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpointEndpoints::test_crud HTTP Status Code: 202 AWS validated
- test_delete_app_also_deletes_endpoints LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpointEndpoints::test_delete_app_also_deletes_endpoints HTTP Status Code: 202 AWS validated
DeleteSmsChannel
Parameters: ApplicationId
- LocalStack Pro
- test_pinpoint_sms_channel_lifecycle LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpointSMSChannel::test_pinpoint_sms_channel_lifecycle HTTP Status Code: 200 AWS validated Snapshot Tested
- test_pinpoint_sms_channel_multiple_delete LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpointSMSChannel::test_pinpoint_sms_channel_multiple_delete HTTP Status Code: 200 AWS validated Snapshot Tested
- test_pinpoint_sms_channel_versions LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpointSMSChannel::test_pinpoint_sms_channel_versions HTTP Status Code: 200 AWS validated Snapshot Tested
- test_pinpoint_sms_channel_non_existent_app LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpointSMSChannel::test_pinpoint_sms_channel_non_existent_app HTTP Status Code: 404 (NotFoundException) 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
- test_pinpoint_app_operations_on_non_existent_app LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpoint::test_pinpoint_app_operations_on_non_existent_app HTTP Status Code: 404 (NotFoundException) AWS validated Snapshot Tested
GetEndpoint
Parameters: ApplicationId, EndpointId
- LocalStack Pro
- test_crud LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpointEndpoints::test_crud HTTP Status Code: 200 AWS validated
- test_crud LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpointEndpoints::test_crud HTTP Status Code: 404 (NotFoundException) AWS validated
- test_delete_app_also_deletes_endpoints LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpointEndpoints::test_delete_app_also_deletes_endpoints HTTP Status Code: 404 (NotFoundException) AWS validated
GetSmsChannel
Parameters: ApplicationId
- LocalStack Pro
- test_pinpoint_sms_channel_lifecycle LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpointSMSChannel::test_pinpoint_sms_channel_lifecycle HTTP Status Code: 200 AWS validated Snapshot Tested
- test_pinpoint_sms_channel_lifecycle LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpointSMSChannel::test_pinpoint_sms_channel_lifecycle HTTP Status Code: 404 (NotFoundException) AWS validated Snapshot Tested
- test_pinpoint_sms_channel_non_existent_app LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpointSMSChannel::test_pinpoint_sms_channel_non_existent_app HTTP Status Code: 404 (NotFoundException) AWS validated Snapshot Tested
SendOTPMessage
Parameters: ApplicationId, SendOTPMessageRequestParameters
- LocalStack Pro
- test_debug_endpoint LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestOTP::test_debug_endpoint HTTP Status Code: 200
- test_otp_happy_path LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestOTP::test_otp_happy_path HTTP Status Code: 200
- test_otp_validation_maximum_attempts LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestOTP::test_otp_validation_maximum_attempts HTTP Status Code: 200
- test_otp_validation_outside_validity LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestOTP::test_otp_validation_outside_validity HTTP Status Code: 200
- test_send_otp_message_request_validation LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestOTP::test_send_otp_message_request_validation HTTP Status Code: 400 (BadRequestException) AWS validated Snapshot Tested
- test_send_otp_message_request_validation LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestOTP::test_send_otp_message_request_validation HTTP Status Code: 404 (NotFoundException) AWS validated Snapshot Tested
UpdateEndpoint
Parameters: ApplicationId, EndpointId, EndpointRequest
- LocalStack Pro
- test_crud LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpointEndpoints::test_crud HTTP Status Code: 202 AWS validated
- test_delete_app_also_deletes_endpoints LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpointEndpoints::test_delete_app_also_deletes_endpoints HTTP Status Code: 202 AWS validated
UpdateSmsChannel
Parameters: ApplicationId, SMSChannelRequest
- LocalStack Pro
- test_pinpoint_sms_channel_lifecycle LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpointSMSChannel::test_pinpoint_sms_channel_lifecycle HTTP Status Code: 200 AWS validated Snapshot Tested
- test_pinpoint_sms_channel_versions LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpointSMSChannel::test_pinpoint_sms_channel_versions HTTP Status Code: 200 AWS validated Snapshot Tested
- test_pinpoint_update_sms_channel_validation LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpointSMSChannel::test_pinpoint_update_sms_channel_validation HTTP Status Code: 200 AWS validated Snapshot Tested
- test_pinpoint_update_sms_channel_validation LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpointSMSChannel::test_pinpoint_update_sms_channel_validation HTTP Status Code: 400 (BadRequestException) AWS validated Snapshot Tested
- test_pinpoint_sms_channel_non_existent_app LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestPinpointSMSChannel::test_pinpoint_sms_channel_non_existent_app HTTP Status Code: 404 (NotFoundException) AWS validated Snapshot Tested
VerifyOTPMessage
Parameters: ApplicationId, VerifyOTPMessageRequestParameters
- LocalStack Pro
- test_debug_endpoint LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestOTP::test_debug_endpoint HTTP Status Code: 200
- test_otp_happy_path LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestOTP::test_otp_happy_path HTTP Status Code: 200
- test_otp_validation_maximum_attempts LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestOTP::test_otp_validation_maximum_attempts HTTP Status Code: 200
- test_otp_validation_outside_validity LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestOTP::test_otp_validation_outside_validity HTTP Status Code: 200
- test_verify_otp_message_request_validation LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestOTP::test_verify_otp_message_request_validation HTTP Status Code: 400 (BadRequestException) AWS validated Snapshot Tested
- test_verify_otp_message_request_validation LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestOTP::test_verify_otp_message_request_validation HTTP Status Code: 404 (NotFoundException) AWS validated Snapshot Tested
- test_otp_validation_outside_validity LocalStack Pro: tests/aws/services/pinpoint/test_pinpoint.py::TestOTP::test_otp_validation_outside_validity HTTP Status Code: 500 (InternalError)