« blib/lib/Paws/PinpointEmail/PutDedicatedIpWarmupAttributesResponse.pm
↑ Summary
blib/lib/Paws/PinpointEmail/PutDeliverabilityDashboardOptionResponse.pm »
| 1 | |||
| 2 | package Paws::PinpointEmail::PutDeliverabilityDashboardOption; | ||
| 3 | use Moose; | ||
| 4 | has DashboardEnabled => (is => 'ro', isa => 'Bool', required => 1); | ||
| 5 | has SubscribedDomains => (is => 'ro', isa => 'ArrayRef[Paws::PinpointEmail::DomainDeliverabilityTrackingOption]'); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutDeliverabilityDashboardOption'); | ||
| 10 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/email/deliverability-dashboard'); | ||
| 11 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::PinpointEmail::PutDeliverabilityDashboardOptionResponse'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::PinpointEmail::PutDeliverabilityDashboardOption - Arguments for method PutDeliverabilityDashboardOption on L<Paws::PinpointEmail> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method PutDeliverabilityDashboardOption on the | ||
| 24 | L<Amazon Pinpoint Email Service|Paws::PinpointEmail> service. Use the attributes of this class | ||
| 25 | as arguments to method PutDeliverabilityDashboardOption. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutDeliverabilityDashboardOption. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $email = Paws->service('PinpointEmail'); | ||
| 32 | my $PutDeliverabilityDashboardOptionResponse = | ||
| 33 | $email->PutDeliverabilityDashboardOption( | ||
| 34 | DashboardEnabled => 1, | ||
| 35 | SubscribedDomains => [ | ||
| 36 | { | ||
| 37 | Domain => 'MyDomain', # OPTIONAL | ||
| 38 | InboxPlacementTrackingOption => { | ||
| 39 | Global => 1, | ||
| 40 | TrackedIsps => [ 'MyIspName', ... ], # OPTIONAL | ||
| 41 | }, # OPTIONAL | ||
| 42 | SubscriptionStartDate => '1970-01-01T01:00:00', # OPTIONAL | ||
| 43 | }, | ||
| 44 | ... | ||
| 45 | ], # OPTIONAL | ||
| 46 | ); | ||
| 47 | |||
| 48 | 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. | ||
| 49 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/email/PutDeliverabilityDashboardOption> | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 B<REQUIRED> DashboardEnabled => Bool | ||
| 55 | |||
| 56 | Specifies whether to enable the Deliverability dashboard for your | ||
| 57 | Amazon Pinpoint account. To enable the dashboard, set this value to | ||
| 58 | C<true>. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 SubscribedDomains => ArrayRef[L<Paws::PinpointEmail::DomainDeliverabilityTrackingOption>] | ||
| 63 | |||
| 64 | An array of objects, one for each verified domain that you use to send | ||
| 65 | email and enabled the Deliverability dashboard for. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head1 SEE ALSO | ||
| 71 | |||
| 72 | This class forms part of L<Paws>, documenting arguments for method PutDeliverabilityDashboardOption in L<Paws::PinpointEmail> | ||
| 73 | |||
| 74 | =head1 BUGS and CONTRIBUTIONS | ||
| 75 | |||
| 76 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 77 | |||
| 78 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 79 | |||
| 80 | =cut | ||
| 81 |