« blib/lib/Paws/PinpointEmail/Content.pm
↑ Summary
blib/lib/Paws/PinpointEmail/CreateConfigurationSetEventDestination.pm »
| 1 | |||
| 2 | package Paws::PinpointEmail::CreateConfigurationSet; | ||
| 3 | use Moose; | ||
| 4 | has ConfigurationSetName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has DeliveryOptions => (is => 'ro', isa => 'Paws::PinpointEmail::DeliveryOptions'); | ||
| 6 | has ReputationOptions => (is => 'ro', isa => 'Paws::PinpointEmail::ReputationOptions'); | ||
| 7 | has SendingOptions => (is => 'ro', isa => 'Paws::PinpointEmail::SendingOptions'); | ||
| 8 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::PinpointEmail::Tag]'); | ||
| 9 | has TrackingOptions => (is => 'ro', isa => 'Paws::PinpointEmail::TrackingOptions'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateConfigurationSet'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/email/configuration-sets'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::PinpointEmail::CreateConfigurationSetResponse'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::PinpointEmail::CreateConfigurationSet - Arguments for method CreateConfigurationSet on L<Paws::PinpointEmail> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method CreateConfigurationSet on the | ||
| 28 | L<Amazon Pinpoint Email Service|Paws::PinpointEmail> service. Use the attributes of this class | ||
| 29 | as arguments to method CreateConfigurationSet. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateConfigurationSet. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $email = Paws->service('PinpointEmail'); | ||
| 36 | my $CreateConfigurationSetResponse = $email->CreateConfigurationSet( | ||
| 37 | ConfigurationSetName => 'MyConfigurationSetName', | ||
| 38 | DeliveryOptions => { | ||
| 39 | SendingPoolName => 'MyPoolName', # OPTIONAL | ||
| 40 | TlsPolicy => 'REQUIRE', # values: REQUIRE, OPTIONAL; OPTIONAL | ||
| 41 | }, # OPTIONAL | ||
| 42 | ReputationOptions => { | ||
| 43 | LastFreshStart => '1970-01-01T01:00:00', # OPTIONAL | ||
| 44 | ReputationMetricsEnabled => 1, # OPTIONAL | ||
| 45 | }, # OPTIONAL | ||
| 46 | SendingOptions => { | ||
| 47 | SendingEnabled => 1, # OPTIONAL | ||
| 48 | }, # OPTIONAL | ||
| 49 | Tags => [ | ||
| 50 | { | ||
| 51 | Key => 'MyTagKey', | ||
| 52 | Value => 'MyTagValue', | ||
| 53 | |||
| 54 | }, | ||
| 55 | ... | ||
| 56 | ], # OPTIONAL | ||
| 57 | TrackingOptions => { | ||
| 58 | CustomRedirectDomain => 'MyCustomRedirectDomain', | ||
| 59 | |||
| 60 | }, # OPTIONAL | ||
| 61 | ); | ||
| 62 | |||
| 63 | 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. | ||
| 64 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/email/CreateConfigurationSet> | ||
| 65 | |||
| 66 | =head1 ATTRIBUTES | ||
| 67 | |||
| 68 | |||
| 69 | =head2 B<REQUIRED> ConfigurationSetName => Str | ||
| 70 | |||
| 71 | The name of the configuration set. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 DeliveryOptions => L<Paws::PinpointEmail::DeliveryOptions> | ||
| 76 | |||
| 77 | An object that defines the dedicated IP pool that is used to send | ||
| 78 | emails that you send using the configuration set. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 ReputationOptions => L<Paws::PinpointEmail::ReputationOptions> | ||
| 83 | |||
| 84 | An object that defines whether or not Amazon Pinpoint collects | ||
| 85 | reputation metrics for the emails that you send that use the | ||
| 86 | configuration set. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 SendingOptions => L<Paws::PinpointEmail::SendingOptions> | ||
| 91 | |||
| 92 | An object that defines whether or not Amazon Pinpoint can send email | ||
| 93 | that you send using the configuration set. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 Tags => ArrayRef[L<Paws::PinpointEmail::Tag>] | ||
| 98 | |||
| 99 | An array of objects that define the tags (keys and values) that you | ||
| 100 | want to associate with the configuration set. | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head2 TrackingOptions => L<Paws::PinpointEmail::TrackingOptions> | ||
| 105 | |||
| 106 | An object that defines the open and click tracking options for emails | ||
| 107 | that you send using the configuration set. | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head1 SEE ALSO | ||
| 113 | |||
| 114 | This class forms part of L<Paws>, documenting arguments for method CreateConfigurationSet in L<Paws::PinpointEmail> | ||
| 115 | |||
| 116 | =head1 BUGS and CONTRIBUTIONS | ||
| 117 | |||
| 118 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 119 | |||
| 120 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 121 | |||
| 122 | =cut | ||
| 123 |