Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Créez une API passerelle REST APIs avec Step Functions

Découvrez comment utiliser Amazon API Gateway pour créer, publier, gérer et surveiller, HTTP et REST APIs avec Step Functions. Pour intégrer API Gateway, vous définissez un Task état dans Step Functions qui appelle directement une API passerelle HTTP ou un point de REST terminaison de API passerelle, sans écrire de code ni dépendre d'une autre infrastructure. Une définition d'Taskétat inclut toutes les informations nécessaires à l'APIappel. Vous pouvez également sélectionner différentes méthodes d'autorisation.

Pour en savoir plus sur l'intégration avec AWS services dans Step Functions, voir Intégration des services et. Transmission de paramètres à un service API dans Step Functions

APIPrise en charge des fonctionnalités de passerelle

L'intégration de Step Functions API Gateway prend en charge certaines fonctionnalités de API Gateway, mais pas toutes. Pour une liste plus détaillée des fonctionnalités prises en charge, consultez ce qui suit.

Pour plus d'informations sur API Gateway et ses « HTTP and » RESTAPIs, consultez ce qui suit.

Format des demandes

Lorsque vous créez votre définition Task d'état, Step Functions valide les paramètres, crée le nécessaire URL pour effectuer l'appel, puis appelle leAPI. La réponse inclut le code d'HTTPétat, les en-têtes et le corps de la réponse. Le format de demande comporte des paramètres obligatoires et facultatifs.

Paramètres de demande requis

Paramètres de demande facultatifs

L'exemple de code suivant montre comment invoquer API Gateway à l'aide de Step Functions.

{
    "Type": "Task", 
    "Resource":"arn:aws:states:::apigateway:invoke", 
    "Parameters": {
        "ApiEndpoint": "example.execute-api.us-east-1.amazonaws.com",
        "Method": "GET", 
        "Headers": { 
            "key": ["value1", "value2"] 
        },
        "Stage": "prod",
        "Path": "bills",
        "QueryParameters": {
            "billId": ["123456"]
        },
        "RequestBody": {},
        "AuthType": "NO_AUTH"
    } 
}
    

Authentification et autorisation

Vous pouvez utiliser les méthodes d'authentification suivantes :

Modèles d'intégration des services

L'intégration API Gateway prend en charge deux modèles d'intégration de services :

Format de sortie

Les paramètres de sortie suivants sont fournis :

Exemple de réponse :

{
    "ResponseBody": {
        "myBills": []
    },
    "Headers": { 
        "key": ["value1", "value2"]
    }, 
    "StatusCode": 200,
    "StatusText": "OK" 
}

Gestion des erreurs

Lorsqu'une erreur se produit, un error et cause est renvoyé comme suit :

Dans les deux cas, le cause est renvoyé sous forme de chaîne.

L'exemple suivant montre une réponse dans laquelle une erreur s'est produite :

{
    "error": "ApiGateway.403", 
    "cause": "{\"message\":\"Missing Authentication Token\"}"
}

IAMpolitiques relatives aux appels vers Amazon API Gateway

Les exemples de modèles suivants montrent comment AWS Step Functions génère IAM des politiques basées sur les ressources contenues dans la définition de votre machine à états. Pour plus d’informations, consultez Comment Step Functions génère IAM des politiques pour les services intégrés et Découvrez les modèles d'intégration des services dans Step Functions.

Ressources:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "execute-api:Invoke"
            ],
            "Resource": [
                "arn:[[region]]:[[accountId]]:*"
            ]
        }
    ]
}

L'exemple de code suivant montre une politique de ressources pour appeler API Gateway.

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Principal": {
                "Service": "states.amazonaws.com"
            },
            "Action": "execute-api:Invoke",
            "Resource": "arn:aws:execute-api:<region>:<account-id>:<api-id>/<stage-name>/<HTTP-VERB>/<resource-path-specifier>",
            "Condition": {
                "StringEquals": {
                    "aws:SourceArn": [
                        "<SourceStateMachineArn>"
                    ]
                }
            }
        }
    ]
}