user_endpoints

Creates, updates, deletes, gets or lists a user_endpoints resource.

Overview

Name	user_endpoints
Type	Resource
Id	aws.pinpoint.user_endpoints

Fields

The following fields are returned by SELECT queries:

get_user_endpoints

Name	Datatype	Description
item	array	An array of responses, one for each endpoint that's associated with the user ID.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_user_endpoints	select	application-id, user-id, region		Retrieves information about all the endpoints that are associated with a specific user ID.
delete_user_endpoints	delete	application-id, user-id, region		Deletes all the endpoints that are associated with a specific user ID.

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.
region	string	AWS region (default: us-east-1)
user-id	string	The unique identifier for the user.

SELECT examples

get_user_endpoints

Retrieves information about all the endpoints that are associated with a specific user ID.

SELECT
item
FROM aws.pinpoint.user_endpoints
WHERE `application-id` = '{{ application-id }}' -- required
AND `user-id` = '{{ user-id }}' -- required
AND region = '{{ region }}' -- required
;

DELETE examples

delete_user_endpoints

Deletes all the endpoints that are associated with a specific user ID.

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