endpoints

Creates, updates, deletes, gets or lists an endpoints resource.

Overview

Name	endpoints
Type	Resource
Id	aws.pinpoint.endpoints

Fields

The following fields are returned by SELECT queries:

get_endpoint

Name	Datatype	Description
address	string	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.
application_id	string	The unique identifier for the application that's associated with the endpoint.
attributes	object	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.
channel_type	string	The channel that's used when sending messages or push notifications to the endpoint. (PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM, IN_APP)
cohort_id	string	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.
creation_date	string	The date and time, in ISO 8601 format, when the endpoint was created.
demographic	object	The demographic information for the endpoint, such as the time zone and platform.
effective_date	string	The date and time, in ISO 8601 format, when the endpoint was last updated.
endpoint_status	string	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.
id	string	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.
location	object	The geographic information for the endpoint.
metrics	object	One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
opt_out	string	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.
request_id	string	The unique identifier for the most recent request to update the endpoint.
user	object	One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_endpoint	select	application-id, endpoint-id, region		Retrieves information about the settings and attributes of a specific endpoint for an application.
update_endpoint	update	application-id, endpoint-id, region, EndpointRequest		Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes for an endpoint. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.
update_endpoints_batch	update	application-id, region, EndpointBatchRequest		Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes for a batch of endpoints. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.
delete_endpoint	delete	application-id, endpoint-id, region		Deletes an endpoint from an application.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
application-id	string	The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
endpoint-id	string	The case insensitive unique identifier for the endpoint. The identifier can't contain $, { or }.
region	string	AWS region (default: us-east-1)

SELECT examples

get_endpoint

Retrieves information about the settings and attributes of a specific endpoint for an application.

SELECT
address,
application_id,
attributes,
channel_type,
cohort_id,
creation_date,
demographic,
effective_date,
endpoint_status,
id,
location,
metrics,
opt_out,
request_id,
user
FROM aws.pinpoint.endpoints
WHERE `application-id` = '{{ application-id }}' -- required
AND `endpoint-id` = '{{ endpoint-id }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_endpoint

Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes for an endpoint. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.

UPDATE aws.pinpoint.endpoints
SET 
EndpointRequest = '{{ EndpointRequest }}'
WHERE 
`application-id` = '{{ application-id }}' --required
AND `endpoint-id` = '{{ endpoint-id }}' --required
AND region = '{{ region }}' --required
AND EndpointRequest = '{{ EndpointRequest }}' --required
RETURNING
message_body;

update_endpoints_batch

Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes for a batch of endpoints. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.

UPDATE aws.pinpoint.endpoints
SET 
EndpointBatchRequest = '{{ EndpointBatchRequest }}'
WHERE 
`application-id` = '{{ application-id }}' --required
AND region = '{{ region }}' --required
AND EndpointBatchRequest = '{{ EndpointBatchRequest }}' --required
RETURNING
message_body;

DELETE examples

delete_endpoint

Deletes an endpoint from an application.

DELETE FROM aws.pinpoint.endpoints
WHERE `application-id` = '{{ application-id }}' --required
AND `endpoint-id` = '{{ endpoint-id }}' --required
AND region = '{{ region }}' --required
;