« blib/lib/Paws/ApiGatewayV2/GetVpcLinksResponse.pm
↑ Summary
blib/lib/Paws/ApiGatewayV2/ImportApiInput.pm »
| 1 | |||
| 2 | package Paws::ApiGatewayV2::ImportApi; | ||
| 3 | use Moose; | ||
| 4 | has Basepath => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'basepath'); | ||
| 5 | has Body => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'body', required => 1); | ||
| 6 | has FailOnWarnings => (is => 'ro', isa => 'Bool', traits => ['ParamInQuery'], query_name => 'failOnWarnings'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ImportApi'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v2/apis'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGatewayV2::ImportApiResponse'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::ApiGatewayV2::ImportApi - Arguments for method ImportApi on L<Paws::ApiGatewayV2> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method ImportApi on the | ||
| 25 | L<AmazonApiGatewayV2|Paws::ApiGatewayV2> service. Use the attributes of this class | ||
| 26 | as arguments to method ImportApi. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ImportApi. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $apigateway = Paws->service('ApiGatewayV2'); | ||
| 33 | my $ImportApiResponse = $apigateway->ImportApi( | ||
| 34 | Body => 'My__string', | ||
| 35 | Basepath => 'My__string', # OPTIONAL | ||
| 36 | FailOnWarnings => 1, # OPTIONAL | ||
| 37 | ); | ||
| 38 | |||
| 39 | # Results: | ||
| 40 | my $ApiEndpoint = $ImportApiResponse->ApiEndpoint; | ||
| 41 | my $ApiGatewayManaged = $ImportApiResponse->ApiGatewayManaged; | ||
| 42 | my $ApiId = $ImportApiResponse->ApiId; | ||
| 43 | my $ApiKeySelectionExpression = | ||
| 44 | $ImportApiResponse->ApiKeySelectionExpression; | ||
| 45 | my $CorsConfiguration = $ImportApiResponse->CorsConfiguration; | ||
| 46 | my $CreatedDate = $ImportApiResponse->CreatedDate; | ||
| 47 | my $Description = $ImportApiResponse->Description; | ||
| 48 | my $DisableExecuteApiEndpoint = | ||
| 49 | $ImportApiResponse->DisableExecuteApiEndpoint; | ||
| 50 | my $DisableSchemaValidation = $ImportApiResponse->DisableSchemaValidation; | ||
| 51 | my $ImportInfo = $ImportApiResponse->ImportInfo; | ||
| 52 | my $Name = $ImportApiResponse->Name; | ||
| 53 | my $ProtocolType = $ImportApiResponse->ProtocolType; | ||
| 54 | my $RouteSelectionExpression = $ImportApiResponse->RouteSelectionExpression; | ||
| 55 | my $Tags = $ImportApiResponse->Tags; | ||
| 56 | my $Version = $ImportApiResponse->Version; | ||
| 57 | my $Warnings = $ImportApiResponse->Warnings; | ||
| 58 | |||
| 59 | # Returns a L<Paws::ApiGatewayV2::ImportApiResponse> object. | ||
| 60 | |||
| 61 | 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. | ||
| 62 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/apigateway/ImportApi> | ||
| 63 | |||
| 64 | =head1 ATTRIBUTES | ||
| 65 | |||
| 66 | |||
| 67 | =head2 Basepath => Str | ||
| 68 | |||
| 69 | Specifies how to interpret the base path of the API during import. | ||
| 70 | Valid values are ignore, prepend, and split. The default value is | ||
| 71 | ignore. To learn more, see Set the OpenAPI basePath Property | ||
| 72 | (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html). | ||
| 73 | Supported only for HTTP APIs. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 B<REQUIRED> Body => Str | ||
| 78 | |||
| 79 | The OpenAPI definition. Supported only for HTTP APIs. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 FailOnWarnings => Bool | ||
| 84 | |||
| 85 | Specifies whether to rollback the API creation when a warning is | ||
| 86 | encountered. By default, API creation continues if a warning is | ||
| 87 | encountered. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head1 SEE ALSO | ||
| 93 | |||
| 94 | This class forms part of L<Paws>, documenting arguments for method ImportApi in L<Paws::ApiGatewayV2> | ||
| 95 | |||
| 96 | =head1 BUGS and CONTRIBUTIONS | ||
| 97 | |||
| 98 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 99 | |||
| 100 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 101 | |||
| 102 | =cut | ||
| 103 |