« blib/lib/Paws/SESv2/ListManagementOptions.pm
↑ Summary
blib/lib/Paws/SESv2/ListSuppressedDestinationsResponse.pm »
| 1 | |||
| 2 | package Paws::SESv2::ListSuppressedDestinations; | ||
| 3 | use Moose; | ||
| 4 | has EndDate => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'EndDate'); | ||
| 5 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'NextToken'); | ||
| 6 | has PageSize => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'PageSize'); | ||
| 7 | has Reasons => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['ParamInQuery'], query_name => 'Reason'); | ||
| 8 | has StartDate => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'StartDate'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListSuppressedDestinations'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v2/email/suppression/addresses'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SESv2::ListSuppressedDestinationsResponse'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::SESv2::ListSuppressedDestinations - Arguments for method ListSuppressedDestinations on L<Paws::SESv2> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method ListSuppressedDestinations on the | ||
| 27 | L<Amazon Simple Email Service|Paws::SESv2> service. Use the attributes of this class | ||
| 28 | as arguments to method ListSuppressedDestinations. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListSuppressedDestinations. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $email = Paws->service('SESv2'); | ||
| 35 | my $ListSuppressedDestinationsResponse = $email->ListSuppressedDestinations( | ||
| 36 | EndDate => '1970-01-01T01:00:00', # OPTIONAL | ||
| 37 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 38 | PageSize => 1, # OPTIONAL | ||
| 39 | Reasons => [ | ||
| 40 | 'BOUNCE', ... # values: BOUNCE, COMPLAINT | ||
| 41 | ], # OPTIONAL | ||
| 42 | StartDate => '1970-01-01T01:00:00', # OPTIONAL | ||
| 43 | ); | ||
| 44 | |||
| 45 | # Results: | ||
| 46 | my $NextToken = $ListSuppressedDestinationsResponse->NextToken; | ||
| 47 | my $SuppressedDestinationSummaries = | ||
| 48 | $ListSuppressedDestinationsResponse->SuppressedDestinationSummaries; | ||
| 49 | |||
| 50 | # Returns a L<Paws::SESv2::ListSuppressedDestinationsResponse> object. | ||
| 51 | |||
| 52 | 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. | ||
| 53 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/email/ListSuppressedDestinations> | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 EndDate => Str | ||
| 59 | |||
| 60 | Used to filter the list of suppressed email destinations so that it | ||
| 61 | only includes addresses that were added to the list before a specific | ||
| 62 | date. The date that you specify should be in Unix time format. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 NextToken => Str | ||
| 67 | |||
| 68 | A token returned from a previous call to C<ListSuppressedDestinations> | ||
| 69 | to indicate the position in the list of suppressed email addresses. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 PageSize => Int | ||
| 74 | |||
| 75 | The number of results to show in a single call to | ||
| 76 | C<ListSuppressedDestinations>. If the number of results is larger than | ||
| 77 | the number you specified in this parameter, then the response includes | ||
| 78 | a C<NextToken> element, which you can use to obtain additional results. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 Reasons => ArrayRef[Str|Undef] | ||
| 83 | |||
| 84 | The factors that caused the email address to be added to . | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 StartDate => Str | ||
| 89 | |||
| 90 | Used to filter the list of suppressed email destinations so that it | ||
| 91 | only includes addresses that were added to the list after a specific | ||
| 92 | date. The date that you specify should be in Unix time format. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head1 SEE ALSO | ||
| 98 | |||
| 99 | This class forms part of L<Paws>, documenting arguments for method ListSuppressedDestinations in L<Paws::SESv2> | ||
| 100 | |||
| 101 | =head1 BUGS and CONTRIBUTIONS | ||
| 102 | |||
| 103 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 104 | |||
| 105 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 106 | |||
| 107 | =cut | ||
| 108 |