:doc:`ApiGatewayV2 <../../apigatewayv2>` / Paginator / GetIntegrationResponses

***********************
GetIntegrationResponses
***********************



.. py:class:: ApiGatewayV2.Paginator.GetIntegrationResponses

  ::

    
    paginator = client.get_paginator('get_integration_responses')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`ApiGatewayV2.Client.get_integration_responses`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          ApiId='string',
          IntegrationId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type ApiId: string
    :param ApiId: **[REQUIRED]** 

      The API identifier.

      

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

      The integration ID.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

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

      
      ::

        {
            'Items': [
                {
                    'ContentHandlingStrategy': 'CONVERT_TO_BINARY'|'CONVERT_TO_TEXT',
                    'IntegrationResponseId': 'string',
                    'IntegrationResponseKey': 'string',
                    'ResponseParameters': {
                        'string': 'string'
                    },
                    'ResponseTemplates': {
                        'string': 'string'
                    },
                    'TemplateSelectionExpression': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 

        Success

        
        

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

          The elements from this collection.

          
          

          - *(dict) --* 

            Represents an integration response.

            
            

            - **ContentHandlingStrategy** *(string) --* 

              Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

               

              CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

               

              CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

               

              If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

              
            

            - **IntegrationResponseId** *(string) --* 

              The integration response ID.

              
            

            - **IntegrationResponseKey** *(string) --* 

              The integration response key.

              
            

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

              A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

              
              

              - *(string) --* 
                

                - *(string) --* 

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

                  
          
        
            

            - **ResponseTemplates** *(dict) --* 

              The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

              
              

              - *(string) --* 
                

                - *(string) --* 

                  A string with a length between [0-32768].

                  
          
        
            

            - **TemplateSelectionExpression** *(string) --* 

              The template selection expressions for the integration response.

              
        
      
    