GetExport
Exports a deployed version of a RestApi in a specified format.
Request Syntax
GET /restapis/restapi_id/stages/stage_name/exports/export_type?parameters HTTP/1.1
Accept: accepts
URI Request Parameters
The request uses the following URI parameters.
- accepts
-
The content-type of the export, for example
application/json. Currentlyapplication/jsonandapplication/yamlare supported forexportTypeofoas30andswagger. This should be specified in theAcceptheader for direct API requests. - export_type
-
The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.
Required: Yes
- parameters
-
A key-value map of query string parameters that specify properties of the export, depending on the requested
exportType. ForexportTypeoas30andswagger, any combination of the following parameters are supported:extensions='integrations'orextensions='apigateway'will export the API with x-amazon-apigateway-integration extensions.extensions='authorizers'will export the API with x-amazon-apigateway-authorizer extensions.postmanwill export the API with Postman extensions, allowing for import to the Postman tool - restapi_id
-
The string identifier of the associated RestApi.
Required: Yes
- stage_name
-
The name of the Stage that will be exported.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-Type: contentType
Content-Disposition: contentDisposition
bodyResponse Elements
If the action is successful, the service sends back an HTTP 200 response.
The response returns the following HTTP headers.
- contentDisposition
-
The content-disposition header value in the HTTP response.
- contentType
-
The content-type header value in the HTTP response. This will correspond to a valid 'accept' type in the request.
The response returns the following as the HTTP body.
- body
-
The binary blob response to GetExport, which contains the export.
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
HTTP Status Code: 400
- ConflictException
-
The request configuration has conflicts. For details, see the accompanying error message.
HTTP Status Code: 409
- LimitExceededException
-
The request exceeded the rate limit. Retry after the specified time period.
HTTP Status Code: 429
- NotFoundException
-
The requested resource is not found. Make sure that the request URI is correct.
HTTP Status Code: 404
- TooManyRequestsException
-
The request has reached its throttling limit. Retry after the specified time period.
HTTP Status Code: 429
- UnauthorizedException
-
The request is denied because the caller has insufficient permissions.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
