File Coverage

blib/lib/Paws/SNS/SetEndpointAttributes.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::SNS::SetEndpointAttributes;
3 1     1   410 use Moose;
  1         3  
  1         9  
4             has Attributes => (is => 'ro', isa => 'Paws::SNS::MapStringToString', required => 1);
5             has EndpointArn => (is => 'ro', isa => 'Str', required => 1);
6              
7 1     1   6045 use MooseX::ClassAttribute;
  1         2  
  1         11  
8              
9             class_has _api_call => (isa => 'Str', is => 'ro', default => 'SetEndpointAttributes');
10             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response');
11             class_has _result_key => (isa => 'Str', is => 'ro');
12             1;
13              
14             ### main pod documentation begin ###
15              
16             =head1 NAME
17              
18             Paws::SNS::SetEndpointAttributes - Arguments for method SetEndpointAttributes on Paws::SNS
19              
20             =head1 DESCRIPTION
21              
22             This class represents the parameters used for calling the method SetEndpointAttributes on the
23             Amazon Simple Notification Service service. Use the attributes of this class
24             as arguments to method SetEndpointAttributes.
25              
26             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SetEndpointAttributes.
27              
28             As an example:
29              
30             $service_obj->SetEndpointAttributes(Att1 => $value1, Att2 => $value2, ...);
31              
32             Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
33              
34             =head1 ATTRIBUTES
35              
36              
37             =head2 B<REQUIRED> Attributes => L<Paws::SNS::MapStringToString>
38              
39             A map of the endpoint attributes. Attributes in this map include the
40             following:
41              
42             =over
43              
44             =item *
45              
46             C<CustomUserData> -- arbitrary user data to associate with the
47             endpoint. Amazon SNS does not use this data. The data must be in UTF-8
48             format and less than 2KB.
49              
50             =item *
51              
52             C<Enabled> -- flag that enables/disables delivery to the endpoint.
53             Amazon SNS will set this to false when a notification service indicates
54             to Amazon SNS that the endpoint is invalid. Users can set it back to
55             true, typically after updating Token.
56              
57             =item *
58              
59             C<Token> -- device token, also referred to as a registration id, for an
60             app and mobile device. This is returned from the notification service
61             when an app and mobile device are registered with the notification
62             service.
63              
64             =back
65              
66              
67              
68              
69             =head2 B<REQUIRED> EndpointArn => Str
70              
71             EndpointArn used for SetEndpointAttributes action.
72              
73              
74              
75              
76             =head1 SEE ALSO
77              
78             This class forms part of L<Paws>, documenting arguments for method SetEndpointAttributes in L<Paws::SNS>
79              
80             =head1 BUGS and CONTRIBUTIONS
81              
82             The source code is located here: https://github.com/pplu/aws-sdk-perl
83              
84             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
85              
86             =cut
87