MethodResponse

class aws_cdk.aws_apigateway.MethodResponse(*, status_code, response_models=None, response_parameters=None)

Bases: object

__init__(*, status_code, response_models=None, response_parameters=None)
Parameters
  • status_code (str) – The method response’s status code, which you map to an IntegrationResponse. Required.

  • response_models (Optional[Mapping[str, IModel]]) – The resources used for the response’s content type. Specify response models as key-value pairs (string-to-string maps), with a content type as the key and a Model resource name as the value. Default: None

  • response_parameters (Optional[Mapping[str, bool]]) – Response parameters that API Gateway sends to the client that called a method. Specify response parameters as key-value pairs (string-to-Boolean maps), with a destination as the key and a Boolean as the value. Specify the destination using the following pattern: method.response.header.name, where the name is a valid, unique header name. The Boolean specifies whether a parameter is required. Default: None

Attributes

response_models

The resources used for the response’s content type.

Specify response models as key-value pairs (string-to-string maps), with a content type as the key and a Model resource name as the value.

default :default: None

Return type

Optional[Mapping[str, IModel]]

response_parameters

method.response.header.name, where the name is a valid, unique header name. The Boolean specifies whether a parameter is required.

default :default: None

Type

Response parameters that API Gateway sends to the client that called a method. Specify response parameters as key-value pairs (string-to-Boolean maps), with a destination as the key and a Boolean as the value. Specify the destination using the following pattern

Return type

Optional[Mapping[str, bool]]

status_code

The method response’s status code, which you map to an IntegrationResponse. Required.

Return type

str