blib/lib/Paws/SESv2/ListContacts.pm untested

filter: Statementstmt 0.0% 0 / 17 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 19 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::SESv2::ListContacts;
3 use Moose;
4 has ContactListName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'ContactListName', required => 1);
5 has Filter => (is => 'ro', isa => 'Paws::SESv2::ListContactsFilter');
6 has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'NextToken');
7 has PageSize => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'PageSize');
8  
9 use MooseX::ClassAttribute;
10  
11 class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListContacts');
12 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v2/email/contact-lists/{ContactListName}/contacts');
13 class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET');
14 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SESv2::ListContactsResponse');
15 1;
16  
17 ### main pod documentation begin ###
18  
19 =head1 NAME
20  
21 Paws::SESv2::ListContacts - Arguments for method ListContacts on L<Paws::SESv2>
22  
23 =head1 DESCRIPTION
24  
25 This class represents the parameters used for calling the method ListContacts on the
26 L<Amazon Simple Email Service|Paws::SESv2> service. Use the attributes of this class
27 as arguments to method ListContacts.
28  
29 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListContacts.
30  
31 =head1 SYNOPSIS
32  
33 my $email = Paws->service('SESv2');
34 my $ListContactsResponse = $email->ListContacts(
35 ContactListName => 'MyContactListName',
36 Filter => {
37 FilteredStatus => 'OPT_IN', # values: OPT_IN, OPT_OUT; OPTIONAL
38 TopicFilter => {
39 TopicName => 'MyTopicName', # OPTIONAL
40 UseDefaultIfPreferenceUnavailable => 1, # OPTIONAL
41 }, # OPTIONAL
42 }, # OPTIONAL
43 NextToken => 'MyNextToken', # OPTIONAL
44 PageSize => 1, # OPTIONAL
45 );
46  
47 # Results:
48 my $Contacts = $ListContactsResponse->Contacts;
49 my $NextToken = $ListContactsResponse->NextToken;
50  
51 # Returns a L<Paws::SESv2::ListContactsResponse> object.
52  
53 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.
54 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/email/ListContacts>
55  
56 =head1 ATTRIBUTES
57  
58  
59 =head2 B<REQUIRED> ContactListName => Str
60  
61 The name of the contact list.
62  
63  
64  
65 =head2 Filter => L<Paws::SESv2::ListContactsFilter>
66  
67 A filter that can be applied to a list of contacts.
68  
69  
70  
71 =head2 NextToken => Str
72  
73 A string token indicating that there might be additional contacts
74 available to be listed. Use the token provided in the Response to use
75 in the subsequent call to ListContacts with the same parameters to
76 retrieve the next page of contacts.
77  
78  
79  
80 =head2 PageSize => Int
81  
82 The number of contacts that may be returned at once, which is dependent
83 on if there are more or less contacts than the value of the PageSize.
84 Use this parameter to paginate results. If additional contacts exist
85 beyond the specified limit, the C<NextToken> element is sent in the
86 response. Use the C<NextToken> value in subsequent requests to retrieve
87 additional contacts.
88  
89  
90  
91  
92 =head1 SEE ALSO
93  
94 This class forms part of L<Paws>, documenting arguments for method ListContacts in L<Paws::SESv2>
95  
96 =head1 BUGS and CONTRIBUTIONS
97  
98 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
99  
100 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
101  
102 =cut
103