The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Paws::Pinpoint::PublicEndpoint

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::Pinpoint::PublicEndpoint object:

  $service_obj->Method(Att1 => { Address => $value, ..., User => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::PublicEndpoint object:

  $result = $service_obj->Method(...);
  $result->Att1->Address

DESCRIPTION

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

ATTRIBUTES

Address => Str

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

Attributes => Paws::Pinpoint::MapOfListOf__string

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.

ChannelType => Str

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

Demographic => Paws::Pinpoint::EndpointDemographic

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

EffectiveDate => Str

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

EndpointStatus => 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.

Location => Paws::Pinpoint::EndpointLocation

The geographic information for the endpoint.

Metrics => Paws::Pinpoint::MapOf__double

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

OptOut => 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.

RequestId => Str

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

User => Paws::Pinpoint::EndpointUser

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

SEE ALSO

This class forms part of Paws, describing an object used in Paws::Pinpoint

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues