x-amazon-apigateway-integration.response-Objekt

Definiert eine Antwort und gibt Parameter-Mappings oder Nutzlast-Mappings aus der Integrationsantwort in die Methodenantwort an.

Eigenschaften
Name der Eigenschaft	Typ	Beschreibung
statusCode	string	HTTP-Statuscode für die Methodenantwort, zum Beispie, "200". Dieser muss einer übereinstimmenden Antwort im OpenAPI-Operation responses-Feld entsprechen.
responseTemplates	x-amazon-apigateway-integration.responseTemplates-Objekt	Gibt MIME-typenspezifische Mapping-Vorlagen für die Nutzlast der Antwort an.
responseParameters	x-amazon-apigateway-integration.responseParameters-Objekt	Gibt Parameter-Mappings für die Antwort an. Nur die header- und body-Parameter der Integrationsantwort können den header-Parametern der Methode zugeordnet werden.
contentHandling	string	Umwandlungstypen für Antwortnutzlastenkodierung. Gültige Werte sind 1) CONVERT_TO_TEXT für die Umwandlung einer binären Nutzlast in eine base64-kodierte Zeichenfolge oder die Umwandlung einer Textnutzlast in eine utf-8-kodierte Zeichenfolge oder die native Weiterleitung der Textnutzlast ohne Änderung und 2) CONVERT_TO_BINARY für die Umwandlung einer Textnutzlast in einen base64-dekodierten Blob oder die native Weiterleitung einer binären Nutzlast ohne Änderung.

x-amazon-apigateway-integration.responseBeispiel für

Im folgenden Beispiel wird eine 302-Antwort für die Methode definiert, die eine Nutzlast des application/json- oder application/xml-MIME-Typs vom Backend ableitet. Die Antwort verwendet die bereitgestellten Mapping-Vorlagen und gibt die Umleitungs-URL von der Integrationsantwort im Location-Header der Methode zurück.

{
    "statusCode" : "302",
    "responseTemplates" : {
         "application/json" : "#set ($root=$input.path('$')) { \"stage\": \"$root.name\", \"user-id\": \"$root.key\" }",
         "application/xml" : "#set ($root=$input.path('$')) <stage>$root.name</stage> "
    },
    "responseParameters" : {
        "method.response.header.Location": "integration.response.body.redirect.url"
    }
}