:doc:`ApiGatewayV2 <../../apigatewayv2>` / Client / get_route_responses

*******************
get_route_responses
*******************



.. py:method:: ApiGatewayV2.Client.get_route_responses(**kwargs)

  

  Gets the RouteResponses for a Route.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/apigatewayv2-2018-11-29/GetRouteResponses>`_  


  **Request Syntax**
  ::

    response = client.get_route_responses(
        ApiId='string',
        MaxResults='string',
        NextToken='string',
        RouteId='string'
    )
    
  :type ApiId: string
  :param ApiId: **[REQUIRED]** 

    The API identifier.

    

  
  :type MaxResults: string
  :param MaxResults: 

    The maximum number of elements to be returned for this resource.

    

  
  :type NextToken: string
  :param NextToken: 

    The next page of elements from this collection. Not valid for the last element of the collection.

    

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

    The route ID.

    

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

    
    ::

      {
          'Items': [
              {
                  'ModelSelectionExpression': 'string',
                  'ResponseModels': {
                      'string': 'string'
                  },
                  'ResponseParameters': {
                      'string': {
                          'Required': True|False
                      }
                  },
                  'RouteResponseId': 'string',
                  'RouteResponseKey': 'string'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Success

      
      

      - **Items** *(list) --* 

        The elements from this collection.

        
        

        - *(dict) --* 

          Represents a route response.

          
          

          - **ModelSelectionExpression** *(string) --* 

            Represents the model selection expression of a route response. Supported only for WebSocket APIs.

            
          

          - **ResponseModels** *(dict) --* 

            Represents the response models of a route response.

            
            

            - *(string) --* 
              

              - *(string) --* 

                A string with a length between [1-128].

                
        
      
          

          - **ResponseParameters** *(dict) --* 

            Represents the response parameters of a route response.

            
            

            - *(string) --* 
              

              - *(dict) --* 

                Validation constraints imposed on parameters of a request (path, query string, headers).

                
                

                - **Required** *(boolean) --* 

                  Whether or not the parameter is required.

                  
            
        
      
          

          - **RouteResponseId** *(string) --* 

            Represents the identifier of a route response.

            
          

          - **RouteResponseKey** *(string) --* 

            Represents the route response key of a route response.

            
      
    
      

      - **NextToken** *(string) --* 

        The next page of elements from this collection. Not valid for the last element of the collection.

        
  
  **Exceptions**
  
  *   :py:class:`ApiGatewayV2.Client.exceptions.NotFoundException`

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

  
  *   :py:class:`ApiGatewayV2.Client.exceptions.BadRequestException`

  