« blib/lib/Paws/ApiGateway/TestInvokeAuthorizerResponse.pm
↑ Summary
blib/lib/Paws/ApiGateway/TestInvokeMethodResponse.pm »
| 1 | |||
| 2 | package Paws::ApiGateway::TestInvokeMethod; | ||
| 3 | use Moose; | ||
| 4 | has Body => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'body'); | ||
| 5 | has ClientCertificateId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientCertificateId'); | ||
| 6 | has Headers => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToString', traits => ['NameInRequest'], request_name => 'headers'); | ||
| 7 | has HttpMethod => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'http_method', required => 1); | ||
| 8 | has MultiValueHeaders => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToList', traits => ['NameInRequest'], request_name => 'multiValueHeaders'); | ||
| 9 | has PathWithQueryString => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'pathWithQueryString'); | ||
| 10 | has ResourceId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'resource_id', required => 1); | ||
| 11 | has RestApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'restapi_id', required => 1); | ||
| 12 | has StageVariables => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToString', traits => ['NameInRequest'], request_name => 'stageVariables'); | ||
| 13 | |||
| 14 | use MooseX::ClassAttribute; | ||
| 15 | |||
| 16 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'TestInvokeMethod'); | ||
| 17 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}'); | ||
| 18 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 19 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::TestInvokeMethodResponse'); | ||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::ApiGateway::TestInvokeMethod - Arguments for method TestInvokeMethod on L<Paws::ApiGateway> | ||
| 27 | |||
| 28 | =head1 DESCRIPTION | ||
| 29 | |||
| 30 | This class represents the parameters used for calling the method TestInvokeMethod on the | ||
| 31 | L<Amazon API Gateway|Paws::ApiGateway> service. Use the attributes of this class | ||
| 32 | as arguments to method TestInvokeMethod. | ||
| 33 | |||
| 34 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to TestInvokeMethod. | ||
| 35 | |||
| 36 | =head1 SYNOPSIS | ||
| 37 | |||
| 38 | my $apigateway = Paws->service('ApiGateway'); | ||
| 39 | my $TestInvokeMethodResponse = $apigateway->TestInvokeMethod( | ||
| 40 | HttpMethod => 'MyString', | ||
| 41 | ResourceId => 'MyString', | ||
| 42 | RestApiId => 'MyString', | ||
| 43 | Body => 'MyString', # OPTIONAL | ||
| 44 | ClientCertificateId => 'MyString', # OPTIONAL | ||
| 45 | Headers => { 'MyString' => 'MyString', }, # OPTIONAL | ||
| 46 | MultiValueHeaders => { 'MyString' => [ 'MyString', ... ], }, # OPTIONAL | ||
| 47 | PathWithQueryString => 'MyString', # OPTIONAL | ||
| 48 | StageVariables => { 'MyString' => 'MyString', }, # OPTIONAL | ||
| 49 | ); | ||
| 50 | |||
| 51 | # Results: | ||
| 52 | my $Body = $TestInvokeMethodResponse->Body; | ||
| 53 | my $Headers = $TestInvokeMethodResponse->Headers; | ||
| 54 | my $Latency = $TestInvokeMethodResponse->Latency; | ||
| 55 | my $Log = $TestInvokeMethodResponse->Log; | ||
| 56 | my $MultiValueHeaders = $TestInvokeMethodResponse->MultiValueHeaders; | ||
| 57 | my $Status = $TestInvokeMethodResponse->Status; | ||
| 58 | |||
| 59 | # Returns a L<Paws::ApiGateway::TestInvokeMethodResponse> object. | ||
| 60 | |||
| 61 | 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. | ||
| 62 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/apigateway/TestInvokeMethod> | ||
| 63 | |||
| 64 | =head1 ATTRIBUTES | ||
| 65 | |||
| 66 | |||
| 67 | =head2 Body => Str | ||
| 68 | |||
| 69 | The simulated request body of an incoming invocation request. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 ClientCertificateId => Str | ||
| 74 | |||
| 75 | A ClientCertificate identifier to use in the test invocation. API | ||
| 76 | Gateway will use the certificate when making the HTTPS request to the | ||
| 77 | defined back-end endpoint. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 Headers => L<Paws::ApiGateway::MapOfStringToString> | ||
| 82 | |||
| 83 | A key-value map of headers to simulate an incoming invocation request. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 B<REQUIRED> HttpMethod => Str | ||
| 88 | |||
| 89 | [Required] Specifies a test invoke method request's HTTP method. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 MultiValueHeaders => L<Paws::ApiGateway::MapOfStringToList> | ||
| 94 | |||
| 95 | The headers as a map from string to list of values to simulate an | ||
| 96 | incoming invocation request. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 PathWithQueryString => Str | ||
| 101 | |||
| 102 | The URI path, including query string, of the simulated invocation | ||
| 103 | request. Use this to specify path parameters and query string | ||
| 104 | parameters. | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head2 B<REQUIRED> ResourceId => Str | ||
| 109 | |||
| 110 | [Required] Specifies a test invoke method request's resource ID. | ||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | =head2 B<REQUIRED> RestApiId => Str | ||
| 115 | |||
| 116 | [Required] The string identifier of the associated RestApi. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head2 StageVariables => L<Paws::ApiGateway::MapOfStringToString> | ||
| 121 | |||
| 122 | A key-value map of stage variables to simulate an invocation on a | ||
| 123 | deployed Stage. | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head1 SEE ALSO | ||
| 129 | |||
| 130 | This class forms part of L<Paws>, documenting arguments for method TestInvokeMethod in L<Paws::ApiGateway> | ||
| 131 | |||
| 132 | =head1 BUGS and CONTRIBUTIONS | ||
| 133 | |||
| 134 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 135 | |||
| 136 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 137 | |||
| 138 | =cut | ||
| 139 |