« blib/lib/Paws/SESv2/CreateConfigurationSetResponse.pm
↑ Summary
blib/lib/Paws/SESv2/CreateContactList.pm »
| 1 | |||
| 2 | package Paws::SESv2::CreateContact; | ||
| 3 | use Moose; | ||
| 4 | has AttributesData => (is => 'ro', isa => 'Str'); | ||
| 5 | has ContactListName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'ContactListName', required => 1); | ||
| 6 | has EmailAddress => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has TopicPreferences => (is => 'ro', isa => 'ArrayRef[Paws::SESv2::TopicPreference]'); | ||
| 8 | has UnsubscribeAll => (is => 'ro', isa => 'Bool'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateContact'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v2/email/contact-lists/{ContactListName}/contacts'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SESv2::CreateContactResponse'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::SESv2::CreateContact - Arguments for method CreateContact on L<Paws::SESv2> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method CreateContact on the | ||
| 27 | L<Amazon Simple Email Service|Paws::SESv2> service. Use the attributes of this class | ||
| 28 | as arguments to method CreateContact. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateContact. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $email = Paws->service('SESv2'); | ||
| 35 | my $CreateContactResponse = $email->CreateContact( | ||
| 36 | ContactListName => 'MyContactListName', | ||
| 37 | EmailAddress => 'MyEmailAddress', | ||
| 38 | AttributesData => 'MyAttributesData', # OPTIONAL | ||
| 39 | TopicPreferences => [ | ||
| 40 | { | ||
| 41 | SubscriptionStatus => 'OPT_IN', # values: OPT_IN, OPT_OUT | ||
| 42 | TopicName => 'MyTopicName', | ||
| 43 | |||
| 44 | }, | ||
| 45 | ... | ||
| 46 | ], # OPTIONAL | ||
| 47 | UnsubscribeAll => 1, # OPTIONAL | ||
| 48 | ); | ||
| 49 | |||
| 50 | 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. | ||
| 51 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/email/CreateContact> | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 AttributesData => Str | ||
| 57 | |||
| 58 | The attribute data attached to a contact. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> ContactListName => Str | ||
| 63 | |||
| 64 | The name of the contact list to which the contact should be added. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 B<REQUIRED> EmailAddress => Str | ||
| 69 | |||
| 70 | The contact's email address. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 TopicPreferences => ArrayRef[L<Paws::SESv2::TopicPreference>] | ||
| 75 | |||
| 76 | The contact's preferences for being opted-in to or opted-out of topics. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 UnsubscribeAll => Bool | ||
| 81 | |||
| 82 | A boolean value status noting if the contact is unsubscribed from all | ||
| 83 | contact list topics. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head1 SEE ALSO | ||
| 89 | |||
| 90 | This class forms part of L<Paws>, documenting arguments for method CreateContact in L<Paws::SESv2> | ||
| 91 | |||
| 92 | =head1 BUGS and CONTRIBUTIONS | ||
| 93 | |||
| 94 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 95 | |||
| 96 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 97 | |||
| 98 | =cut | ||
| 99 |