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

***********************
update_gateway_response
***********************



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

  

  Updates a GatewayResponse of a specified response type on the given RestApi.

  

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


  **Request Syntax**
  ::

    response = client.update_gateway_response(
        restApiId='string',
        responseType='DEFAULT_4XX'|'DEFAULT_5XX'|'RESOURCE_NOT_FOUND'|'UNAUTHORIZED'|'INVALID_API_KEY'|'ACCESS_DENIED'|'AUTHORIZER_FAILURE'|'AUTHORIZER_CONFIGURATION_ERROR'|'INVALID_SIGNATURE'|'EXPIRED_TOKEN'|'MISSING_AUTHENTICATION_TOKEN'|'INTEGRATION_FAILURE'|'INTEGRATION_TIMEOUT'|'API_CONFIGURATION_ERROR'|'UNSUPPORTED_MEDIA_TYPE'|'BAD_REQUEST_PARAMETERS'|'BAD_REQUEST_BODY'|'REQUEST_TOO_LARGE'|'THROTTLED'|'QUOTA_EXCEEDED'|'WAF_FILTERED',
        patchOperations=[
            {
                'op': 'add'|'remove'|'replace'|'move'|'copy'|'test',
                'path': 'string',
                'value': 'string',
                'from': 'string'
            },
        ]
    )
    
  :type restApiId: string
  :param restApiId: **[REQUIRED]** 

    The string identifier of the associated RestApi.

    

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

    The response type of the associated GatewayResponse.

    

  
  :type patchOperations: list
  :param patchOperations: 

    For more information about supported patch operations, see `Patch Operations <https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html>`__.

    

  
    - *(dict) --* 

      For more information about supported patch operations, see `Patch Operations <https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html>`__.

      

    
      - **op** *(string) --* 

        An update operation to be performed with this PATCH request. The valid value can be add, remove, replace or copy. Not all valid operations are supported for a given resource. Support of the operations depends on specific operational contexts. Attempts to apply an unsupported operation on a resource will return an error message..

        

      
      - **path** *(string) --* 

        The op operation's target, as identified by a JSON Pointer value that references a location within the targeted resource. For example, if the target resource has an updateable property of {"name":"value"}, the path for this property is /name. If the name property value is a JSON object (e.g., {"name": {"child/name": "child-value"}}), the path for the child/name property will be /name/child~1name. Any slash ("/") character appearing in path names must be escaped with "~1", as shown in the example above. Each op operation can have only one path associated with it.

        

      
      - **value** *(string) --* 

        The new target value of the update operation. It is applicable for the add or replace operation. When using AWS CLI to update a property of a JSON value, enclose the JSON object with a pair of single quotes in a Linux shell, e.g., '{"a": ...}'.

        

      
      - **from** *(string) --* 

        The copy update operation's source as identified by a JSON-Pointer value referencing the location within the targeted resource to copy the value from. For example, to promote a canary deployment, you copy the canary deployment ID to the affiliated deployment ID by calling a PATCH request on a Stage resource with "op":"copy", "from":"/canarySettings/deploymentId" and "path":"/deploymentId".

        

      
    

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

    
    ::

      {
          'responseType': 'DEFAULT_4XX'|'DEFAULT_5XX'|'RESOURCE_NOT_FOUND'|'UNAUTHORIZED'|'INVALID_API_KEY'|'ACCESS_DENIED'|'AUTHORIZER_FAILURE'|'AUTHORIZER_CONFIGURATION_ERROR'|'INVALID_SIGNATURE'|'EXPIRED_TOKEN'|'MISSING_AUTHENTICATION_TOKEN'|'INTEGRATION_FAILURE'|'INTEGRATION_TIMEOUT'|'API_CONFIGURATION_ERROR'|'UNSUPPORTED_MEDIA_TYPE'|'BAD_REQUEST_PARAMETERS'|'BAD_REQUEST_BODY'|'REQUEST_TOO_LARGE'|'THROTTLED'|'QUOTA_EXCEEDED'|'WAF_FILTERED',
          'statusCode': 'string',
          'responseParameters': {
              'string': 'string'
          },
          'responseTemplates': {
              'string': 'string'
          },
          'defaultResponse': True|False
      }
      
    **Response Structure**

    

    - *(dict) --* 

      A gateway response of a given response type and status code, with optional response parameters and mapping templates.

      
      

      - **responseType** *(string) --* 

        The response type of the associated GatewayResponse.

        
      

      - **statusCode** *(string) --* 

        The HTTP status code for this GatewayResponse.

        
      

      - **responseParameters** *(dict) --* 

        Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

        
        

        - *(string) --* 
          

          - *(string) --* 
    
  
      

      - **responseTemplates** *(dict) --* 

        Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

        
        

        - *(string) --* 
          

          - *(string) --* 
    
  
      

      - **defaultResponse** *(boolean) --* 

        A Boolean flag to indicate whether this GatewayResponse is the default gateway response ( ``true``) or not ( ``false``). A default gateway response is one generated by API Gateway without any customization by an API developer.

        
  
  **Exceptions**
  
  *   :py:class:`APIGateway.Client.exceptions.BadRequestException`

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

  
  *   :py:class:`APIGateway.Client.exceptions.LimitExceededException`

  
  *   :py:class:`APIGateway.Client.exceptions.NotFoundException`

  
  *   :py:class:`APIGateway.Client.exceptions.UnauthorizedException`

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

  