« blib/lib/Paws/CloudWatchEvents/HeaderParametersMap.pm
↑ Summary
blib/lib/Paws/CloudWatchEvents/InputTransformer.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudWatchEvents::HttpParameters; | ||
| 3 | use Moose; | ||
| 4 | has HeaderParameters => (is => 'ro', isa => 'Paws::CloudWatchEvents::HeaderParametersMap'); | ||
| 5 | has PathParameterValues => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 6 | has QueryStringParameters => (is => 'ro', isa => 'Paws::CloudWatchEvents::QueryStringParametersMap'); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::CloudWatchEvents::HttpParameters | ||
| 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::CloudWatchEvents::HttpParameters object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { HeaderParameters => $value, ..., QueryStringParameters => $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::CloudWatchEvents::HttpParameters object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->HeaderParameters | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | These are custom parameter to be used when the target is an API Gateway | ||
| 39 | REST APIs or EventBridge ApiDestinations. In the latter case, these are | ||
| 40 | merged with any InvocationParameters specified on the Connection, with | ||
| 41 | any values from the Connection taking precedence. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 HeaderParameters => L<Paws::CloudWatchEvents::HeaderParametersMap> | ||
| 47 | |||
| 48 | The headers that need to be sent as part of request invoking the API | ||
| 49 | Gateway REST API or EventBridge ApiDestination. | ||
| 50 | |||
| 51 | |||
| 52 | =head2 PathParameterValues => ArrayRef[Str|Undef] | ||
| 53 | |||
| 54 | The path parameter values to be used to populate API Gateway REST API | ||
| 55 | or EventBridge ApiDestination path wildcards ("*"). | ||
| 56 | |||
| 57 | |||
| 58 | =head2 QueryStringParameters => L<Paws::CloudWatchEvents::QueryStringParametersMap> | ||
| 59 | |||
| 60 | The query string keys/values that need to be sent as part of request | ||
| 61 | invoking the API Gateway REST API or EventBridge ApiDestination. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head1 SEE ALSO | ||
| 66 | |||
| 67 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudWatchEvents> | ||
| 68 | |||
| 69 | =head1 BUGS and CONTRIBUTIONS | ||
| 70 | |||
| 71 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 72 | |||
| 73 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 74 | |||
| 75 | =cut | ||
| 76 |