Struct aws_sdk_pinpoint::model::EndpointBatchItem

#[non_exhaustive]
pub struct EndpointBatchItem {
    pub address: Option<String>,
    pub attributes: Option<HashMap<String, Vec<String>>>,
    pub channel_type: Option<ChannelType>,
    pub demographic: Option<EndpointDemographic>,
    pub effective_date: Option<String>,
    pub endpoint_status: Option<String>,
    pub id: Option<String>,
    pub location: Option<EndpointLocation>,
    pub metrics: Option<HashMap<String, f64>>,
    pub opt_out: Option<String>,
    pub request_id: Option<String>,
    pub user: Option<EndpointUser>,
}

Specifies an endpoint to create or update and the settings and attributes to set or change for the endpoint.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

address: Option<String>

The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.

attributes: Option<HashMap<String, Vec<String>>>

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. Attribute names are case sensitive.

An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.

channel_type: Option<ChannelType>

The channel to use when sending messages or push notifications to the endpoint.

demographic: Option<EndpointDemographic>

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

effective_date: Option<String>

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

endpoint_status: Option<String>

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.

id: Option<String>

The unique identifier for the endpoint in the context of the batch.

location: Option<EndpointLocation>

The geographic information for the endpoint.

metrics: Option<HashMap<String, f64>>

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

opt_out: Option<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: Option<String>

The unique identifier for the request to create or update the endpoint.

user: Option<EndpointUser>

One or more custom attributes that describe the user who's associated with the endpoint.

Implementations

impl EndpointBatchItem

pub fn address(&self) -> Option<&str>

The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.

pub fn attributes(&self) -> Option<&HashMap<String, Vec<String>>>

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. Attribute names are case sensitive.

An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.

pub fn channel_type(&self) -> Option<&ChannelType>

The channel to use when sending messages or push notifications to the endpoint.

pub fn demographic(&self) -> Option<&EndpointDemographic>

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

pub fn effective_date(&self) -> Option<&str>

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

pub fn endpoint_status(&self) -> Option<&str>

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.

pub fn id(&self) -> Option<&str>

The unique identifier for the endpoint in the context of the batch.

pub fn location(&self) -> Option<&EndpointLocation>

The geographic information for the endpoint.

pub fn metrics(&self) -> Option<&HashMap<String, f64>>

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

pub fn opt_out(&self) -> Option<&str>

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.

pub fn request_id(&self) -> Option<&str>

The unique identifier for the request to create or update the endpoint.

pub fn user(&self) -> Option<&EndpointUser>

One or more custom attributes that describe the user who's associated with the endpoint.

impl EndpointBatchItem

pub fn builder() -> Builder

Creates a new builder-style object to manufacture EndpointBatchItem

Trait Implementations

impl Clone for EndpointBatchItem

fn clone(&self) -> EndpointBatchItem

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EndpointBatchItem

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<EndpointBatchItem> for EndpointBatchItem

fn eq(&self, other: &EndpointBatchItem) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &EndpointBatchItem) -> bool

This method tests for !=.

impl StructuralPartialEq for EndpointBatchItem