File Coverage

blib/lib/Paws/ApiGateway/ImportRestApi.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::ApiGateway::ImportRestApi;
3 1     1   574 use Moose;
  1         3  
  1         10  
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 Parameters => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToString', traits => ['ParamInQuery'], query_name => 'parameters');
7              
8 1     1   10549 use MooseX::ClassAttribute;
  1         4  
  1         11  
9             class_has _stream_param => (is => 'ro', default => 'Body');
10             class_has _api_call => (isa => 'Str', is => 'ro', default => 'ImportRestApi');
11             class_has _api_uri => (isa => 'Str', is => 'ro', default => '/restapis?mode=import');
12             class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
13             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::RestApi');
14             class_has _result_key => (isa => 'Str', is => 'ro');
15             1;
16              
17             ### main pod documentation begin ###
18              
19             =head1 NAME
20              
21             Paws::ApiGateway::ImportRestApi - Arguments for method ImportRestApi on Paws::ApiGateway
22              
23             =head1 DESCRIPTION
24              
25             This class represents the parameters used for calling the method ImportRestApi on the
26             Amazon API Gateway service. Use the attributes of this class
27             as arguments to method ImportRestApi.
28              
29             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ImportRestApi.
30              
31             As an example:
32              
33             $service_obj->ImportRestApi(Att1 => $value1, Att2 => $value2, ...);
34              
35             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.
36              
37             =head1 ATTRIBUTES
38              
39              
40             =head2 B<REQUIRED> Body => Str
41              
42             The POST request body containing external API definitions. Currently,
43             only Swagger definition JSON files are supported. The maximum size of
44             the API definition file is 2MB.
45              
46              
47              
48             =head2 FailOnWarnings => Bool
49              
50             A query parameter to indicate whether to rollback the API creation
51             (C<true>) or not (C<false>) when a warning is encountered. The default
52             value is C<false>.
53              
54              
55              
56             =head2 Parameters => L<Paws::ApiGateway::MapOfStringToString>
57              
58             Custom header parameters as part of the request. For example, to
59             exclude DocumentationParts from an imported API, set
60             C<ignore=documentation> as a C<parameters> value, as in the AWS CLI
61             command of C<aws apigateway import-rest-api --parameters
62             ignore=documentation --body 'file:///path/to/imported-api-body.json>.
63              
64              
65              
66              
67             =head1 SEE ALSO
68              
69             This class forms part of L<Paws>, documenting arguments for method ImportRestApi in L<Paws::ApiGateway>
70              
71             =head1 BUGS and CONTRIBUTIONS
72              
73             The source code is located here: https://github.com/pplu/aws-sdk-perl
74              
75             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
76              
77             =cut
78