:doc:`APIGateway <../../apigateway>` / Client / get_export

**********
get_export
**********



.. py:method:: APIGateway.Client.get_export(**kwargs)

  

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

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/apigateway-2015-07-09/GetExport>`_  


  **Request Syntax**
  ::

    response = client.get_export(
        restApiId='string',
        stageName='string',
        exportType='string',
        parameters={
            'string': 'string'
        },
        accepts='string'
    )
    
  :type restApiId: string
  :param restApiId: **[REQUIRED]** 

    The string identifier of the associated RestApi.

    

  
  :type stageName: string
  :param stageName: **[REQUIRED]** 

    The name of the Stage that will be exported.

    

  
  :type exportType: string
  :param exportType: **[REQUIRED]** 

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

    

  
  :type parameters: dict
  :param parameters: 

    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

    

  
    - *(string) --* 

    
      - *(string) --* 

      


  :type accepts: string
  :param accepts: 

    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.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'contentType': 'string',
          'contentDisposition': 'string',
          'body': StreamingBody()
      }
      
    **Response Structure**

    

    - *(dict) --* 

      The binary blob response to GetExport, which contains the generated SDK.

      
      

      - **contentType** *(string) --* 

        The content-type header value in the HTTP response. This will correspond to a valid 'accept' type in the request.

        
      

      - **contentDisposition** *(string) --* 

        The content-disposition header value in the HTTP response.

        
      

      - **body** (:class:`.StreamingBody`) -- 

        The binary blob response to GetExport, which contains the export.

        
  
  **Exceptions**
  
  *   :py:class:`APIGateway.Client.exceptions.BadRequestException`

  
  *   :py:class:`APIGateway.Client.exceptions.ConflictException`

  
  *   :py:class:`APIGateway.Client.exceptions.LimitExceededException`

  
  *   :py:class:`APIGateway.Client.exceptions.NotFoundException`

  
  *   :py:class:`APIGateway.Client.exceptions.UnauthorizedException`

  
  *   :py:class:`APIGateway.Client.exceptions.TooManyRequestsException`

  