APIGateway / Client / update_method_response

update_method_response#

APIGateway.Client.update_method_response(**kwargs)#

Updates an existing MethodResponse resource.

Request Syntax

response = client.update_method_response(
    restApiId='string',
    resourceId='string',
    httpMethod='string',
    statusCode='string',
    patchOperations=[
        {
            'op': 'add'|'remove'|'replace'|'move'|'copy'|'test',
            'path': 'string',
            'value': 'string',
            'from': 'string'
        },
    ]
)

Parameters:

restApiId (string) –
[REQUIRED]

The string identifier of the associated RestApi.
resourceId (string) –
[REQUIRED]

The Resource identifier for the MethodResponse resource.
httpMethod (string) –
[REQUIRED]

The HTTP verb of the Method resource.
statusCode (string) –
[REQUIRED]

The status code for the MethodResponse resource.
patchOperations (list) –
For more information about supported patch operations, see Patch Operations.
- (dict) –
  
  For more information about supported patch operations, see Patch Operations.
  - 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”.

Return type:

dict

Returns:

Response Syntax

{
    'statusCode': 'string',
    'responseParameters': {
        'string': True|False
    },
    'responseModels': {
        'string': 'string'
    }
}

Response Structure

(dict) –

Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.
- statusCode (string) –
  
  The method response’s status code.
- responseParameters (dict) –
  
  A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API’s IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)
  - (string) –
    - (boolean) –
- responseModels (dict) –
  
  Specifies the Model resources used for the response’s content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
  - (string) –
    - (string) –

Exceptions

APIGateway.Client.exceptions.UnauthorizedException
APIGateway.Client.exceptions.NotFoundException
APIGateway.Client.exceptions.ConflictException
APIGateway.Client.exceptions.LimitExceededException
APIGateway.Client.exceptions.BadRequestException
APIGateway.Client.exceptions.TooManyRequestsException