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

***************************
update_integration_response
***************************



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

  

  Updates an IntegrationResponses.

  

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


  **Request Syntax**
  ::

    response = client.update_integration_response(
        ApiId='string',
        ContentHandlingStrategy='CONVERT_TO_BINARY'|'CONVERT_TO_TEXT',
        IntegrationId='string',
        IntegrationResponseId='string',
        IntegrationResponseKey='string',
        ResponseParameters={
            'string': 'string'
        },
        ResponseTemplates={
            'string': 'string'
        },
        TemplateSelectionExpression='string'
    )
    
  :type ApiId: string
  :param ApiId: **[REQUIRED]** 

    The API identifier.

    

  
  :type ContentHandlingStrategy: string
  :param ContentHandlingStrategy: 

    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.

    

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

    The integration ID.

    

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

    The integration response ID.

    

  
  :type IntegrationResponseKey: string
  :param IntegrationResponseKey: 

    The integration response key.

    

  
  :type ResponseParameters: dict
  :param ResponseParameters: 

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

        

      


  :type ResponseTemplates: dict
  :param ResponseTemplates: 

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

        

      


  :type TemplateSelectionExpression: string
  :param TemplateSelectionExpression: 

    The template selection expression for the integration response. Supported only for WebSocket APIs.

    

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

    
    ::

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

    

    - *(dict) --* 

      Success

      
      

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

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

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

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

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

  