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

*********************
get_base_path_mapping
*********************



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

  

  Describe a BasePathMapping resource.

  

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


  **Request Syntax**
  ::

    response = client.get_base_path_mapping(
        domainName='string',
        domainNameId='string',
        basePath='string'
    )
    
  :type domainName: string
  :param domainName: **[REQUIRED]** 

    The domain name of the BasePathMapping resource to be described.

    

  
  :type domainNameId: string
  :param domainNameId: 

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

    

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

    The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify any base path name after the domain name.

    

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

    
    ::

      {
          'basePath': 'string',
          'restApiId': 'string',
          'stage': 'string'
      }
      
    **Response Structure**

    

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

  