« blib/lib/Paws/ApiGatewayV2/DomainNames.pm
↑ Summary
blib/lib/Paws/ApiGatewayV2/ExportApiResponse.pm »
| 1 | |||
| 2 | package Paws::ApiGatewayV2::ExportApi; | ||
| 3 | use Moose; | ||
| 4 | has ApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'apiId', required => 1); | ||
| 5 | has ExportVersion => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'exportVersion'); | ||
| 6 | has IncludeExtensions => (is => 'ro', isa => 'Bool', traits => ['ParamInQuery'], query_name => 'includeExtensions'); | ||
| 7 | has OutputType => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'outputType', required => 1); | ||
| 8 | has Specification => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'specification', required => 1); | ||
| 9 | has StageName => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'stageName'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ExportApi'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v2/apis/{apiId}/exports/{specification}'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGatewayV2::ExportApiResponse'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::ApiGatewayV2::ExportApi - Arguments for method ExportApi on L<Paws::ApiGatewayV2> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method ExportApi on the | ||
| 28 | L<AmazonApiGatewayV2|Paws::ApiGatewayV2> service. Use the attributes of this class | ||
| 29 | as arguments to method ExportApi. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ExportApi. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $apigateway = Paws->service('ApiGatewayV2'); | ||
| 36 | my $ExportApiResponse = $apigateway->ExportApi( | ||
| 37 | ApiId => 'My__string', | ||
| 38 | OutputType => 'My__string', | ||
| 39 | Specification => 'My__string', | ||
| 40 | ExportVersion => 'My__string', # OPTIONAL | ||
| 41 | IncludeExtensions => 1, # OPTIONAL | ||
| 42 | StageName => 'My__string', # OPTIONAL | ||
| 43 | ); | ||
| 44 | |||
| 45 | # Results: | ||
| 46 | my $Body = $ExportApiResponse->Body; | ||
| 47 | |||
| 48 | # Returns a L<Paws::ApiGatewayV2::ExportApiResponse> object. | ||
| 49 | |||
| 50 | 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. | ||
| 51 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/apigateway/ExportApi> | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> ApiId => Str | ||
| 57 | |||
| 58 | The API identifier. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 ExportVersion => Str | ||
| 63 | |||
| 64 | The version of the API Gateway export algorithm. API Gateway uses the | ||
| 65 | latest version by default. Currently, the only supported version is | ||
| 66 | 1.0. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 IncludeExtensions => Bool | ||
| 71 | |||
| 72 | Specifies whether to include API Gateway extensions | ||
| 73 | (https://docs.aws.amazon.com//apigateway/latest/developerguide/api-gateway-swagger-extensions.html) | ||
| 74 | in the exported API definition. API Gateway extensions are included by | ||
| 75 | default. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 B<REQUIRED> OutputType => Str | ||
| 80 | |||
| 81 | The output type of the exported definition file. Valid values are JSON | ||
| 82 | and YAML. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 B<REQUIRED> Specification => Str | ||
| 87 | |||
| 88 | The version of the API specification to use. OAS30, for OpenAPI 3.0, is | ||
| 89 | the only supported value. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 StageName => Str | ||
| 94 | |||
| 95 | The name of the API stage to export. If you don't specify this | ||
| 96 | property, a representation of the latest API configuration is exported. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head1 SEE ALSO | ||
| 102 | |||
| 103 | This class forms part of L<Paws>, documenting arguments for method ExportApi in L<Paws::ApiGatewayV2> | ||
| 104 | |||
| 105 | =head1 BUGS and CONTRIBUTIONS | ||
| 106 | |||
| 107 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 108 | |||
| 109 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 110 | |||
| 111 | =cut | ||
| 112 |