« blib/lib/Paws/ApiGateway/PutMethodResponse.pm
↑ Summary
blib/lib/Paws/ApiGateway/QuotaSettings.pm »
| 1 | |||
| 2 | package Paws::ApiGateway::PutRestApi; | ||
| 3 | use Moose; | ||
| 4 | has Body => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'body', required => 1); | ||
| 5 | has FailOnWarnings => (is => 'ro', isa => 'Bool', traits => ['ParamInQuery'], query_name => 'failonwarnings'); | ||
| 6 | has Mode => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'mode'); | ||
| 7 | has Parameters => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToString', traits => ['ParamInQuery'], query_name => 'parameters'); | ||
| 8 | has RestApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'restapi_id', required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | class_has _stream_param => (is => 'ro', default => 'Body'); | ||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutRestApi'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/restapis/{restapi_id}'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::RestApi'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::ApiGateway::PutRestApi - Arguments for method PutRestApi on L<Paws::ApiGateway> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method PutRestApi on the | ||
| 27 | L<Amazon API Gateway|Paws::ApiGateway> service. Use the attributes of this class | ||
| 28 | as arguments to method PutRestApi. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutRestApi. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $apigateway = Paws->service('ApiGateway'); | ||
| 35 | my $RestApi = $apigateway->PutRestApi( | ||
| 36 | Body => 'BlobBlob', | ||
| 37 | RestApiId => 'MyString', | ||
| 38 | FailOnWarnings => 1, # OPTIONAL | ||
| 39 | Mode => 'merge', # OPTIONAL | ||
| 40 | Parameters => { 'MyString' => 'MyString', }, # OPTIONAL | ||
| 41 | ); | ||
| 42 | |||
| 43 | # Results: | ||
| 44 | my $ApiKeySource = $RestApi->ApiKeySource; | ||
| 45 | my $BinaryMediaTypes = $RestApi->BinaryMediaTypes; | ||
| 46 | my $CreatedDate = $RestApi->CreatedDate; | ||
| 47 | my $Description = $RestApi->Description; | ||
| 48 | my $DisableExecuteApiEndpoint = $RestApi->DisableExecuteApiEndpoint; | ||
| 49 | my $EndpointConfiguration = $RestApi->EndpointConfiguration; | ||
| 50 | my $Id = $RestApi->Id; | ||
| 51 | my $MinimumCompressionSize = $RestApi->MinimumCompressionSize; | ||
| 52 | my $Name = $RestApi->Name; | ||
| 53 | my $Policy = $RestApi->Policy; | ||
| 54 | my $Tags = $RestApi->Tags; | ||
| 55 | my $Version = $RestApi->Version; | ||
| 56 | my $Warnings = $RestApi->Warnings; | ||
| 57 | |||
| 58 | # Returns a L<Paws::ApiGateway::RestApi> 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/PutRestApi> | ||
| 62 | |||
| 63 | =head1 ATTRIBUTES | ||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> Body => Str | ||
| 67 | |||
| 68 | [Required] The PUT request body containing external API definitions. | ||
| 69 | Currently, only OpenAPI definition JSON/YAML files are supported. The | ||
| 70 | maximum size of the API definition file is 6MB. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 FailOnWarnings => Bool | ||
| 75 | |||
| 76 | A query parameter to indicate whether to rollback the API update | ||
| 77 | (C<true>) or not (C<false>) when a warning is encountered. The default | ||
| 78 | value is C<false>. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 Mode => Str | ||
| 83 | |||
| 84 | The C<mode> query parameter to specify the update mode. Valid values | ||
| 85 | are "merge" and "overwrite". By default, the update mode is "merge". | ||
| 86 | |||
| 87 | Valid values are: C<"merge">, C<"overwrite"> | ||
| 88 | |||
| 89 | =head2 Parameters => L<Paws::ApiGateway::MapOfStringToString> | ||
| 90 | |||
| 91 | Custom header parameters as part of the request. For example, to | ||
| 92 | exclude DocumentationParts from an imported API, set | ||
| 93 | C<ignore=documentation> as a C<parameters> value, as in the AWS CLI | ||
| 94 | command of C<aws apigateway import-rest-api --parameters | ||
| 95 | ignore=documentation --body 'file:///path/to/imported-api-body.json'>. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 B<REQUIRED> RestApiId => Str | ||
| 100 | |||
| 101 | [Required] The string identifier of the associated RestApi. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head1 SEE ALSO | ||
| 107 | |||
| 108 | This class forms part of L<Paws>, documenting arguments for method PutRestApi in L<Paws::ApiGateway> | ||
| 109 | |||
| 110 | =head1 BUGS and CONTRIBUTIONS | ||
| 111 | |||
| 112 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 113 | |||
| 114 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 115 | |||
| 116 | =cut | ||
| 117 |