Class: Aws::APIGateway::Types::GetExportRequest

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::GetExportRequest

Includes:

Structure

Defined in:

lib/aws-sdk-apigateway/types.rb

Overview

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

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #accepts ⇒ String

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

• #export_type ⇒ String

  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

  The string identifier of the associated RestApi.

• #stage_name ⇒ String

  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` of`oas30` and `swagger`. This should be specified in the `Accept` header for direct API requests.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 2528

class GetExportRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :export_type,
  :parameters,
  :accepts)
  SENSITIVE = []
  include Aws::Structure
end

#export_type ⇒ String

The type of export. Acceptable values are ‘oas30’ for OpenAPI 3.0.x and ‘swagger’ for Swagger/OpenAPI 2.0.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 2528

class GetExportRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :export_type,
  :parameters,
  :accepts)
  SENSITIVE = []
  include Aws::Structure
end

#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>)

# File 'lib/aws-sdk-apigateway/types.rb', line 2528

class GetExportRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :export_type,
  :parameters,
  :accepts)
  SENSITIVE = []
  include Aws::Structure
end

#rest_api_id ⇒ String

The string identifier of the associated RestApi.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 2528

class GetExportRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :export_type,
  :parameters,
  :accepts)
  SENSITIVE = []
  include Aws::Structure
end

#stage_name ⇒ String

The name of the Stage that will be exported.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 2528

class GetExportRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :export_type,
  :parameters,
  :accepts)
  SENSITIVE = []
  include Aws::Structure
end