You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb

Overview

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

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

Instance Attribute Summary collapse

Instance Attribute Details

#acceptsString

The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType of swagger. This should be specified in the Accept header for direct API requests.

Returns:

  • (String)


3217
3218
3219
3220
3221
3222
3223
3224
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3217

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

#export_typeString

The type of export. Currently only 'swagger' is supported.

Returns:

  • (String)


3217
3218
3219
3220
3221
3222
3223
3224
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3217

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

#parametersHash<String,String>

A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType swagger, any combination of the following parameters are supported: integrations will export the API with x-amazon-apigateway-integration 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>)


3217
3218
3219
3220
3221
3222
3223
3224
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3217

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

#rest_api_idString

The string identifier of the associated RestApi.

Returns:

  • (String)


3217
3218
3219
3220
3221
3222
3223
3224
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3217

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

#stage_nameString

The name of the Stage that will be exported.

Returns:

  • (String)


3217
3218
3219
3220
3221
3222
3223
3224
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3217

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