| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::EventDimensions; | ||
| 3 | use Moose; | ||
| 4 | has Attributes => (is => 'ro', isa => 'Paws::Pinpoint::MapOfAttributeDimension'); | ||
| 5 | has EventType => (is => 'ro', isa => 'Paws::Pinpoint::SetDimension'); | ||
| 6 | has Metrics => (is => 'ro', isa => 'Paws::Pinpoint::MapOfMetricDimension'); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::Pinpoint::EventDimensions | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::Pinpoint::EventDimensions object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { Attributes => $value, ..., Metrics => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::EventDimensions object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->Attributes | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | Specifies the dimensions for an event filter that determines when a | ||
| 39 | campaign is sent or a journey activity is performed. | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 Attributes => L<Paws::Pinpoint::MapOfAttributeDimension> | ||
| 45 | |||
| 46 | One or more custom attributes that your application reports to Amazon | ||
| 47 | Pinpoint. You can use these attributes as selection criteria when you | ||
| 48 | create an event filter. | ||
| 49 | |||
| 50 | |||
| 51 | =head2 EventType => L<Paws::Pinpoint::SetDimension> | ||
| 52 | |||
| 53 | The name of the event that causes the campaign to be sent or the | ||
| 54 | journey activity to be performed. This can be a standard event that | ||
| 55 | Amazon Pinpoint generates, such as _email.delivered. For campaigns, | ||
| 56 | this can also be a custom event that's specific to your application. | ||
| 57 | For information about standard events, see Streaming Amazon Pinpoint | ||
| 58 | Events | ||
| 59 | (https://docs.aws.amazon.com/pinpoint/latest/developerguide/event-streams.html) | ||
| 60 | in the I<Amazon Pinpoint Developer Guide>. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 Metrics => L<Paws::Pinpoint::MapOfMetricDimension> | ||
| 64 | |||
| 65 | One or more custom metrics that your application reports to Amazon | ||
| 66 | Pinpoint. You can use these metrics as selection criteria when you | ||
| 67 | create an event filter. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head1 SEE ALSO | ||
| 72 | |||
| 73 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 74 | |||
| 75 | =head1 BUGS and CONTRIBUTIONS | ||
| 76 | |||
| 77 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 78 | |||
| 79 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 80 | |||
| 81 | =cut | ||
| 82 |