« blib/lib/Paws/ApiGateway/GetDomainNames.pm
↑ Summary
blib/lib/Paws/ApiGateway/GetGatewayResponse.pm »
| 1 | |||
| 2 | package Paws::ApiGateway::GetExport; | ||
| 3 | use Moose; | ||
| 4 | has Accepts => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'Accept'); | ||
| 5 | has ExportType => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'export_type', required => 1); | ||
| 6 | has Parameters => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToString', traits => ['ParamInQuery'], query_name => 'parameters'); | ||
| 7 | has RestApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'restapi_id', required => 1); | ||
| 8 | has StageName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'stage_name', required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetExport'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/restapis/{restapi_id}/stages/{stage_name}/exports/{export_type}'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::ExportResponse'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::ApiGateway::GetExport - Arguments for method GetExport on L<Paws::ApiGateway> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method GetExport on the | ||
| 27 | L<Amazon API Gateway|Paws::ApiGateway> service. Use the attributes of this class | ||
| 28 | as arguments to method GetExport. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetExport. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $apigateway = Paws->service('ApiGateway'); | ||
| 35 | my $ExportResponse = $apigateway->GetExport( | ||
| 36 | ExportType => 'MyString', | ||
| 37 | RestApiId => 'MyString', | ||
| 38 | StageName => 'MyString', | ||
| 39 | Accepts => 'MyString', # OPTIONAL | ||
| 40 | Parameters => { 'MyString' => 'MyString', }, # OPTIONAL | ||
| 41 | ); | ||
| 42 | |||
| 43 | # Results: | ||
| 44 | my $Body = $ExportResponse->Body; | ||
| 45 | my $ContentDisposition = $ExportResponse->ContentDisposition; | ||
| 46 | my $ContentType = $ExportResponse->ContentType; | ||
| 47 | |||
| 48 | # Returns a L<Paws::ApiGateway::ExportResponse> 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/GetExport> | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 Accepts => Str | ||
| 57 | |||
| 58 | The content-type of the export, for example C<application/json>. | ||
| 59 | Currently C<application/json> and C<application/yaml> are supported for | ||
| 60 | C<exportType> ofC<oas30> and C<swagger>. This should be specified in | ||
| 61 | the C<Accept> header for direct API requests. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 B<REQUIRED> ExportType => Str | ||
| 66 | |||
| 67 | [Required] The type of export. Acceptable values are 'oas30' for | ||
| 68 | OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 Parameters => L<Paws::ApiGateway::MapOfStringToString> | ||
| 73 | |||
| 74 | A key-value map of query string parameters that specify properties of | ||
| 75 | the export, depending on the requested C<exportType>. For C<exportType> | ||
| 76 | C<oas30> and C<swagger>, any combination of the following parameters | ||
| 77 | are supported: C<extensions='integrations'> or | ||
| 78 | C<extensions='apigateway'> will export the API with | ||
| 79 | x-amazon-apigateway-integration extensions. C<extensions='authorizers'> | ||
| 80 | will export the API with x-amazon-apigateway-authorizer extensions. | ||
| 81 | C<postman> will export the API with Postman extensions, allowing for | ||
| 82 | import to the Postman tool | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 B<REQUIRED> RestApiId => Str | ||
| 87 | |||
| 88 | [Required] The string identifier of the associated RestApi. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 B<REQUIRED> StageName => Str | ||
| 93 | |||
| 94 | [Required] The name of the Stage that will be exported. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head1 SEE ALSO | ||
| 100 | |||
| 101 | This class forms part of L<Paws>, documenting arguments for method GetExport in L<Paws::ApiGateway> | ||
| 102 | |||
| 103 | =head1 BUGS and CONTRIBUTIONS | ||
| 104 | |||
| 105 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 106 | |||
| 107 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 108 | |||
| 109 | =cut | ||
| 110 |