« blib/lib/Paws/PinpointEmail/CreateConfigurationSet.pm
↑ Summary
blib/lib/Paws/PinpointEmail/CreateConfigurationSetEventDestinationResponse.pm »
| 1 | |||
| 2 | package Paws::PinpointEmail::CreateConfigurationSetEventDestination; | ||
| 3 | use Moose; | ||
| 4 | has ConfigurationSetName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'ConfigurationSetName', required => 1); | ||
| 5 | has EventDestination => (is => 'ro', isa => 'Paws::PinpointEmail::EventDestinationDefinition', required => 1); | ||
| 6 | has EventDestinationName => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateConfigurationSetEventDestination'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/email/configuration-sets/{ConfigurationSetName}/event-destinations'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::PinpointEmail::CreateConfigurationSetEventDestinationResponse'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::PinpointEmail::CreateConfigurationSetEventDestination - Arguments for method CreateConfigurationSetEventDestination on L<Paws::PinpointEmail> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method CreateConfigurationSetEventDestination on the | ||
| 25 | L<Amazon Pinpoint Email Service|Paws::PinpointEmail> service. Use the attributes of this class | ||
| 26 | as arguments to method CreateConfigurationSetEventDestination. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateConfigurationSetEventDestination. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $email = Paws->service('PinpointEmail'); | ||
| 33 | my $CreateConfigurationSetEventDestinationResponse = | ||
| 34 | $email->CreateConfigurationSetEventDestination( | ||
| 35 | ConfigurationSetName => 'MyConfigurationSetName', | ||
| 36 | EventDestination => { | ||
| 37 | CloudWatchDestination => { | ||
| 38 | DimensionConfigurations => [ | ||
| 39 | { | ||
| 40 | DefaultDimensionValue => 'MyDefaultDimensionValue', | ||
| 41 | DimensionName => 'MyDimensionName', | ||
| 42 | DimensionValueSource => | ||
| 43 | 'MESSAGE_TAG', # values: MESSAGE_TAG, EMAIL_HEADER, LINK_TAG | ||
| 44 | |||
| 45 | }, | ||
| 46 | ... | ||
| 47 | ], | ||
| 48 | |||
| 49 | }, # OPTIONAL | ||
| 50 | Enabled => 1, # OPTIONAL | ||
| 51 | KinesisFirehoseDestination => { | ||
| 52 | DeliveryStreamArn => 'MyAmazonResourceName', | ||
| 53 | IamRoleArn => 'MyAmazonResourceName', | ||
| 54 | |||
| 55 | }, # OPTIONAL | ||
| 56 | MatchingEventTypes => [ | ||
| 57 | 'SEND', | ||
| 58 | ... # values: SEND, REJECT, BOUNCE, COMPLAINT, DELIVERY, OPEN, CLICK, RENDERING_FAILURE | ||
| 59 | ], # OPTIONAL | ||
| 60 | PinpointDestination => { ApplicationArn => 'MyAmazonResourceName', } | ||
| 61 | , # OPTIONAL | ||
| 62 | SnsDestination => { | ||
| 63 | TopicArn => 'MyAmazonResourceName', | ||
| 64 | |||
| 65 | }, # OPTIONAL | ||
| 66 | }, | ||
| 67 | EventDestinationName => 'MyEventDestinationName', | ||
| 68 | |||
| 69 | ); | ||
| 70 | |||
| 71 | 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. | ||
| 72 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/email/CreateConfigurationSetEventDestination> | ||
| 73 | |||
| 74 | =head1 ATTRIBUTES | ||
| 75 | |||
| 76 | |||
| 77 | =head2 B<REQUIRED> ConfigurationSetName => Str | ||
| 78 | |||
| 79 | The name of the configuration set that you want to add an event | ||
| 80 | destination to. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 B<REQUIRED> EventDestination => L<Paws::PinpointEmail::EventDestinationDefinition> | ||
| 85 | |||
| 86 | An object that defines the event destination. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 B<REQUIRED> EventDestinationName => Str | ||
| 91 | |||
| 92 | A name that identifies the event destination within the configuration | ||
| 93 | set. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head1 SEE ALSO | ||
| 99 | |||
| 100 | This class forms part of L<Paws>, documenting arguments for method CreateConfigurationSetEventDestination in L<Paws::PinpointEmail> | ||
| 101 | |||
| 102 | =head1 BUGS and CONTRIBUTIONS | ||
| 103 | |||
| 104 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 105 | |||
| 106 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 107 | |||
| 108 | =cut | ||
| 109 |