Exemple de réponse personnalisée pour AWS SAM

Vous pouvez personnaliser certaines réponses aux erreurs de API Gateway en définissant des en-têtes de réponse dans votre AWS SAM modèle. Vous devez pour cela utiliser le type de données Objet de réponse de passerelle.

Voici un exemple de AWS SAM modèle qui crée une réponse personnalisée à l'DEFAULT_5XXerreur.

AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
Resources:
  MyApi:
    Type: AWS::Serverless::Api
    Properties:
      StageName: Prod
      GatewayResponses:
        DEFAULT_5XX:
          ResponseParameters:
            Headers:
              Access-Control-Expose-Headers: "'WWW-Authenticate'"
              Access-Control-Allow-Origin: "'*'"
              ErrorHeader: "'MyCustomErrorHeader'"
          ResponseTemplates:
            application/json: "{\"message\": \"Error on the $context.resourcePath resource\" }"
              
  GetFunction:
    Type: AWS::Serverless::Function
    Properties:
      Runtime: python3.10
      Handler: index.handler
      InlineCode: |
        def handler(event, context):
          raise Exception('Check out the new response!')
      Events:
        GetResource:
          Type: Api
          Properties:
            Path: /error
            Method: get
            RestApiId: !Ref MyApi

Pour plus d'informations sur les réponses de API Gateway, consultez la section Réponses de API Gateway dans Gateway dans le Guide du développeur de API Gateway.