« blib/lib/Paws/ApiGateway/ImportDocumentationParts.pm
↑ Summary
blib/lib/Paws/ApiGateway/Integration.pm »
| 1 | |||
| 2 | package Paws::ApiGateway::ImportRestApi; | ||
| 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 Parameters => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToString', traits => ['ParamInQuery'], query_name => 'parameters'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 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 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::ApiGateway::ImportRestApi - Arguments for method ImportRestApi on L<Paws::ApiGateway> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method ImportRestApi on the | ||
| 25 | L<Amazon API Gateway|Paws::ApiGateway> service. Use the attributes of this class | ||
| 26 | as arguments to method ImportRestApi. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ImportRestApi. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $apigateway = Paws->service('ApiGateway'); | ||
| 33 | my $RestApi = $apigateway->ImportRestApi( | ||
| 34 | Body => 'BlobBlob', | ||
| 35 | FailOnWarnings => 1, # OPTIONAL | ||
| 36 | Parameters => { 'MyString' => 'MyString', }, # OPTIONAL | ||
| 37 | ); | ||
| 38 | |||
| 39 | # Results: | ||
| 40 | my $ApiKeySource = $RestApi->ApiKeySource; | ||
| 41 | my $BinaryMediaTypes = $RestApi->BinaryMediaTypes; | ||
| 42 | my $CreatedDate = $RestApi->CreatedDate; | ||
| 43 | my $Description = $RestApi->Description; | ||
| 44 | my $DisableExecuteApiEndpoint = $RestApi->DisableExecuteApiEndpoint; | ||
| 45 | my $EndpointConfiguration = $RestApi->EndpointConfiguration; | ||
| 46 | my $Id = $RestApi->Id; | ||
| 47 | my $MinimumCompressionSize = $RestApi->MinimumCompressionSize; | ||
| 48 | my $Name = $RestApi->Name; | ||
| 49 | my $Policy = $RestApi->Policy; | ||
| 50 | my $Tags = $RestApi->Tags; | ||
| 51 | my $Version = $RestApi->Version; | ||
| 52 | my $Warnings = $RestApi->Warnings; | ||
| 53 | |||
| 54 | # Returns a L<Paws::ApiGateway::RestApi> object. | ||
| 55 | |||
| 56 | 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. | ||
| 57 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/apigateway/ImportRestApi> | ||
| 58 | |||
| 59 | =head1 ATTRIBUTES | ||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> Body => Str | ||
| 63 | |||
| 64 | [Required] The POST request body containing external API definitions. | ||
| 65 | Currently, only OpenAPI definition JSON/YAML files are supported. The | ||
| 66 | maximum size of the API definition file is 6MB. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 FailOnWarnings => Bool | ||
| 71 | |||
| 72 | A query parameter to indicate whether to rollback the API creation | ||
| 73 | (C<true>) or not (C<false>) when a warning is encountered. The default | ||
| 74 | value is C<false>. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 Parameters => L<Paws::ApiGateway::MapOfStringToString> | ||
| 79 | |||
| 80 | A key-value map of context-specific query string parameters specifying | ||
| 81 | the behavior of different API importing operations. The following shows | ||
| 82 | operation-specific parameters and their supported values. | ||
| 83 | |||
| 84 | To exclude DocumentationParts from the import, set C<parameters> as | ||
| 85 | C<ignore=documentation>. | ||
| 86 | |||
| 87 | To configure the endpoint type, set C<parameters> as | ||
| 88 | C<endpointConfigurationTypes=EDGE>, | ||
| 89 | C<endpointConfigurationTypes=REGIONAL>, or | ||
| 90 | C<endpointConfigurationTypes=PRIVATE>. The default endpoint type is | ||
| 91 | C<EDGE>. | ||
| 92 | |||
| 93 | To handle imported C<basepath>, set C<parameters> as | ||
| 94 | C<basepath=ignore>, C<basepath=prepend> or C<basepath=split>. | ||
| 95 | |||
| 96 | For example, the AWS CLI command to exclude documentation from the | ||
| 97 | imported API is: | ||
| 98 | |||
| 99 | aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json' | ||
| 100 | |||
| 101 | The AWS CLI command to set the regional endpoint on the imported API | ||
| 102 | is: | ||
| 103 | |||
| 104 | aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL --body 'file:///path/to/imported-api-body.json' | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head1 SEE ALSO | ||
| 110 | |||
| 111 | This class forms part of L<Paws>, documenting arguments for method ImportRestApi in L<Paws::ApiGateway> | ||
| 112 | |||
| 113 | =head1 BUGS and CONTRIBUTIONS | ||
| 114 | |||
| 115 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 116 | |||
| 117 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 118 | |||
| 119 | =cut | ||
| 120 |