class Aws::APIGateway::Types::GetExportRequest
Request a new export of a RestApi
for a particular Stage
.
@note When making an API call, you may pass GetExportRequest
data as a hash: { rest_api_id: "String", # required stage_name: "String", # required export_type: "String", # required parameters: { "String" => "String", }, accepts: "String", }
@!attribute [rw] rest_api_id
\[Required\] The string identifier of the associated RestApi. @return [String]
@!attribute [rw] stage_name
\[Required\] The name of the Stage that will be exported. @return [String]
@!attribute [rw] export_type
\[Required\] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0. @return [String]
@!attribute [rw] parameters
A key-value map of query string parameters that specify properties of the export, depending on the requested `exportType`. For `exportType` `oas30` and `swagger`, any combination of the following parameters are supported: `extensions='integrations'` or `extensions='apigateway'` will export the API with x-amazon-apigateway-integration extensions. `extensions='authorizers'` will export the API with x-amazon-apigateway-authorizer extensions. `postman` will export the API with Postman extensions, allowing for import to the Postman tool @return [Hash<String,String>]
@!attribute [rw] accepts
The content-type of the export, for example `application/json`. Currently `application/json` and `application/yaml` are supported for `exportType` of`oas30` and `swagger`. This should be specified in the `Accept` header for direct API requests. @return [String]
Constants
- SENSITIVE