get_export¶
Operation¶
async
¶
get_export(input: GetExportInput, plugins: list[Plugin] | None = None) -> GetExportOutput
Exports a deployed version of a RestApi in a specified format.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetExportInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
GetExportOutput
|
An instance of |
Input¶
dataclass
¶
Request a new export of a RestApi for a particular Stage.
Attributes¶
class-attribute
instance-attribute
¶
accepts: str | None = None
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.
class-attribute
instance-attribute
¶
export_type: str | None = None
The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.
class-attribute
instance-attribute
¶
parameters: dict[str, str] | None = None
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
class-attribute
instance-attribute
¶
rest_api_id: str | None = None
The string identifier of the associated RestApi.
class-attribute
instance-attribute
¶
stage_name: str | None = None
The name of the Stage that will be exported.
Output¶
dataclass
¶
The binary blob response to GetExport, which contains the generated SDK.
Attributes¶
class-attribute
instance-attribute
¶
body: bytes | None = None
The binary blob response to GetExport, which contains the export.
class-attribute
instance-attribute
¶
content_disposition: str | None = None
The content-disposition header value in the HTTP response.
class-attribute
instance-attribute
¶
content_type: str | None = None
The content-type header value in the HTTP response. This will correspond to a valid 'accept' type in the request.