Configuration d'une méthode à l'aide de la console API Gateway

Dans le volet Ressources, choisissez votre méthode, puis cliquez sur l'onglet Demande de méthode.

Dans la section Paramètres de la demande de méthode, choisissez Modifier.

Pour Autorisation, sélectionnez un mécanisme d'autorisation disponible.

1. Pour activer l'accès ouvert à la méthode pour n'importe quel utilisateur, choisissez Aucun. Cette étape peut être ignorée si le paramètre par défaut n'a pas été modifié.

2. Pour utiliser IAM les autorisations afin de contrôler l'accès du client à la méthode, sélectionnezAWS_IAM. Avec ce choix, seuls les utilisateurs des IAM rôles associés à la IAM politique appropriée sont autorisés à appeler cette méthode.

   Pour créer le IAM rôle, spécifiez une politique d'accès au format suivant :

   {
     "Version": "2012-10-17",
     "Statement": [
       {
         "Effect": "Allow",
         "Action": [
           "execute-api:Invoke"
         ],
         "Resource": [
           "resource-statement"
         ]
       }
     ]
   }  

   Dans cette politique d'accès, resource-statement est la méthode ARN de votre choix. Vous pouvez trouver votre méthode en la sélectionnant sur la page Ressources. ARN Pour plus d'informations sur la définition IAM des autorisations, consultezContrôler l'accès à un REST API avec des IAM autorisations.

   Pour créer le IAM rôle, vous pouvez adapter les instructions du didacticiel suivant,Création d'une fonction Lambda pour l'intégration non proxy Lambda.

3. Pour utiliser un mécanisme d'autorisation Lambda, sélectionnez un jeton ou un mécanisme d'autorisation de demande. Créez un mécanisme d'autorisation Lambda pour que ce choix s'affiche dans le menu déroulant. Pour de plus amples informations sur la création d'un mécanisme d'autorisation Lambda, veuillez consulter Utiliser les API autorisateurs Gateway Lambda.

4. Pour utiliser un groupe d'utilisateurs Amazon Cognito, choisissez un groupe d'utilisateurs disponible sous Cognito user pool authorizers (Mécanismes d'autorisation du groupe d'utilisateurs Cognito). Créez un groupe d'utilisateurs dans Amazon Cognito et un autorisateur de groupe d'utilisateurs Amazon Cognito API dans Gateway pour afficher ce choix dans le menu déroulant. Pour de plus amples informations sur la manière de créer un mécanisme d'autorisation de groupe d'utilisateurs Amazon Cognito, veuillez consulter Contrôlez l'accès aux API REST en utilisant les groupes d'utilisateurs Amazon Cognito comme autorisateur.

Pour spécifier la validation des demandes, sélectionnez une valeur dans le menu déroulant Validateur de demande. Pour désactiver la validation des demandes, sélectionnez Aucune. Pour plus d'informations concernant chaque option, consultez Demande de validation pour REST APIs in API Gateway.

Sélectionnez APIla clé requise pour demander une API clé. Lorsqu'elles sont activées, API les clés sont utilisées dans les plans d'utilisation pour limiter le trafic client.

(Facultatif) Pour attribuer un nom SDK d'opération dans un Java généré par API Gateway, entrez un nom dans le champ Nom de l'opération. API Par exemple, pour la demande de méthode deGET /pets/{petId}, le nom de l'SDKopération Java correspondante est, par défaut,GetPetsPetId. Ce nom est construit à partir du HTTP verbe (GET) de la méthode et des noms des variables du chemin de ressource (PetsetPetId). Si vous définissez le nom de l'opération comme telgetPetById, le nom de l'SDKopération devientGetPetById.

Pour ajouter un paramètre de chaîne de requête à la méthode, procédez comme suit :

1. Choisissez Paramètres de chaîne de URL requête, puis choisissez Ajouter une chaîne de requête.

2. Pour Nom, entrez le nom du paramètre de chaîne de requête.

3. Sélectionnez Obligatoire si le paramètre de chaîne de requête récemment créé doit être utilisé pour une validation de demande. Pour plus d'informations sur la validation de demande, consultez Demande de validation pour REST APIs in API Gateway.

4. Sélectionnez Mise en cache si le paramètre de chaîne de requête récemment créé doit être utilisé dans le cadre d'une clé de mise en cache. Pour plus d'informations sur la mise en cache, consultez Utilisation de paramètres de méthode ou d'intégration en tant que clés de cache pour indexer les réponses mises en cache.

Pour supprimer le paramètre de chaîne de requête, choisissez Supprimer.

Pour ajouter un paramètre d'en-tête à la méthode, procédez comme suit :

1. Choisissez les en-têtes de HTTP demande, puis choisissez Ajouter un en-tête.

2. Pour Nom, entrez le nom de l'en-tête.

3. Sélectionnez Obligatoire si l'en-tête récemment créé doit être utilisé pour une validation de demande. Pour plus d'informations sur la validation de demande, consultez Demande de validation pour REST APIs in API Gateway.

4. Sélectionnez Mise en cache si l'en-tête récemment créé doit être utilisé dans le cadre d'une clé de mise en cache. Pour plus d'informations sur la mise en cache, consultez Utilisation de paramètres de méthode ou d'intégration en tant que clés de cache pour indexer les réponses mises en cache.

Pour supprimer l'en-tête, choisissez Supprimer.

Pour déclarer le format de charge utile d'une demande de méthode à l'aide du PATCH HTTP verbe POSTPUT, ou, choisissez le corps de la demande, puis procédez comme suit :

1. Choisissez Add model.

2. Pour Content-type, entrez un MIME -type (par exemple,). application/json

3. Pour Modèle, sélectionnez un modèle dans le menu déroulant. Les modèles actuellement disponibles pour le API incluent les modèles par défaut Empty et Error les modèles, ainsi que tous les modèles que vous avez créés et ajoutés à la collection Models duAPI. Pour plus d'informations sur la création d'un modèle, consultez Modèles de données pour REST APIs.

   Note

   Le modèle est utile pour informer le client du format de données prévu pour une charge utile. Il permet également de générer un modèle de mappage squelettique. Il est important de générer un code fortement typé SDK de API dans des langages tels que Java, C#, Objective-C et Swift. Ceci est nécessaire uniquement si la validation de demande est activée pour la charge utile.

Choisissez Save (Enregistrer).

Dans le volet Ressources, choisissez votre méthode, puis cliquez sur l'onglet Réponse de la méthode. Vous devrez peut-être choisir la flèche droite pour afficher l'onglet.

Dans la section Paramètres de réponse de la méthode, choisissez Créer une réponse.

Pour HTTPle code d'état, entrez un code d'HTTPétat tel que 200400, ou500.

Lorsqu'aucune réponse de méthode correspondante n'est définie pour une réponse renvoyée par le backend, API Gateway ne renvoie pas la réponse au client. Au lieu de cela, une réponse d'erreur 500 Internal server error est renvoyée.

Sélectionnez Add header.

Pour Nom de l'en-tête, entrez un nom.

Pour renvoyer un en-tête du backend au client, ajoutez-le dans la réponse de la méthode.

Choisissez Ajouter un modèle pour définir un format pour le corps de la réponse de méthode.

Entrez le type de média de la charge utile de la réponse pour Type de contenu et choisissez un modèle dans le menu déroulant Modèles.

Choisissez Save (Enregistrer).