Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

Preferences
Contact Us
Feedback
AWS Documentation
Create an AWS Account

Troubleshooting

PDF
RSS
Focus mode
Troubleshooting - Amazon Pinpoint
CLI examples of common tasks
Note

The following troubleshooting topics have been moved:

Become familiar with troubleshooting information and possible solutions to help resolve issues when using Amazon Pinpoint.

Monitoring and logging

As a best practice, consider logging events in Amazon Pinpoint by:

CLI examples of common tasks

The following examples are common CLI commands for Amazon Pinpoint.

  • Get Endpoint Data: get-endpoint CLI

    aws pinpoint get-endpoint —application-id AppId —endpoint-id EndpointId
    In the preceding command, make the following changes:

    • Replace AppId with the ID of the Amazon Pinpoint project that contains the endpoint.

    • Replace EndpointId with the ID of an existing endpoint that you're retrieving.

  • Get User Data: get-user-endpoints CLI

    aws pinpoint get-user-endpoints —application-id AppId —user-id UserId
    In the preceding command, make the following changes:

    • Replace AppId with the ID of the Amazon Pinpoint project that contains the endpoint.

    • Replace UserId with the ID of the user.

  • Update or Create New Endpoint: update-endpoint CLI

    aws pinpoint update-endpoint —application-id AppId —endpoint-id EndpointId —endpoint-request '{"ChannelType":"SMS","Address":"+12345678","Location":{"Country":"USA"},"User":{"UserId":"UserId"}}'
    In the preceding command, make the following changes:

    • Replace AppId with the ID of the Amazon Pinpoint project that contains the endpoint.

    • Replace EndpointId with the ID of an existing endpoint that you're creating or updating.

    • Replace UserId with the ID of the user.

  • Delete Endpoint: delete-endpoint CLI

    aws pinpoint delete-endpoint —application-id AppId —endpoint-id EndpointId
    In the preceding command, make the following changes:

    • Replace AppId with the ID of the Amazon Pinpoint project that contains the endpoint.

    • Replace EndpointId with the ID of an existing endpoint that you're deleting.

  • Validate a phone number: phone-number-validate CLI

    aws pinpoint phone-number-validate —number-validate-request PhoneNumber=+12065550100
    In the preceding command, make the following changes:

    • Replace +12065550100 with the phone number that you want to validate.

  • send-messages Examples CLI: SMS to a number

    aws pinpoint send-messages --application-id AppID --message-request '{"MessageConfiguration": {"SMSMessage":{"Body":"This is a test message"}},"Addresses": {"DestinationPhoneNumber": {"ChannelType":"SMS"}}}‘
    In the preceding command, make the following changes:

    • Replace AppId with the ID of the Amazon Pinpoint project that contains the endpoint.

    • Replace DestinationPhoneNumber with the phone number that you want to send to.

  • send-messages Examples CLI: origination number to SMS

    aws pinpoint send-messages --application-id AppID --message-request '{"MessageConfiguration": {"SMSMessage":{"Body":"hello, how are you?","OriginationNumber": "OriginPhoneNumber"}},"Addresses": {"DestinationPhoneNumber": {"ChannelType":"SMS"}}}‘
    In the preceding command, make the following changes:

    • Replace AppId with the ID of the Amazon Pinpoint project that contains the endpoint.

    • Replace OriginPhoneNumber with the phone number that you want to send the message from.

    • Replace DestinationPhoneNumber with the phone number that you want to send to.

  • send-messages Examples CLI: SMS to an endpoint

    aws pinpoint send-messages —application-id AppID  —message-request '{"MessageConfiguration": {"SMSMessage":{"Body":"This is a test message"}},"Endpoints": {"EndPointId": {}}}'
    In the preceding command, make the following changes:

    • Replace AppId with the ID of the Amazon Pinpoint project that contains the endpoint.

    • Replace EndPointId with the ID of an existing endpoint that you're sending to.

  • send-messages Examples CLI: SMS to a userId

    aws pinpoint send-users-messages —application-id AppID —send-users-message-request '{"MessageConfiguration": {"SMSMessage":{"Body":"This is a test"}},"Users": {"UserId": {}}}'
    In the preceding command, make the following changes:

    • Replace AppId with the ID of the Amazon Pinpoint project that contains the endpoint.

    • Replace UserId with the ID of the user.

  • Campaign Creation With Amazon Pinpoint message templates create-campaign CLI

    aws pinpoint create-campaign —application-id AppId —write-campaign-request file://campaignclirequest.json 

file://campaignclirequest.json 
{
	"Description": "CLITestCampaign",
	"HoldoutPercent": 0,
	"MessageConfiguration": 
	{
		"DefaultMessage": 
		{
			"Body": "TestFromCLI"
		}
	},
	"Name": "TestingCLICampaign",
	"Schedule": 
	{
		"StartTime": "IMMEDIATE"
	},
	"TemplateConfiguration": 
		{
		"EmailTemplate": 
			{
			"Name": "TemplateName",
			"Version": "Version"
			}
		},
	"SegmentId": "SegmentID",
	"SegmentVersion": 1
}
    In the preceding command and file, make the following changes:

    • Replace AppId with the ID of the Amazon Pinpoint project that contains the endpoint.

    • Replace TemplateName with the name of the template.

    • Replace Version with the version of the template.

    • Replace SegmentID with the ID of the segment to target.

On this page

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.