« blib/lib/Paws/SESv2/PutConfigurationSetSendingOptionsResponse.pm
↑ Summary
blib/lib/Paws/SESv2/PutConfigurationSetSuppressionOptionsResponse.pm »
| 1 | |||
| 2 | package Paws::SESv2::PutConfigurationSetSuppressionOptions; | ||
| 3 | use Moose; | ||
| 4 | has ConfigurationSetName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'ConfigurationSetName', required => 1); | ||
| 5 | has SuppressedReasons => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutConfigurationSetSuppressionOptions'); | ||
| 10 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v2/email/configuration-sets/{ConfigurationSetName}/suppression-options'); | ||
| 11 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SESv2::PutConfigurationSetSuppressionOptionsResponse'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::SESv2::PutConfigurationSetSuppressionOptions - Arguments for method PutConfigurationSetSuppressionOptions on L<Paws::SESv2> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method PutConfigurationSetSuppressionOptions on the | ||
| 24 | L<Amazon Simple Email Service|Paws::SESv2> service. Use the attributes of this class | ||
| 25 | as arguments to method PutConfigurationSetSuppressionOptions. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutConfigurationSetSuppressionOptions. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $email = Paws->service('SESv2'); | ||
| 32 | my $PutConfigurationSetSuppressionOptionsResponse = | ||
| 33 | $email->PutConfigurationSetSuppressionOptions( | ||
| 34 | ConfigurationSetName => 'MyConfigurationSetName', | ||
| 35 | SuppressedReasons => [ | ||
| 36 | 'BOUNCE', ... # values: BOUNCE, COMPLAINT | ||
| 37 | ], # OPTIONAL | ||
| 38 | ); | ||
| 39 | |||
| 40 | 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. | ||
| 41 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/email/PutConfigurationSetSuppressionOptions> | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 B<REQUIRED> ConfigurationSetName => Str | ||
| 47 | |||
| 48 | The name of the configuration set that you want to change the | ||
| 49 | suppression list preferences for. | ||
| 50 | |||
| 51 | |||
| 52 | |||
| 53 | =head2 SuppressedReasons => ArrayRef[Str|Undef] | ||
| 54 | |||
| 55 | A list that contains the reasons that email addresses are automatically | ||
| 56 | added to the suppression list for your account. This list can contain | ||
| 57 | any or all of the following: | ||
| 58 | |||
| 59 | =over | ||
| 60 | |||
| 61 | =item * | ||
| 62 | |||
| 63 | C<COMPLAINT> E<ndash> Amazon SES adds an email address to the | ||
| 64 | suppression list for your account when a message sent to that address | ||
| 65 | results in a complaint. | ||
| 66 | |||
| 67 | =item * | ||
| 68 | |||
| 69 | C<BOUNCE> E<ndash> Amazon SES adds an email address to the suppression | ||
| 70 | list for your account when a message sent to that address results in a | ||
| 71 | hard bounce. | ||
| 72 | |||
| 73 | =back | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head1 SEE ALSO | ||
| 80 | |||
| 81 | This class forms part of L<Paws>, documenting arguments for method PutConfigurationSetSuppressionOptions in L<Paws::SESv2> | ||
| 82 | |||
| 83 | =head1 BUGS and CONTRIBUTIONS | ||
| 84 | |||
| 85 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 86 | |||
| 87 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 88 | |||
| 89 | =cut | ||
| 90 |