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