« blib/lib/Paws/CloudWatchEvents/Target.pm
↑ Summary
blib/lib/Paws/CloudWatchEvents/TestEventPatternResponse.pm »
| 1 | |||
| 2 | package Paws::CloudWatchEvents::TestEventPattern; | ||
| 3 | use Moose; | ||
| 4 | has Event => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has EventPattern => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'TestEventPattern'); | ||
| 10 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudWatchEvents::TestEventPatternResponse'); | ||
| 11 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::CloudWatchEvents::TestEventPattern - Arguments for method TestEventPattern on L<Paws::CloudWatchEvents> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method TestEventPattern on the | ||
| 23 | L<Amazon EventBridge|Paws::CloudWatchEvents> service. Use the attributes of this class | ||
| 24 | as arguments to method TestEventPattern. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to TestEventPattern. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $events = Paws->service('CloudWatchEvents'); | ||
| 31 | my $TestEventPatternResponse = $events->TestEventPattern( | ||
| 32 | Event => 'MyString', | ||
| 33 | EventPattern => 'MyEventPattern', | ||
| 34 | |||
| 35 | ); | ||
| 36 | |||
| 37 | # Results: | ||
| 38 | my $Result = $TestEventPatternResponse->Result; | ||
| 39 | |||
| 40 | # Returns a L<Paws::CloudWatchEvents::TestEventPatternResponse> object. | ||
| 41 | |||
| 42 | 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. | ||
| 43 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/events/TestEventPattern> | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 B<REQUIRED> Event => Str | ||
| 49 | |||
| 50 | The event, in JSON format, to test against the event pattern. The JSON | ||
| 51 | must follow the format specified in AWS Events | ||
| 52 | (https://docs.aws.amazon.com/eventbridge/latest/userguide/aws-events.html), | ||
| 53 | and the following fields are mandatory: | ||
| 54 | |||
| 55 | =over | ||
| 56 | |||
| 57 | =item * | ||
| 58 | |||
| 59 | C<id> | ||
| 60 | |||
| 61 | =item * | ||
| 62 | |||
| 63 | C<account> | ||
| 64 | |||
| 65 | =item * | ||
| 66 | |||
| 67 | C<source> | ||
| 68 | |||
| 69 | =item * | ||
| 70 | |||
| 71 | C<time> | ||
| 72 | |||
| 73 | =item * | ||
| 74 | |||
| 75 | C<region> | ||
| 76 | |||
| 77 | =item * | ||
| 78 | |||
| 79 | C<resources> | ||
| 80 | |||
| 81 | =item * | ||
| 82 | |||
| 83 | C<detail-type> | ||
| 84 | |||
| 85 | =back | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 B<REQUIRED> EventPattern => Str | ||
| 91 | |||
| 92 | The event pattern. For more information, see Events and Event Patterns | ||
| 93 | (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) | ||
| 94 | in the I<Amazon EventBridge User Guide>. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head1 SEE ALSO | ||
| 100 | |||
| 101 | This class forms part of L<Paws>, documenting arguments for method TestEventPattern in L<Paws::CloudWatchEvents> | ||
| 102 | |||
| 103 | =head1 BUGS and CONTRIBUTIONS | ||
| 104 | |||
| 105 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 106 | |||
| 107 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 108 | |||
| 109 | =cut | ||
| 110 |