« blib/lib/Paws/ApiGateway/PathToMapOfMethodSnapshot.pm
↑ Summary
blib/lib/Paws/ApiGateway/PutIntegration.pm »
| 1 | |||
| 2 | package Paws::ApiGateway::PutGatewayResponse; | ||
| 3 | use Moose; | ||
| 4 | has ResponseParameters => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToString', traits => ['NameInRequest'], request_name => 'responseParameters'); | ||
| 5 | has ResponseTemplates => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToString', traits => ['NameInRequest'], request_name => 'responseTemplates'); | ||
| 6 | has ResponseType => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'response_type', required => 1); | ||
| 7 | has RestApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'restapi_id', required => 1); | ||
| 8 | has StatusCode => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'statusCode'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutGatewayResponse'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/restapis/{restapi_id}/gatewayresponses/{response_type}'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::GatewayResponse'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::ApiGateway::PutGatewayResponse - Arguments for method PutGatewayResponse on L<Paws::ApiGateway> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method PutGatewayResponse on the | ||
| 27 | L<Amazon API Gateway|Paws::ApiGateway> service. Use the attributes of this class | ||
| 28 | as arguments to method PutGatewayResponse. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutGatewayResponse. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $apigateway = Paws->service('ApiGateway'); | ||
| 35 | my $GatewayResponse = $apigateway->PutGatewayResponse( | ||
| 36 | ResponseType => 'DEFAULT_4XX', | ||
| 37 | RestApiId => 'MyString', | ||
| 38 | ResponseParameters => { 'MyString' => 'MyString', }, # OPTIONAL | ||
| 39 | ResponseTemplates => { 'MyString' => 'MyString', }, # OPTIONAL | ||
| 40 | StatusCode => 'MyStatusCode', # OPTIONAL | ||
| 41 | ); | ||
| 42 | |||
| 43 | # Results: | ||
| 44 | my $DefaultResponse = $GatewayResponse->DefaultResponse; | ||
| 45 | my $ResponseParameters = $GatewayResponse->ResponseParameters; | ||
| 46 | my $ResponseTemplates = $GatewayResponse->ResponseTemplates; | ||
| 47 | my $ResponseType = $GatewayResponse->ResponseType; | ||
| 48 | my $StatusCode = $GatewayResponse->StatusCode; | ||
| 49 | |||
| 50 | # Returns a L<Paws::ApiGateway::GatewayResponse> object. | ||
| 51 | |||
| 52 | 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. | ||
| 53 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/apigateway/PutGatewayResponse> | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 ResponseParameters => L<Paws::ApiGateway::MapOfStringToString> | ||
| 59 | |||
| 60 | Response parameters (paths, query strings and headers) of the | ||
| 61 | GatewayResponse as a string-to-string map of key-value pairs. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 ResponseTemplates => L<Paws::ApiGateway::MapOfStringToString> | ||
| 66 | |||
| 67 | Response templates of the GatewayResponse as a string-to-string map of | ||
| 68 | key-value pairs. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 B<REQUIRED> ResponseType => Str | ||
| 73 | |||
| 74 | [Required] | ||
| 75 | |||
| 76 | The response type of the associated GatewayResponse. Valid values are | ||
| 77 | |||
| 78 | =over | ||
| 79 | |||
| 80 | =item * ACCESS_DENIED | ||
| 81 | |||
| 82 | =item * API_CONFIGURATION_ERROR | ||
| 83 | |||
| 84 | =item * AUTHORIZER_FAILURE | ||
| 85 | |||
| 86 | =item * AUTHORIZER_CONFIGURATION_ERROR | ||
| 87 | |||
| 88 | =item * BAD_REQUEST_PARAMETERS | ||
| 89 | |||
| 90 | =item * BAD_REQUEST_BODY | ||
| 91 | |||
| 92 | =item * DEFAULT_4XX | ||
| 93 | |||
| 94 | =item * DEFAULT_5XX | ||
| 95 | |||
| 96 | =item * EXPIRED_TOKEN | ||
| 97 | |||
| 98 | =item * INVALID_SIGNATURE | ||
| 99 | |||
| 100 | =item * INTEGRATION_FAILURE | ||
| 101 | |||
| 102 | =item * INTEGRATION_TIMEOUT | ||
| 103 | |||
| 104 | =item * INVALID_API_KEY | ||
| 105 | |||
| 106 | =item * MISSING_AUTHENTICATION_TOKEN | ||
| 107 | |||
| 108 | =item * QUOTA_EXCEEDED | ||
| 109 | |||
| 110 | =item * REQUEST_TOO_LARGE | ||
| 111 | |||
| 112 | =item * RESOURCE_NOT_FOUND | ||
| 113 | |||
| 114 | =item * THROTTLED | ||
| 115 | |||
| 116 | =item * UNAUTHORIZED | ||
| 117 | |||
| 118 | =item * UNSUPPORTED_MEDIA_TYPE | ||
| 119 | |||
| 120 | =back | ||
| 121 | |||
| 122 | |||
| 123 | 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"> | ||
| 124 | |||
| 125 | =head2 B<REQUIRED> RestApiId => Str | ||
| 126 | |||
| 127 | [Required] The string identifier of the associated RestApi. | ||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | =head2 StatusCode => Str | ||
| 132 | |||
| 133 | The HTTP status code of the GatewayResponse. | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | =head1 SEE ALSO | ||
| 139 | |||
| 140 | This class forms part of L<Paws>, documenting arguments for method PutGatewayResponse in L<Paws::ApiGateway> | ||
| 141 | |||
| 142 | =head1 BUGS and CONTRIBUTIONS | ||
| 143 | |||
| 144 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 145 | |||
| 146 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 147 | |||
| 148 | =cut | ||
| 149 |