APIGateway / Client / put_method_response

put_method_response#

APIGateway.Client.put_method_response(**kwargs)#

Adds a MethodResponse to an existing Method resource.

See also: AWS API Documentation

Request Syntax

response = client.put_method_response(
    restApiId='string',
    resourceId='string',
    httpMethod='string',
    statusCode='string',
    responseParameters={
        'string': True|False
    },
    responseModels={
        'string': 'string'
    }
)
Parameters:

  • restApiId (string) –

    [REQUIRED]

    The string identifier of the associated RestApi.

  • resourceId (string) –

    [REQUIRED]

    The Resource identifier for the Method resource.

  • httpMethod (string) –

    [REQUIRED]

    The HTTP verb of the Method resource.

  • statusCode (string) –

    [REQUIRED]

    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 name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from 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) –

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