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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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.

Constant Summary collapse

SENSITIVE =
[]

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

Returns:

  • (String)

3172
3173
3174
3175
3176
3177
3178
3179
3180
# File 'lib/aws-sdk-apigateway/types.rb', line 3172

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

#export_typeString

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

Returns:

  • (String)

3172
3173
3174
3175
3176
3177
3178
3179
3180
# File 'lib/aws-sdk-apigateway/types.rb', line 3172

class GetExportRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :export_type,
  :parameters,
  :accepts)
  SENSITIVE = []
  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` `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>)

3172
3173
3174
3175
3176
3177
3178
3179
3180
# File 'lib/aws-sdk-apigateway/types.rb', line 3172

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

#rest_api_idString

The string identifier of the associated RestApi.

Returns:

  • (String)

3172
3173
3174
3175
3176
3177
3178
3179
3180
# File 'lib/aws-sdk-apigateway/types.rb', line 3172

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

#stage_nameString

The name of the Stage that will be exported.

Returns:

  • (String)

3172
3173
3174
3175
3176
3177
3178
3179
3180
# File 'lib/aws-sdk-apigateway/types.rb', line 3172

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