Interface MethodResponse

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
MethodResponse.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:33:56.797Z") @Stability(Stable) public interface MethodResponse extends software.amazon.jsii.JsiiSerializable
Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigateway.*;
 Model model;
 MethodResponse methodResponse = MethodResponse.builder()
         .statusCode("statusCode")
         // the properties below are optional
         .responseModels(Map.of(
                 "responseModelsKey", model))
         .responseParameters(Map.of(
                 "responseParametersKey", false))
         .build();
 
  • Method Details

    • getStatusCode

      @Stability(Stable) @NotNull String getStatusCode()
      The method response's status code, which you map to an IntegrationResponse.

      Required.

    • getResponseModels

      @Stability(Stable) @Nullable default Map<String,IModel> getResponseModels()
      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

    • getResponseParameters

      @Stability(Stable) @Nullable default Map<String,Boolean> getResponseParameters()
      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

    • builder

      @Stability(Stable) static MethodResponse.Builder builder()
      Returns:
      a MethodResponse.Builder of MethodResponse