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

**********************
get_base_path_mappings
**********************



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

  

  Represents a collection of BasePathMapping resources.

  

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


  **Request Syntax**
  ::

    response = client.get_base_path_mappings(
        domainName='string',
        domainNameId='string',
        position='string',
        limit=123
    )
    
  :type domainName: string
  :param domainName: **[REQUIRED]** 

    The domain name of a BasePathMapping resource.

    

  
  :type domainNameId: string
  :param domainNameId: 

    The identifier for the domain name resource. Supported only for private custom domain names.

    

  
  :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.

    

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

    
    ::

      {
          'position': 'string',
          'items': [
              {
                  'basePath': 'string',
                  'restApiId': 'string',
                  'stage': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Represents a collection of BasePathMapping resources.

      
      

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

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

        The current page of elements from this collection.

        
        

        - *(dict) --* 

          Represents the base path that callers of the API must provide as part of the URL after the domain name.

          
          

          - **basePath** *(string) --* 

            The base path name that callers of the API must provide as part of the URL after the domain name.

            
          

          - **restApiId** *(string) --* 

            The string identifier of the associated RestApi.

            
          

          - **stage** *(string) --* 

            The name of the associated stage.

            
      
    
  
  **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`

  