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