get_export `async` ¶

get_export(
    rest_api_id: String,
    stage_name: String,
    export_type: String,
    *,
    config_overrides: Optional[AsyncAPIGatewayClientConfig] = None,
    parameters: Optional[MapOfStringToString] = None,
    accepts: Optional[String] = None,
) -> ExportResponse

Exports a deployed version of a RestApi in a specified format.

Parameters:

rest_api_id (String) –

The string identifier of the associated RestApi.
stage_name (String) –

The name of the Stage that will be exported.
export_type (String) –

The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.
parameters (Optional[MapOfStringToString], default: 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
accepts (Optional[String], default: 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.

Raises:

BadRequestException –

The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ConflictException –

The request configuration has conflicts. For details, see the accompanying error message.
LimitExceededException –

The request exceeded the rate limit. Retry after the specified time period.
NotFoundException –

The requested resource is not found. Make sure that the request URI is correct.
TooManyRequestsException –

The request has reached its throttling limit. Retry after the specified time period.
UnauthorizedException –

The request is denied because the caller has insufficient permissions.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_api_gateway/_services/async_api_gateway.py

async def get_export(
    self,
    rest_api_id: "capo_api_gateway.types.string.String",
    stage_name: "capo_api_gateway.types.string.String",
    export_type: "capo_api_gateway.types.string.String",
    *,
    config_overrides: Optional[AsyncAPIGatewayClientConfig] = None,
    parameters: Optional[
        "capo_api_gateway.types.map_of_string_to_string.MapOfStringToString"
    ] = None,
    accepts: Optional["capo_api_gateway.types.string.String"] = None,
) -> "capo_api_gateway.types.export_response.ExportResponse":
    """<p>Exports a deployed version of a RestApi in a specified format.</p>

    Args:
        rest_api_id: <p>The string identifier of the associated RestApi.</p>
        stage_name: <p>The name of the Stage that will be exported.</p>
        export_type: <p>The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.</p>
        parameters: <p>A key-value map of query string parameters that specify properties of the export, depending on the requested <code>exportType</code>. For <code>exportType</code> <code>oas30</code> and <code>swagger</code>, any combination of the following parameters are supported: <code>extensions='integrations'</code> or <code>extensions='apigateway'</code> will export the API with x-amazon-apigateway-integration extensions. <code>extensions='authorizers'</code> will export the API with x-amazon-apigateway-authorizer extensions. <code>postman</code> will export the API with Postman extensions, allowing for import to the Postman tool</p>
        accepts: <p>The content-type of the export, for example <code>application/json</code>. Currently <code>application/json</code> and <code>application/yaml</code> are supported for <code>exportType</code> of<code>oas30</code> and <code>swagger</code>. This should be specified in the <code>Accept</code> header for direct API requests.</p>

    Raises:
        capo_api_gateway.errors.bad_request_exception.BadRequestException: <p>The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
        capo_api_gateway.errors.conflict_exception.ConflictException: <p>The request configuration has conflicts. For details, see the accompanying error message.</p>
        capo_api_gateway.errors.limit_exceeded_exception.LimitExceededException: <p>The request exceeded the rate limit. Retry after the specified time period.</p>
        capo_api_gateway.errors.not_found_exception.NotFoundException: <p>The requested resource is not found. Make sure that the request URI is correct.</p>
        capo_api_gateway.errors.too_many_requests_exception.TooManyRequestsException: <p>The request has reached its throttling limit. Retry after the specified time period.</p>
        capo_api_gateway.errors.unauthorized_exception.UnauthorizedException: <p>The request is denied because the caller has insufficient permissions.</p>
        capo_api_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_api_gateway.types.get_export_request.GetExportRequest]",
    ) -> AsyncOperationResponse[
        "capo_api_gateway.types.export_response.ExportResponse"
    ]:
        import capo_api_gateway._operations.backplane_control_service.get_export

        (
            output,
            http_response,
        ) = await capo_api_gateway._operations.backplane_control_service.get_export.async_get_export(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetExport")
    )
    input_: capo_api_gateway.types.get_export_request.GetExportRequest = {
        "rest_api_id": rest_api_id,
        "stage_name": stage_name,
        "export_type": export_type,
    }
    if parameters is not None:
        input_["parameters"] = parameters
    if accepts is not None:
        input_["accepts"] = accepts

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

get_export async ¶

get_export `async` ¶