x-amazon-apigateway-integration.response 객체

응답을 정의하고 통합 응답에서 메서드 응답으로 파라미터 매핑 또는 페이로드 매핑을 지정합니다.

속성
속성 이름	유형	설명
statusCode	string	메서드 응답에 대한 HTTP 상태 코드입니다(예: "200"). 이는 OpenAPI 작업 responses 필드의 일치하는 응답에 해당해야 합니다.
responseTemplates	x-amazon-apigateway-integration. 응답 템플릿 객체	응답의 페이로드에 대한 MIME 유형 관련 매핑 템플릿을 지정합니다.
responseParameters	x-amazon-apigateway-integration. 응답 매개변수 객체	응답에 대한 파라미터 매핑을 지정합니다. 통합 응답의 header 및 body 파라미터만 메서드의 header 파라미터에 매핑될 수 있습니다.
contentHandling	string	응답 페이로드 인코딩 변환 유형입니다. 유효한 값은 1) 이진 페이로드를 Base64 인코딩 문자열로 변환하거나, 텍스트 페이로드를 utf-8 인코딩 문자열로 변환하거나, 기본적으로 수정 없이 텍스트 페이로드를 패스스루하는 경우에는 CONVERT_TO_TEXT이고, 2) 텍스트 페이로드를 Base64 디코딩 BLOB로 변환하거나 기본적으로 수정 없이 이진 페이로드를 패스스루하는 경우에는 CONVERT_TO_BINARY입니다.

x-amazon-apigateway-integration.response 예제

다음 예는 백엔드에서 302 또는 application/json MIME 유형의 페이로드를 추출하는 메서드에 대한 application/xml 응답을 정의합니다. 응답에서는 제공된 매핑 템플릿을 사용하고 메서드의 Location 헤더에 있는 통합 응답에서 리디렉션 URL을 반환합니다.

{
    "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"
    }
}