You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::APIGateway::Types::GetExportRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::GetExportRequest
- Defined in:
- (unknown)
Overview
When passing GetExportRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
rest_api_id: "String", # required
stage_name: "String", # required
export_type: "String", # required
parameters: {
"String" => "String",
},
accepts: "String",
}
Instance Attribute Summary collapse
-
#accepts ⇒ String
The content-type of the export, for example
application/json
. -
#export_type ⇒ String
[Required] The type of export.
-
#parameters ⇒ Hash<String,String>
A key-value map of query string parameters that specify properties of the export, depending on the requested
exportType
. -
#rest_api_id ⇒ String
[Required] The string identifier of the associated RestApi.
-
#stage_name ⇒ String
[Required] The name of the Stage that will be exported.
Instance Attribute Details
#accepts ⇒ String
The content-type of the export, for example application/json
.
Currently application/json
and application/yaml
are supported for
exportType
ofoas30
and swagger
. This should be specified in the
Accept
header for direct API requests.
#export_type ⇒ String
[Required] The type of export. Acceptable values are \'oas30\' for OpenAPI 3.0.x and \'swagger\' for Swagger/OpenAPI 2.0.
#parameters ⇒ Hash<String,String>
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
#rest_api_id ⇒ String
[Required] The string identifier of the associated RestApi.
#stage_name ⇒ String
[Required] The name of the Stage that will be exported.