« blib/lib/Paws/ApiGateway/FlushStageCache.pm
↑ Summary
blib/lib/Paws/ApiGateway/GatewayResponses.pm »
| 1 | |||
| 2 | package Paws::ApiGateway::GatewayResponse; | ||
| 3 | use Moose; | ||
| 4 | has DefaultResponse => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'defaultResponse'); | ||
| 5 | has ResponseParameters => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToString', traits => ['NameInRequest'], request_name => 'responseParameters'); | ||
| 6 | has ResponseTemplates => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToString', traits => ['NameInRequest'], request_name => 'responseTemplates'); | ||
| 7 | has ResponseType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'responseType'); | ||
| 8 | has StatusCode => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'statusCode'); | ||
| 9 | |||
| 10 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::ApiGateway::GatewayResponse | ||
| 18 | |||
| 19 | =head1 ATTRIBUTES | ||
| 20 | |||
| 21 | |||
| 22 | =head2 DefaultResponse => Bool | ||
| 23 | |||
| 24 | A Boolean flag to indicate whether this GatewayResponse is the default | ||
| 25 | gateway response (C<true>) or not (C<false>). A default gateway | ||
| 26 | response is one generated by API Gateway without any customization by | ||
| 27 | an API developer. | ||
| 28 | |||
| 29 | |||
| 30 | =head2 ResponseParameters => L<Paws::ApiGateway::MapOfStringToString> | ||
| 31 | |||
| 32 | Response parameters (paths, query strings and headers) of the | ||
| 33 | GatewayResponse as a string-to-string map of key-value pairs. | ||
| 34 | |||
| 35 | |||
| 36 | =head2 ResponseTemplates => L<Paws::ApiGateway::MapOfStringToString> | ||
| 37 | |||
| 38 | Response templates of the GatewayResponse as a string-to-string map of | ||
| 39 | key-value pairs. | ||
| 40 | |||
| 41 | |||
| 42 | =head2 ResponseType => Str | ||
| 43 | |||
| 44 | The response type of the associated GatewayResponse. Valid values are | ||
| 45 | |||
| 46 | =over | ||
| 47 | |||
| 48 | =item * ACCESS_DENIED | ||
| 49 | |||
| 50 | =item * API_CONFIGURATION_ERROR | ||
| 51 | |||
| 52 | =item * AUTHORIZER_FAILURE | ||
| 53 | |||
| 54 | =item * AUTHORIZER_CONFIGURATION_ERROR | ||
| 55 | |||
| 56 | =item * BAD_REQUEST_PARAMETERS | ||
| 57 | |||
| 58 | =item * BAD_REQUEST_BODY | ||
| 59 | |||
| 60 | =item * DEFAULT_4XX | ||
| 61 | |||
| 62 | =item * DEFAULT_5XX | ||
| 63 | |||
| 64 | =item * EXPIRED_TOKEN | ||
| 65 | |||
| 66 | =item * INVALID_SIGNATURE | ||
| 67 | |||
| 68 | =item * INTEGRATION_FAILURE | ||
| 69 | |||
| 70 | =item * INTEGRATION_TIMEOUT | ||
| 71 | |||
| 72 | =item * INVALID_API_KEY | ||
| 73 | |||
| 74 | =item * MISSING_AUTHENTICATION_TOKEN | ||
| 75 | |||
| 76 | =item * QUOTA_EXCEEDED | ||
| 77 | |||
| 78 | =item * REQUEST_TOO_LARGE | ||
| 79 | |||
| 80 | =item * RESOURCE_NOT_FOUND | ||
| 81 | |||
| 82 | =item * THROTTLED | ||
| 83 | |||
| 84 | =item * UNAUTHORIZED | ||
| 85 | |||
| 86 | =item * UNSUPPORTED_MEDIA_TYPE | ||
| 87 | |||
| 88 | =back | ||
| 89 | |||
| 90 | |||
| 91 | Valid values are: C<"DEFAULT_4XX">, C<"DEFAULT_5XX">, C<"RESOURCE_NOT_FOUND">, C<"UNAUTHORIZED">, C<"INVALID_API_KEY">, C<"ACCESS_DENIED">, C<"AUTHORIZER_FAILURE">, C<"AUTHORIZER_CONFIGURATION_ERROR">, C<"INVALID_SIGNATURE">, C<"EXPIRED_TOKEN">, C<"MISSING_AUTHENTICATION_TOKEN">, C<"INTEGRATION_FAILURE">, C<"INTEGRATION_TIMEOUT">, C<"API_CONFIGURATION_ERROR">, C<"UNSUPPORTED_MEDIA_TYPE">, C<"BAD_REQUEST_PARAMETERS">, C<"BAD_REQUEST_BODY">, C<"REQUEST_TOO_LARGE">, C<"THROTTLED">, C<"QUOTA_EXCEEDED"> | ||
| 92 | =head2 StatusCode => Str | ||
| 93 | |||
| 94 | The HTTP status code for this GatewayResponse. | ||
| 95 | |||
| 96 | |||
| 97 | =head2 _request_id => Str | ||
| 98 | |||
| 99 | |||
| 100 | =cut | ||
| 101 |