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

*************************
get_documentation_version
*************************



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

  

  Gets a documentation version.

  

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


  **Request Syntax**
  ::

    response = client.get_documentation_version(
        restApiId='string',
        documentationVersion='string'
    )
    
  :type restApiId: string
  :param restApiId: **[REQUIRED]** 

    The string identifier of the associated RestApi.

    

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

    The version identifier of the to-be-retrieved documentation snapshot.

    

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

    
    ::

      {
          'version': 'string',
          'createdDate': datetime(2015, 1, 1),
          'description': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      A snapshot of the documentation of an API.

      
      

      - **version** *(string) --* 

        The version identifier of the API documentation snapshot.

        
      

      - **createdDate** *(datetime) --* 

        The date when the API documentation snapshot is created.

        
      

      - **description** *(string) --* 

        The description of the API documentation snapshot.

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

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

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

  