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
show all
Defined in:
(unknown)

Overview

Note:

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",
}

Request a new export of a RestApi for a particular Stage.

Instance Attribute Summary collapse

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.

Returns:

  • (String) —

    The content-type of the export, for example application/json.

#export_type ⇒ String

[Required] The type of export. Acceptable values are \'oas30\' for OpenAPI 3.0.x and \'swagger\' for Swagger/OpenAPI 2.0.

Returns:

  • (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. 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

Returns:

  • (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.

Returns:

  • (String) —

    [Required] The string identifier of the associated RestApi.

#stage_name ⇒ String

[Required] The name of the Stage that will be exported.

Returns:

  • (String) —

    [Required] The name of the Stage that will be exported.