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

***********************
get_documentation_parts
***********************



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

  

  Gets documentation parts.

  

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


  **Request Syntax**
  ::

    response = client.get_documentation_parts(
        restApiId='string',
        type='API'|'AUTHORIZER'|'MODEL'|'RESOURCE'|'METHOD'|'PATH_PARAMETER'|'QUERY_PARAMETER'|'REQUEST_HEADER'|'REQUEST_BODY'|'RESPONSE'|'RESPONSE_HEADER'|'RESPONSE_BODY',
        nameQuery='string',
        path='string',
        position='string',
        limit=123,
        locationStatus='DOCUMENTED'|'UNDOCUMENTED'
    )
    
  :type restApiId: string
  :param restApiId: **[REQUIRED]** 

    The string identifier of the associated RestApi.

    

  
  :type type: string
  :param type: 

    The type of API entities of the to-be-retrieved documentation parts.

    

  
  :type nameQuery: string
  :param nameQuery: 

    The name of API entities of the to-be-retrieved documentation parts.

    

  
  :type path: string
  :param path: 

    The path of API entities of the to-be-retrieved documentation parts.

    

  
  :type position: string
  :param position: 

    The current pagination position in the paged result set.

    

  
  :type limit: integer
  :param limit: 

    The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

    

  
  :type locationStatus: string
  :param locationStatus: 

    The status of the API documentation parts to retrieve. Valid values are ``DOCUMENTED`` for retrieving DocumentationPart resources with content and ``UNDOCUMENTED`` for DocumentationPart resources without content.

    

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

    
    ::

      {
          'position': 'string',
          'items': [
              {
                  'id': 'string',
                  'location': {
                      'type': 'API'|'AUTHORIZER'|'MODEL'|'RESOURCE'|'METHOD'|'PATH_PARAMETER'|'QUERY_PARAMETER'|'REQUEST_HEADER'|'REQUEST_BODY'|'RESPONSE'|'RESPONSE_HEADER'|'RESPONSE_BODY',
                      'path': 'string',
                      'method': 'string',
                      'statusCode': 'string',
                      'name': 'string'
                  },
                  'properties': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 

      The collection of documentation parts of an API.

      
      

      - **position** *(string) --* 
      

      - **items** *(list) --* 

        The current page of elements from this collection.

        
        

        - *(dict) --* 

          A documentation part for a targeted API entity.

          
          

          - **id** *(string) --* 

            The DocumentationPart identifier, generated by API Gateway when the ``DocumentationPart`` is created.

            
          

          - **location** *(dict) --* 

            The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.

            
            

            - **type** *(string) --* 

              The type of API entity to which the documentation content applies. Valid values are ``API``, ``AUTHORIZER``, ``MODEL``, ``RESOURCE``, ``METHOD``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY``, ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. Content inheritance does not apply to any entity of the ``API``, ``AUTHORIZER``, ``METHOD``, ``MODEL``, ``REQUEST_BODY``, or ``RESOURCE`` type.

              
            

            - **path** *(string) --* 

              The URL path of the target. It is a valid field for the API entity types of ``RESOURCE``, ``METHOD``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY``, ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. The default value is ``/`` for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other ``location`` attributes, the child entity's ``path`` attribute must match that of the parent entity as a prefix.

              
            

            - **method** *(string) --* 

              The HTTP verb of a method. It is a valid field for the API entity types of ``METHOD``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY``, ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. The default value is ``*`` for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other ``location`` attributes, the child entity's ``method`` attribute must match that of the parent entity exactly.

              
            

            - **statusCode** *(string) --* 

              The HTTP status code of a response. It is a valid field for the API entity types of ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. The default value is ``*`` for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other ``location`` attributes, the child entity's ``statusCode`` attribute must match that of the parent entity exactly.

              
            

            - **name** *(string) --* 

              The name of the targeted API entity. It is a valid and required field for the API entity types of ``AUTHORIZER``, ``MODEL``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY`` and ``RESPONSE_HEADER``. It is an invalid field for any other entity type.

              
        
          

          - **properties** *(string) --* 

            A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., ``"{ \"description\": \"The API does ...\" }"``. Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of ``x-amazon-apigateway-documentation``.

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

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

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

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

  