As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Crie um API gateway REST APIs com Step Functions

Aprenda a usar o Amazon API Gateway para criar, publicar, manter e monitorar HTTP e REST APIs com o Step Functions. Para integrar com o API Gateway, você define um Task estado em Step Functions que chama diretamente um API API Gateway HTTP ou REST endpoint do Gateway, sem escrever código ou depender de outra infraestrutura. Uma definição de Task estado inclui todas as informações necessárias para a API chamada. Também é possível selecionar métodos de autorização diferentes.

Para saber mais sobre a integração com AWS serviços no Step Functions, consulte Integração de produtos da e. Passando parâmetros para um serviço API em Step Functions

APISuporte ao recurso Gateway

A integração do Step Functions API Gateway suporta alguns, mas não todos os recursos do API Gateway. Para obter uma lista mais detalhada dos recursos compatíveis, consulte o seguinte:

Para obter mais informações sobre o API Gateway HTTP e seu e RESTAPIs, consulte o seguinte.

Formato de solicitação

Quando você cria sua definição de Task estado, o Step Functions valida os parâmetros, cria o necessário URL para realizar a chamada e, em seguida, chama o. API A resposta inclui o código de HTTP status, os cabeçalhos e o corpo da resposta. O formato da solicitação tem parâmetros obrigatórios e opcionais.

Parâmetros de solicitação obrigatórios

Parâmetros de solicitação opcionais

O exemplo de código a seguir mostra como invocar o API Gateway usando 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"
    } 
}
    

Autenticação e autorização

Você pode usar os seguintes métodos de autenticação:

Padrões de integração de serviço

A integração do API Gateway oferece suporte a dois padrões de integração de serviços:

Formato de saída

Os seguintes parâmetros de saída são fornecidos:

Um exemplo de resposta:

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

Gerenciamento de erros

Quando ocorre um erro, error e cause são retornados da seguinte forma:

Em ambos os casos, cause é retornado como uma string.

O seguinte exemplo mostra uma resposta em que ocorreu um erro:

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

IAMpolíticas para chamadas para o Amazon API Gateway

Os modelos de exemplo a seguir mostram como AWS Step Functions gera IAM políticas com base nos recursos em sua definição de máquina de estado. Para ter mais informações, consulte Como o Step Functions gera políticas do IAM para serviços integrados e Descobrir padrões de integração de serviços no Step Functions.

Recursos:

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

O exemplo de código a seguir mostra uma política de recursos para chamar o 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>"
                    ]
                }
            }
        }
    ]
}