Documentation

Specifies the properties and attributes of an endpoint that's associated with an event.

See: newPublicEndpoint smart constructor.

Create a value of PublicEndpoint with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:requestId:PublicEndpoint', publicEndpoint_requestId - A unique identifier that's generated each time the endpoint is updated.

$sel:metrics:PublicEndpoint', publicEndpoint_metrics - One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

$sel:location:PublicEndpoint', publicEndpoint_location - The geographic information for the endpoint.

$sel:demographic:PublicEndpoint', publicEndpoint_demographic - The demographic information for the endpoint, such as the time zone and platform.

$sel:address:PublicEndpoint', publicEndpoint_address - The unique identifier for the recipient, such as a device token, email address, or mobile phone number.

$sel:effectiveDate:PublicEndpoint', publicEndpoint_effectiveDate - The date and time, in ISO 8601 format, when the endpoint was last updated.

$sel:user:PublicEndpoint', publicEndpoint_user - One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

$sel:attributes:PublicEndpoint', publicEndpoint_attributes - One or more custom attributes that describe the endpoint by associating a name with an array of values. You can use these attributes as filter criteria when you create segments.

$sel:endpointStatus:PublicEndpoint', publicEndpoint_endpointStatus - Specifies whether to send messages or push notifications to the endpoint. Valid 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.

$sel:optOut:PublicEndpoint', publicEndpoint_optOut - 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.

$sel:channelType:PublicEndpoint', publicEndpoint_channelType - The channel that's used when sending messages or push notifications to the endpoint.

A unique identifier that's generated each time the endpoint is updated.

One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

The geographic information for the endpoint.

The demographic information for the endpoint, such as the time zone and platform.

The unique identifier for the recipient, such as a device token, email address, or mobile phone number.

The date and time, in ISO 8601 format, when the endpoint was last updated.

One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

One or more custom attributes that describe the endpoint by associating a name with an array of values. You can use these attributes as filter criteria when you create segments.

Specifies whether to send messages or push notifications to the endpoint. Valid 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.

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.

The channel that's used when sending messages or push notifications to the endpoint.