APIGateway HTTP e WebSocket API exemplos usando AWS CLI - AWS SDKExemplos de código
Ações

Há mais AWS SDK exemplos disponíveis no GitHub repositório AWS Doc SDK Examples.

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á.

APIGateway HTTP e WebSocket API exemplos usando AWS CLI

Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface with API Gateway HTTP WebSocket API e.

Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar funções de serviço individuais, é possível ver as ações no contexto em seus cenários relacionados.

Cada exemplo inclui um link para o código-fonte completo, onde você pode encontrar instruções sobre como configurar e executar o código no contexto.

Tópicos

Ações

O código de exemplo a seguir mostra como usar create-api-mapping.

AWS CLI

Para criar um API mapeamento para um API

O create-api-mapping exemplo a seguir mapeia o test estágio de an API para o /myApi caminho do nome de domínio regional.example.com personalizado.

aws apigatewayv2 create-api-mapping \
    --domain-name regional.example.com \
    --api-mapping-key myApi \
    --api-id a1b2c3d4 \
    --stage test

Saída:

{
    "ApiId": "a1b2c3d4",
    "ApiMappingId": "0qzs2sy7bh",
    "ApiMappingKey": "myApi"
    "Stage": "test"
}

Para obter mais informações, consulte Configurando um nome de domínio regional personalizado no API Gateway no Amazon API Gateway Developer Guide.

  • Para API obter detalhes, consulte CreateApiMappingna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar create-api.

AWS CLI

Para criar um HTTP API

O create-api exemplo a seguir cria um HTTP API usando a criação rápida. Você pode usar a criação rápida para criar uma API com um AWS Lambda ou HTTP integração, uma rota abrangente padrão e um estágio padrão configurado para implantar alterações automaticamente. O comando a seguir usa a criação rápida para criar uma HTTP API que se integre a uma função Lambda.

aws apigatewayv2 create-api \
    --name my-http-api \
    --protocol-type HTTP \
    --target arn:aws:lambda:us-west-2:123456789012:function:my-lambda-function

Saída:

{
    "ApiEndpoint": "https://a1b2c3d4.execute-api.us-west-2.amazonaws.com",
    "ApiId": "a1b2c3d4",
    "ApiKeySelectionExpression": "$request.header.x-api-key",
    "CreatedDate": "2020-04-08T19:05:45+00:00",
    "Name": "my-http-api",
    "ProtocolType": "HTTP",
    "RouteSelectionExpression": "$request.method $request.path"
}

Para obter mais informações, consulte Developing an HTTP API in API Gateway no Amazon API Gateway Developer Guide.

Para criar um WebSocket API

O create-api exemplo a seguir cria um WebSocket API com o nome especificado.

aws apigatewayv2 create-api \
    --name "myWebSocketApi" \
    --protocol-type WEBSOCKET \
    --route-selection-expression '$request.body.action'

Saída:

{
    "ApiKeySelectionExpression": "$request.header.x-api-key",
    "Name": "myWebSocketApi",
    "CreatedDate": "2018-11-15T06:23:51Z",
    "ProtocolType": "WEBSOCKET",
    "RouteSelectionExpression": "'$request.body.action'",
    "ApiId": "aabbccddee"
}

Para obter mais informações, consulte Create a WebSocket API in API Gateway no Amazon API Gateway Developer Guide.

  • Para API obter detalhes, consulte CreateApina Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar create-authorizer.

AWS CLI

Para criar um JWT autorizador para um HTTP API

O create-authorizer exemplo a seguir cria um JWT autorizador que usa o Amazon Cognito como provedor de identidade.

aws apigatewayv2 create-authorizer \
    --name my-jwt-authorizer \
    --api-id a1b2c3d4 \
    --authorizer-type JWT \
    --identity-source '$request.header.Authorization' \
    --jwt-configuration Audience=123456abc,Issuer=https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc123

Saída:

{
    "AuthorizerId": "a1b2c3",
    "AuthorizerType": "JWT",
    "IdentitySource": [
        "$request.header.Authorization"
    ],
    "JwtConfiguration": {
        "Audience": [
            "123456abc"
        ],
        "Issuer": "https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc123"
    },
    "Name": "my-jwt-authorizer"
}

Para obter mais informações, consulte Controle do acesso HTTP APIs com JWT autorizadores no Amazon API Gateway Developer Guide.

  • Para API obter detalhes, consulte CreateAuthorizerna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar create-deployment.

AWS CLI

Para criar uma implantação para um API

O create-deployment exemplo a seguir cria uma implantação para um API e associa essa implantação ao dev estágio doAPI.

aws apigatewayv2 create-deployment \
    --api-id a1b2c3d4 \
    --stage-name dev

Saída:

{
    "AutoDeployed": false,
    "CreatedDate": "2020-04-06T23:38:08Z",
    "DeploymentId": "53lz9l",
    "DeploymentStatus": "DEPLOYED"
}

Para obter mais informações, consulte a APIimplantação no Amazon API Gateway Developer Guide.

  • Para API obter detalhes, consulte CreateDeploymentna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar create-domain-name.

AWS CLI

Para criar um nome de domínio personalizado

O create-domain-name exemplo a seguir cria um nome de domínio personalizado regional para umAPI.

aws apigatewayv2 create-domain-name \
    --domain-name regional.example.com \
    --domain-name-configurations CertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678

Saída:

{
    "ApiMappingSelectionExpression": "$request.basepath",
    "DomainName": "regional.example.com",
    "DomainNameConfigurations": [
        {
            "ApiGatewayDomainName": "d-id.execute-api.us-west-2.amazonaws.com",
            "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678",
            "EndpointType": "REGIONAL",
            "HostedZoneId": "123456789111",
            "SecurityPolicy": "TLS_1_2",
            "DomainNameStatus": "AVAILABLE"
        }
    ]
}

Para obter mais informações, consulte Configurando um nome de domínio regional personalizado no API Gateway no Amazon API Gateway Developer Guide.

  • Para API obter detalhes, consulte CreateDomainNamena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar create-integration.

AWS CLI

Para criar uma WebSocket API integração

O create-integration exemplo a seguir cria uma integração simulada para um WebSocket API.

aws apigatewayv2 create-integration \
    --api-id aabbccddee \
    --passthrough-behavior WHEN_NO_MATCH \
    --timeout-in-millis 29000 \
    --connection-type INTERNET \
    --integration-type MOCK

Saída:

{
    "ConnectionType": "INTERNET",
    "IntegrationId": "0abcdef",
    "IntegrationResponseSelectionExpression": "${integration.response.statuscode}",
    "IntegrationType": "MOCK",
    "PassthroughBehavior": "WHEN_NO_MATCH",
    "PayloadFormatVersion": "1.0",
    "TimeoutInMillis": 29000
}

Para obter mais informações, consulte Configurar uma solicitação de WebSocket API integração no API Gateway no Amazon API Gateway Developer Guide.

Para criar uma HTTP API integração

O create-integration exemplo a seguir cria uma integração AWS Lambda para um. HTTP API

aws apigatewayv2 create-integration \
    --api-id a1b2c3d4 \
    --integration-type AWS_PROXY \
    --integration-uri arn:aws:lambda:us-west-2:123456789012:function:my-function \
    --payload-format-version 2.0

Saída:

{
    "ConnectionType": "INTERNET",
    "IntegrationId": "0abcdef",
    "IntegrationMethod": "POST",
    "IntegrationType": "AWS_PROXY",
    "IntegrationUri": "arn:aws:lambda:us-west-2:123456789012:function:my-function",
    "PayloadFormatVersion": "2.0",
    "TimeoutInMillis": 30000
}

Para obter mais informações, consulte Como configurar integrações HTTP APIs no Amazon API Gateway Developer Guide.

  • Para API obter detalhes, consulte CreateIntegrationna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar create-route.

AWS CLI

Para criar uma rota $default para um ou WebSocket HTTP API

O create-route exemplo a seguir cria uma $default rota para um WebSocket ou HTTPAPI.

aws apigatewayv2 create-route \
    --api-id aabbccddee \
    --route-key '$default'

Saída:

{
    "ApiKeyRequired": false,
    "AuthorizationType": "NONE",
    "RouteKey": "$default",
    "RouteId": "1122334"
}

Para obter mais informações, consulte Como trabalhar com rotas WebSocket APIs no Guia do desenvolvedor do Amazon API Gateway

Para criar uma rota para um HTTP API

O create-route exemplo a seguir cria uma rota chamada signup que aceita POST solicitações.

aws apigatewayv2 create-route \
    --api-id aabbccddee \
    --route-key 'POST /signup'

Saída:

{
    "ApiKeyRequired": false,
    "AuthorizationType": "NONE",
    "RouteKey": "POST /signup",
    "RouteId": "1122334"
}

Para obter mais informações, consulte Como trabalhar com rotas HTTP APIs no Guia do desenvolvedor do Amazon API Gateway

  • Para API obter detalhes, consulte CreateRoutena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar create-stage.

AWS CLI

Para criar um palco

O create-stage exemplo a seguir cria um estágio chamado dev para umAPI.

aws apigatewayv2 create-stage \
    --api-id a1b2c3d4 \
    --stage-name dev

Saída:

{
    "CreatedDate": "2020-04-06T23:23:46Z",
    "DefaultRouteSettings": {
        "DetailedMetricsEnabled": false
    },
    "LastUpdatedDate": "2020-04-06T23:23:46Z",
    "RouteSettings": {},
    "StageName": "dev",
    "StageVariables": {},
    "Tags": {}
}

Para obter mais informações, consulte Como trabalhar com estágios HTTP APIs no Guia do desenvolvedor do Amazon API Gateway.

  • Para API obter detalhes, consulte CreateStagena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar create-vpc-link.

AWS CLI

Para criar um VPC link para um HTTP API

O create-vpc-link exemplo a seguir cria um VPC link para HTTPAPIs.

aws apigatewayv2 create-vpc-link \
    --name MyVpcLink \
    --subnet-ids subnet-aaaa subnet-bbbb \
    --security-group-ids sg1234 sg5678

Saída:

{
    "CreatedDate": "2020-04-07T00:11:46Z",
    "Name": "MyVpcLink",
    "SecurityGroupIds": [
        "sg1234",
        "sg5678"
    ],
    "SubnetIds": [
        "subnet-aaaa",
        "subnet-bbbb"
    ],
    "Tags": {},
    "VpcLinkId": "abcd123",
    "VpcLinkStatus": "PENDING",
    "VpcLinkStatusMessage": "VPC link is provisioning ENIs",
    "VpcLinkVersion": "V2"
}

Para obter mais informações, consulte Como trabalhar com VPC links HTTP APIs no Guia do desenvolvedor do Amazon API Gateway.

  • Para API obter detalhes, consulte CreateVpcLinkna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar delete-access-log-settings.

AWS CLI

Para desativar o registro de acesso para um API

O delete-access-log-settings exemplo a seguir exclui as configurações do registro de acesso para o $default estágio de umAPI. Para desativar o registro de acesso de um estágio, exclua suas configurações de registro de acesso.

aws apigatewayv2 delete-access-log-settings \
    --api-id a1b2c3d4 \
    --stage-name '$default'

Este comando não produz saída.

Para obter mais informações, consulte Como configurar o registro em log para um HTTP API no Amazon API Gateway Developer Guide.

O código de exemplo a seguir mostra como usar delete-api-mapping.

AWS CLI

Para excluir um API mapeamento

O delete-api-mapping exemplo a seguir exclui um API mapeamento para o nome de domínio api.example.com personalizado.

aws apigatewayv2 delete-api-mapping \
    --api-mapping-id a1b2c3 \
    --domain-name api.example.com

Este comando não produz saída.

Para obter mais informações, consulte Configurando um nome de domínio regional personalizado no API Gateway no Amazon API Gateway Developer Guide.

  • Para API obter detalhes, consulte DeleteApiMappingna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar delete-api.

AWS CLI

Para excluir um API

O delete-api exemplo a seguir exclui umAPI.

aws apigatewayv2 delete-api \
    --api-id a1b2c3d4

Este comando não produz saída.

Para obter mais informações, consulte Trabalhando com HTTP APIs e trabalhando com WebSocket APIs no Guia do desenvolvedor do Amazon API Gateway.

  • Para API obter detalhes, consulte DeleteApina Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar delete-authorizer.

AWS CLI

Para excluir um autorizador

O delete-authorizer exemplo a seguir exclui um autorizador.

aws apigatewayv2 delete-authorizer \
    --api-id a1b2c3d4 \
    --authorizer-id a1b2c3

Este comando não produz saída.

Para obter mais informações, consulte Controle do acesso HTTP APIs com JWT autorizadores no Amazon API Gateway Developer Guide.

  • Para API obter detalhes, consulte DeleteAuthorizerna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar delete-cors-configuration.

AWS CLI

Para excluir a CORS configuração de um HTTP API

O delete-cors-configuration exemplo a seguir CORS desabilita um HTTP API excluindo sua CORS configuração.

aws apigatewayv2 delete-cors-configuration \
    --api-id a1b2c3d4

Este comando não produz saída.

Para obter mais informações, consulte Como configurar CORS um HTTP API no Guia do desenvolvedor do Amazon API Gateway.

O código de exemplo a seguir mostra como usar delete-deployment.

AWS CLI

Para excluir uma implantação

O delete-deployment exemplo a seguir exclui a implantação de umAPI.

aws apigatewayv2 delete-deployment \
    --api-id a1b2c3d4 \
    --deployment-id a1b2c3

Este comando não produz saída.

Para obter mais informações, consulte a APIimplantação no Amazon API Gateway Developer Guide.

  • Para API obter detalhes, consulte DeleteDeploymentna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar delete-domain-name.

AWS CLI

Para excluir um nome de domínio personalizado

O delete-domain-name exemplo a seguir exclui um nome de domínio personalizado.

aws apigatewayv2 delete-domain-name \
    --domain-name api.example.com

Este comando não produz saída.

Para obter mais informações, consulte Configurando um nome de domínio regional personalizado no API Gateway no Amazon API Gateway Developer Guide.

  • Para API obter detalhes, consulte DeleteDomainNamena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar delete-integration.

AWS CLI

Para excluir uma integração

O delete-integration exemplo a seguir exclui uma API integração.

aws apigatewayv2 delete-integration \
    --api-id a1b2c3d4 \
    --integration-id a1b2c3

Este comando não produz saída.

Para obter mais informações, consulte Como configurar integrações HTTP APIs e Configurar integrações no Amazon API Gateway WebSocket API Developer Guide.

  • Para API obter detalhes, consulte DeleteIntegrationna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar delete-route-settings.

AWS CLI

Para excluir as configurações de rota

O delete-route-settings exemplo a seguir exclui as configurações de rota para a rota especificada.

aws apigatewayv2 delete-route-settings \
    --api-id a1b2c3d4 \
    --stage-name dev \
    --route-key 'GET /pets'

Este comando não produz saída.

Para obter mais informações, consulte Como trabalhar com rotas HTTP APIs no Guia do desenvolvedor do Amazon API Gateway.

O código de exemplo a seguir mostra como usar delete-route.

AWS CLI

Para excluir uma rota

O delete-route exemplo a seguir exclui uma API rota.

aws apigatewayv2 delete-route \
    --api-id a1b2c3d4 \
    --route-id a1b2c3

Este comando não produz saída.

Para obter mais informações, consulte Como trabalhar com rotas HTTP APIs no Guia do desenvolvedor do Amazon API Gateway.

  • Para API obter detalhes, consulte DeleteRoutena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar delete-stage.

AWS CLI

Para excluir um estágio

O delete-stage exemplo a seguir exclui o test estágio de umAPI.

aws apigatewayv2 delete-stage \
    --api-id a1b2c3d4 \
    --stage-name test

Este comando não produz saída.

Para obter mais informações, consulte Como trabalhar com estágios HTTP APIs no Guia do desenvolvedor do Amazon API Gateway.

  • Para API obter detalhes, consulte DeleteStagena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar delete-vpc-link.

AWS CLI

Para excluir um VPC link para um HTTP API

O delete-vpc-link exemplo a seguir exclui um VPC link.

aws apigatewayv2 delete-vpc-link \
    --vpc-link-id abcd123

Este comando não produz saída.

Para obter mais informações, consulte Como trabalhar com VPC links HTTP APIs no Guia do desenvolvedor do Amazon API Gateway.

  • Para API obter detalhes, consulte DeleteVpcLinkna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar export-api.

AWS CLI

Para exportar uma API definição aberta de um HTTP API

O export-api exemplo a seguir exporta uma definição do Open API 3.0 de um API estágio chamado prod para um YAML arquivo chamadostage-definition.yaml. O arquivo de definição exportado inclui extensões do API Gateway por padrão.

aws apigatewayv2 export-api \
    --api-id a1b2c3d4 \
    --output-type YAML \
    --specification OAS30 \
    --stage-name prod \
    stage-definition.yaml

Este comando não produz saída.

Para obter mais informações, consulte Exportando um HTTP API do API Gateway no Guia do desenvolvedor do Amazon API Gateway.

  • Para API obter detalhes, consulte ExportApina Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-api-mapping.

AWS CLI

Para obter informações sobre um API mapeamento para um nome de domínio personalizado

O get-api-mapping exemplo a seguir exibe informações sobre um API mapeamento para o nome de domínio api.example.com personalizado.

aws apigatewayv2 get-api-mapping \
    --api-mapping-id a1b2c3 \
    --domain-name api.example.com

Saída:

{
    "ApiId": "a1b2c3d4",
    "ApiMappingId": "a1b2c3d5",
    "ApiMappingKey": "myTestApi"
    "Stage": "test"
}

Para obter mais informações, consulte Configurando um nome de domínio regional personalizado no API Gateway no Amazon API Gateway Developer Guide.

  • Para API obter detalhes, consulte GetApiMappingna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-api-mappings.

AWS CLI

Para obter API mapeamentos para um nome de domínio personalizado

O get-api-mappings exemplo a seguir exibe uma lista de todos os API mapeamentos para o nome de domínio api.example.com personalizado.

aws apigatewayv2 get-api-mappings \
    --domain-name api.example.com

Saída:

{
    "Items": [
        {
            "ApiId": "a1b2c3d4",
            "ApiMappingId": "a1b2c3d5",
            "ApiMappingKey": "myTestApi"
            "Stage": "test"
        },
        {
            "ApiId": "a5b6c7d8",
            "ApiMappingId": "a1b2c3d6",
            "ApiMappingKey": "myDevApi"
            "Stage": "dev"
        },
    ]
}

Para obter mais informações, consulte Configurando um nome de domínio regional personalizado no API Gateway no Amazon API Gateway Developer Guide.

  • Para API obter detalhes, consulte GetApiMappingsna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-api.

AWS CLI

Para recuperar informações sobre um API

O get-api exemplo a seguir exibe informações sobre umAPI.

aws apigatewayv2 get-api \
    --api-id a1b2c3d4

Saída:

{
    "ApiEndpoint": "https://a1b2c3d4.execute-api.us-west-2.amazonaws.com",
    "ApiId": "a1b2c3d4",
    "ApiKeySelectionExpression": "$request.header.x-api-key",
    "CreatedDate": "2020-03-28T00:32:37Z",
    "Name": "my-api",
    "ProtocolType": "HTTP",
    "RouteSelectionExpression": "$request.method $request.path",
    "Tags": {
        "department": "finance"
    }
}

  • Para API obter detalhes, consulte GetApina Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-apis.

AWS CLI

Para recuperar uma lista de APIs

O get-apis exemplo a seguir lista todos APIs os do usuário atual.

aws apigatewayv2 get-apis

Saída:

{
    "Items": [
        {
            "ApiEndpoint": "wss://a1b2c3d4.execute-api.us-west-2.amazonaws.com",
            "ApiId": "a1b2c3d4",
            "ApiKeySelectionExpression": "$request.header.x-api-key",
            "CreatedDate": "2020-04-07T20:21:59Z",
            "Name": "my-websocket-api",
            "ProtocolType": "WEBSOCKET",
            "RouteSelectionExpression": "$request.body.message",
            "Tags": {}
        },
        {
            "ApiEndpoint": "https://a1b2c3d5.execute-api.us-west-2.amazonaws.com",
            "ApiId": "a1b2c3d5",
            "ApiKeySelectionExpression": "$request.header.x-api-key",
            "CreatedDate": "2020-04-07T20:23:50Z",
            "Name": "my-http-api",
            "ProtocolType": "HTTP",
            "RouteSelectionExpression": "$request.method $request.path",
            "Tags": {}
        }
    ]
}

Para obter mais informações, consulte Trabalhando com HTTP APIs e trabalhando com WebSocket APIs no Guia do desenvolvedor do Amazon API Gateway.

  • Para API obter detalhes, consulte GetApisna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-authorizer.

AWS CLI

Para recuperar informações sobre um autorizador

O get-authorizer exemplo a seguir exibe informações sobre um autorizador.

aws apigatewayv2 get-authorizer \
    --api-id a1b2c3d4 \
    --authorizer-id a1b2c3

Saída:

{
    "AuthorizerId": "a1b2c3",
    "AuthorizerType": "JWT",
    "IdentitySource": [
        "$request.header.Authorization"
    ],
    "JwtConfiguration": {
        "Audience": [
            "123456abc"
        ],
        "Issuer": "https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc123"
    },
    "Name": "my-jwt-authorizer"
}

Para obter mais informações, consulte Controle do acesso HTTP APIs com JWT autorizadores no Amazon API Gateway Developer Guide.

  • Para API obter detalhes, consulte GetAuthorizerna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-authorizers.

AWS CLI

Para recuperar uma lista de autorizadores para um API

O get-authorizers exemplo a seguir exibe uma lista de todos os autorizadores de umAPI.

aws apigatewayv2 get-authorizers \
    --api-id a1b2c3d4

Saída:

{
    "Items": [
        {
            "AuthorizerId": "a1b2c3",
            "AuthorizerType": "JWT",
            "IdentitySource": [
                "$request.header.Authorization"
            ],
            "JwtConfiguration": {
                "Audience": [
                    "123456abc"
                ],
                "Issuer": "https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc123"
            },
            "Name": "my-jwt-authorizer"
        },
        {
            "AuthorizerId": "a1b2c4",
            "AuthorizerType": "JWT",
            "IdentitySource": [
                "$request.header.Authorization"
            ],
            "JwtConfiguration": {
                "Audience": [
                    "6789abcde"
                ],
                "Issuer": "https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc234"
            },
            "Name": "new-jwt-authorizer"
        }
    ]
}

Para obter mais informações, consulte Controle do acesso HTTP APIs com JWT autorizadores no Amazon API Gateway Developer Guide.

  • Para API obter detalhes, consulte GetAuthorizersna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-deployment.

AWS CLI

Para recuperar informações sobre uma implantação

O get-deployment exemplo a seguir exibe informações sobre uma implantação.

aws apigatewayv2 get-deployment \
    --api-id a1b2c3d4 \
    --deployment-id abcdef

Saída:

{
    "AutoDeployed": true,
    "CreatedDate": "2020-04-07T23:58:40Z",
    "DeploymentId": "abcdef",
    "DeploymentStatus": "DEPLOYED",
    "Description": "Automatic deployment triggered by changes to the Api configuration"
}

Para obter mais informações, consulte a APIimplantação no Amazon API Gateway Developer Guide.

  • Para API obter detalhes, consulte GetDeploymentna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-deployments.

AWS CLI

Para recuperar uma lista de implantações

O get-deployments exemplo a seguir exibe uma lista de todas as implantações API de um.

aws apigatewayv2 get-deployments \
    --api-id a1b2c3d4

Saída:

{
    "Items": [
        {
            "AutoDeployed": true,
            "CreatedDate": "2020-04-07T23:58:40Z",
            "DeploymentId": "abcdef",
            "DeploymentStatus": "DEPLOYED",
            "Description": "Automatic deployment triggered by changes to the Api configuration"
        },
        {
            "AutoDeployed": true,
            "CreatedDate": "2020-04-06T00:33:00Z",
            "DeploymentId": "bcdefg",
            "DeploymentStatus": "DEPLOYED",
            "Description": "Automatic deployment triggered by changes to the Api configuration"
        }
    ]
}

Para obter mais informações, consulte a APIimplantação no Amazon API Gateway Developer Guide.

  • Para API obter detalhes, consulte GetDeploymentsna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-domain-name.

AWS CLI

Para recuperar informações sobre um nome de domínio personalizado

O get-domain-name exemplo a seguir exibe informações sobre um nome de domínio personalizado.

aws apigatewayv2 get-domain-name \
    --domain-name api.example.com

Saída:

{
    "ApiMappingSelectionExpression": "$request.basepath",
    "DomainName": "api.example.com",
    "DomainNameConfigurations": [
        {
            "ApiGatewayDomainName": "d-1234.execute-api.us-west-2.amazonaws.com",
            "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678",
            "EndpointType": "REGIONAL",
            "HostedZoneId": "123456789111",
            "SecurityPolicy": "TLS_1_2",
            "DomainNameStatus": "AVAILABLE"
        }
    ],
    "Tags": {}
}

Para obter mais informações, consulte Configurando um nome de domínio regional personalizado no API Gateway no Amazon API Gateway Developer Guide.

  • Para API obter detalhes, consulte GetDomainNamena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-domain-names.

AWS CLI

Para recuperar uma lista de nomes de domínio personalizados

O get-domain-names exemplo a seguir exibe uma lista de todos os nomes de domínio personalizados para o usuário atual.

aws apigatewayv2 get-domain-names

Saída:

{
    "Items": [
        {
            "ApiMappingSelectionExpression": "$request.basepath",
            "DomainName": "api.example.com",
            "DomainNameConfigurations": [
                {
                    "ApiGatewayDomainName": "d-1234.execute-api.us-west-2.amazonaws.com",
                    "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678",
                    "EndpointType": "REGIONAL",
                    "HostedZoneId": "123456789111",
                    "SecurityPolicy": "TLS_1_2",
                    "DomainNameStatus": "AVAILABLE"
                }
            ]
        },
        {
            "ApiMappingSelectionExpression": "$request.basepath",
            "DomainName": "newApi.example.com",
            "DomainNameConfigurations": [
                {
                    "ApiGatewayDomainName": "d-5678.execute-api.us-west-2.amazonaws.com",
                    "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678",
                    "EndpointType": "REGIONAL",
                    "HostedZoneId": "123456789222",
                    "SecurityPolicy": "TLS_1_2",
                    "DomainNameStatus": "AVAILABLE"
                }
            ]
        }
    ]
}

Para obter mais informações, consulte Configurando um nome de domínio regional personalizado no API Gateway no Amazon API Gateway Developer Guide.

  • Para API obter detalhes, consulte GetDomainNamesna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-integration.

AWS CLI

Para recuperar informações sobre uma integração

O get-integration exemplo a seguir exibe informações sobre uma integração.

aws apigatewayv2 get-integration \
    --api-id a1b2c3d4 \
    --integration-id a1b2c3

Saída:

{
    "ApiGatewayManaged": true,
    "ConnectionType": "INTERNET",
    "IntegrationId": "a1b2c3",
    "IntegrationMethod": "POST",
    "IntegrationType": "AWS_PROXY",
    "IntegrationUri": "arn:aws:lambda:us-west-2:12356789012:function:hello12",
    "PayloadFormatVersion": "2.0",
    "TimeoutInMillis": 30000
}

Para obter mais informações, consulte Como configurar integrações HTTP APIs e Configurar integrações no Amazon API Gateway WebSocket API Developer Guide.

  • Para API obter detalhes, consulte GetIntegrationna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-integrations.

AWS CLI

Para recuperar uma lista de integrações

O get-integrations exemplo a seguir exibe uma lista de todas as integrações API de um.

aws apigatewayv2 get-integrations \
    --api-id a1b2c3d4

Saída:

{
    "Items": [
        {
            "ApiGatewayManaged": true,
            "ConnectionType": "INTERNET",
            "IntegrationId": "a1b2c3",
            "IntegrationMethod": "POST",
            "IntegrationType": "AWS_PROXY",
            "IntegrationUri": "arn:aws:lambda:us-west-2:123456789012:function:my-function",
            "PayloadFormatVersion": "2.0",
            "TimeoutInMillis": 30000
        },
        {
            "ConnectionType": "INTERNET",
            "IntegrationId": "a1b2c4",
            "IntegrationMethod": "ANY",
            "IntegrationType": "HTTP_PROXY",
            "IntegrationUri": "https://www.example.com",
            "PayloadFormatVersion": "1.0",
            "TimeoutInMillis": 30000
        }
    ]
}

Para obter mais informações, consulte Como configurar integrações HTTP APIs e Configurar integrações no Amazon API Gateway WebSocket API Developer Guide.

  • Para API obter detalhes, consulte GetIntegrationsna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-route.

AWS CLI

Para recuperar informações sobre uma rota

O get-route exemplo a seguir exibe informações sobre uma rota.

aws apigatewayv2 get-route \
    --api-id a1b2c3d4 \
    --route-id 72jz1wk

Saída:

{
    "ApiKeyRequired": false,
    "AuthorizationType": "NONE",
    "RouteId": "72jz1wk",
    "RouteKey": "ANY /pets",
    "Target": "integrations/a1b2c3"
}

Para obter mais informações, consulte Como trabalhar com rotas HTTP APIs no Guia do desenvolvedor do Amazon API Gateway

  • Para API obter detalhes, consulte GetRoutena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-routes.

AWS CLI

Para recuperar uma lista de rotas

O get-routes exemplo a seguir exibe uma lista de todas as rotas API de um.

aws apigatewayv2 get-routes \
    --api-id a1b2c3d4

Saída:

{
    "Items": [
        {
            "ApiKeyRequired": false,
            "AuthorizationType": "NONE",
            "RouteId": "72jz1wk",
            "RouteKey": "ANY /admin",
            "Target": "integrations/a1b2c3"
        },
        {
            "ApiGatewayManaged": true,
            "ApiKeyRequired": false,
            "AuthorizationType": "NONE",
            "RouteId": "go65gqi",
            "RouteKey": "$default",
            "Target": "integrations/a1b2c4"
        }
    ]
}

Para obter mais informações, consulte Como trabalhar com rotas HTTP APIs no Guia do desenvolvedor do Amazon API Gateway

  • Para API obter detalhes, consulte GetRoutesna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-stage.

AWS CLI

Para recuperar informações sobre um estágio

O get-stage exemplo a seguir exibe informações sobre o prod estágio de umAPI.

aws apigatewayv2 get-stage \
    --api-id a1b2c3d4 \
    --stage-name prod

Saída:

{
    "CreatedDate": "2020-04-08T00:36:05Z",
    "DefaultRouteSettings": {
        "DetailedMetricsEnabled": false
    },
    "DeploymentId": "x1zwyv",
    "LastUpdatedDate": "2020-04-08T00:36:13Z",
    "RouteSettings": {},
    "StageName": "prod",
    "StageVariables": {
        "function": "my-prod-function"
    },
    "Tags": {}
}

Para obter mais informações, consulte Como trabalhar com estágios HTTP APIs no Guia do desenvolvedor do Amazon API Gateway.

  • Para API obter detalhes, consulte GetStagena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-stages.

AWS CLI

Para recuperar uma lista de estágios

O get-stages exemplo a seguir lista todos os estágios API de um.

aws apigatewayv2 get-stages \
    --api-id a1b2c3d4

Saída:

{
    "Items": [
        {
            "ApiGatewayManaged": true,
            "AutoDeploy": true,
            "CreatedDate": "2020-04-08T00:08:44Z",
            "DefaultRouteSettings": {
                "DetailedMetricsEnabled": false
            },
            "DeploymentId": "dty748",
            "LastDeploymentStatusMessage": "Successfully deployed stage with deployment ID 'dty748'",
            "LastUpdatedDate": "2020-04-08T00:09:49Z",
            "RouteSettings": {},
            "StageName": "$default",
            "StageVariables": {},
            "Tags": {}
        },
        {
            "AutoDeploy": true,
            "CreatedDate": "2020-04-08T00:35:06Z",
            "DefaultRouteSettings": {
                "DetailedMetricsEnabled": false
            },
            "LastUpdatedDate": "2020-04-08T00:35:48Z",
            "RouteSettings": {},
            "StageName": "dev",
            "StageVariables": {
                "function": "my-dev-function"
            },
            "Tags": {}
        },
        {
            "CreatedDate": "2020-04-08T00:36:05Z",
            "DefaultRouteSettings": {
                "DetailedMetricsEnabled": false
            },
            "DeploymentId": "x1zwyv",
            "LastUpdatedDate": "2020-04-08T00:36:13Z",
            "RouteSettings": {},
            "StageName": "prod",
            "StageVariables": {
                "function": "my-prod-function"
            },
            "Tags": {}
        }
    ]
}

Para obter mais informações, consulte Como trabalhar com estágios HTTP APIs no Guia do desenvolvedor do Amazon API Gateway.

  • Para API obter detalhes, consulte GetStagesna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-tags.

AWS CLI

Para recuperar uma lista de tags para um recurso

O get-tags exemplo a seguir lista todas as tags API de um.

aws apigatewayv2 get-tags \
    --resource-arn arn:aws:apigateway:us-west-2::/apis/a1b2c3d4

Saída:

{
    "Tags": {
        "owner": "dev-team",
        "environment": "prod"
    }
}

Para obter mais informações, consulte Como marcar seus recursos do API Gateway no Guia do desenvolvedor do Amazon API Gateway.

  • Para API obter detalhes, consulte GetTagsna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-vpc-link.

AWS CLI

Para recuperar informações sobre um link VPC

O get-vpc-link exemplo a seguir exibe informações sobre um VPC link.

aws apigatewayv2 get-vpc-link \
    --vpc-link-id abcd123

Saída:

{
    "CreatedDate": "2020-04-07T00:27:47Z",
    "Name": "MyVpcLink",
    "SecurityGroupIds": [
        "sg1234",
        "sg5678"
    ],
    "SubnetIds": [
        "subnet-aaaa",
        "subnet-bbbb"
    ],
    "Tags": {},
    "VpcLinkId": "abcd123",
    "VpcLinkStatus": "AVAILABLE",
    "VpcLinkStatusMessage": "VPC link is ready to route traffic",
    "VpcLinkVersion": "V2"
}

Para obter mais informações, consulte Como trabalhar com VPC links HTTP APIs no Guia do desenvolvedor do Amazon API Gateway.

  • Para API obter detalhes, consulte GetVpcLinkna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-vpc-links.

AWS CLI

Para recuperar uma lista de links VPC

O get-vpc-links exemplo a seguir exibe uma lista de todos os VPC links do usuário atual.

aws apigatewayv2 get-vpc-links

Saída:

{
    "Items": [
        {
            "CreatedDate": "2020-04-07T00:27:47Z",
            "Name": "MyVpcLink",
            "SecurityGroupIds": [
                "sg1234",
                "sg5678"
            ],
            "SubnetIds": [
                "subnet-aaaa",
                "subnet-bbbb"
            ],
            "Tags": {},
            "VpcLinkId": "abcd123",
            "VpcLinkStatus": "AVAILABLE",
            "VpcLinkStatusMessage": "VPC link is ready to route traffic",
            "VpcLinkVersion": "V2"
        }
        {
            "CreatedDate": "2020-04-07T00:27:47Z",
            "Name": "MyOtherVpcLink",
            "SecurityGroupIds": [
                "sg1234",
                "sg5678"
            ],
            "SubnetIds": [
                "subnet-aaaa",
                "subnet-bbbb"
            ],
            "Tags": {},
            "VpcLinkId": "abcd456",
            "VpcLinkStatus": "AVAILABLE",
            "VpcLinkStatusMessage": "VPC link is ready to route traffic",
            "VpcLinkVersion": "V2"
        }
    ]
}

Para obter mais informações, consulte Como trabalhar com VPC links HTTP APIs no Guia do desenvolvedor do Amazon API Gateway.

  • Para API obter detalhes, consulte GetVpcLinksna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar import-api.

AWS CLI

Para importar um HTTP API

O import-api exemplo a seguir cria um HTTP API a partir de um arquivo de definição do Open API 3.0 chamadoapi-definition.yaml.

aws apigatewayv2 import-api \
    --body file://api-definition.yaml

Conteúdo de api-definition.yaml:

openapi: 3.0.1
info:
    title: My Lambda API
    version: v1.0
paths:
    /hello:
        x-amazon-apigateway-any-method:
            x-amazon-apigateway-integration:
                payloadFormatVersion: 2.0
                type: aws_proxy
                httpMethod: POST
                uri: arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:hello/invocations
                connectionType: INTERNET

Saída:

{
    "ApiEndpoint": "https://a1b2c3d4.execute-api.us-west-2.amazonaws.com",
    "ApiId": "a1b2c3d4",
    "ApiKeySelectionExpression": "$request.header.x-api-key",
    "CreatedDate": "2020-04-08T17:19:38+00:00",
    "Name": "My Lambda API",
    "ProtocolType": "HTTP",
    "RouteSelectionExpression": "$request.method $request.path",
    "Tags": {},
    "Version": "v1.0"
}

Para obter mais informações, consulte Como trabalhar com API definições abertas HTTP APIs no Guia do desenvolvedor do Amazon API Gateway.

  • Para API obter detalhes, consulte ImportApina Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar reimport-api.

AWS CLI

Para reimportar um HTTP API

O reimport-api exemplo a seguir atualiza uma existente HTTP API para usar a definição Open API 3.0 especificada emapi-definition.yaml.

aws apigatewayv2 reimport-api \
    --body file://api-definition.yaml \
    --api-id a1b2c3d4

Conteúdo de api-definition.yaml:

openapi: 3.0.1
info:
    title: My Lambda API
    version: v1.0
paths:
    /hello:
        x-amazon-apigateway-any-method:
            x-amazon-apigateway-integration:
                payloadFormatVersion: 2.0
                type: aws_proxy
                httpMethod: POST
                uri: arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:12356789012:function:hello/invocations
                connectionType: INTERNET

Saída:

{
    "ApiEndpoint": "https://a1b2c3d4.execute-api.us-west-2.amazonaws.com",
    "ApiId": "a1b2c3d4",
    "ApiKeySelectionExpression": "$request.header.x-api-key",
    "CreatedDate": "2020-04-08T17:19:38+00:00",
    "Name": "My Lambda API",
    "ProtocolType": "HTTP",
    "RouteSelectionExpression": "$request.method $request.path",
    "Tags": {},
    "Version": "v1.0"
}

Para obter mais informações, consulte Como trabalhar com API definições abertas HTTP APIs no Guia do desenvolvedor do Amazon API Gateway.

  • Para API obter detalhes, consulte ReimportApina Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar tag-resource.

AWS CLI

Para marcar um recurso

O tag-resource exemplo a seguir adiciona uma tag com o nome da chave Department e um valor de Accounting ao especificadoAPI.

aws apigatewayv2 tag-resource \
    --resource-arn arn:aws:apigateway:us-west-2::/apis/a1b2c3d4 \
    --tags Department=Accounting

Este comando não produz saída.

Para obter mais informações, consulte Como marcar seus recursos do API Gateway no Guia do desenvolvedor do Amazon API Gateway.

  • Para API obter detalhes, consulte TagResourcena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar untag-resource.

AWS CLI

Como remover as tags de um recurso

O untag-resource exemplo a seguir remove as tags com os nomes de chave Project e Owner do especificadoAPI.

aws apigatewayv2 untag-resource \
    --resource-arn arn:aws:apigateway:us-west-2::/apis/a1b2c3d4 \
    --tag-keys Project Owner

Este comando não produz saída.

Para obter mais informações, consulte Como marcar seus recursos do API Gateway no Guia do desenvolvedor do Amazon API Gateway.

  • Para API obter detalhes, consulte UntagResourcena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar update-api-mapping.

AWS CLI

Para atualizar um API mapeamento

O update-api-mapping exemplo a seguir altera um API mapeamento para um nome de domínio personalizado. Como resultado, a base URL usando o nome de domínio personalizado para o estágio especificado API se tornahttps://api.example.com/dev.

aws apigatewayv2 update-api-mapping \
    --api-id a1b2c3d4 \
    --stage dev \
    --domain-name api.example.com \
    --api-mapping-id 0qzs2sy7bh \
    --api-mapping-key dev

Saída:

{
    "ApiId": "a1b2c3d4",
    "ApiMappingId": "0qzs2sy7bh",
    "ApiMappingKey": "dev"
    "Stage": "dev"
}

Para obter mais informações, consulte Configurando um nome de domínio regional personalizado no API Gateway no Amazon API Gateway Developer Guide.

  • Para API obter detalhes, consulte UpdateApiMappingna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar update-api.

AWS CLI

Para CORS habilitar um HTTP API

O update-api exemplo a seguir atualiza a CORS configuração API do especificado para permitir solicitações dehttps://www.example.com.

aws apigatewayv2 update-api \
    --api-id a1b2c3d4 \
    --cors-configuration AllowOrigins=https://www.example.com

Saída:

{
    "ApiEndpoint": "https://a1b2c3d4.execute-api.us-west-2.amazonaws.com",
    "ApiId": "a1b2c3d4",
    "ApiKeySelectionExpression": "$request.header.x-api-key",
    "CorsConfiguration": {
        "AllowCredentials": false,
        "AllowHeaders": [
            "header1",
            "header2"
        ],
        "AllowMethods": [
            "GET",
            "OPTIONS"
        ],
        "AllowOrigins": [
            "https://www.example.com"
        ]
    },
    "CreatedDate": "2020-04-08T18:39:37+00:00",
    "Name": "my-http-api",
    "ProtocolType": "HTTP",
    "RouteSelectionExpression": "$request.method $request.path",
    "Tags": {},
    "Version": "v1.0"
}

Para obter mais informações, consulte Como configurar CORS um HTTP API no Guia do desenvolvedor do Amazon API Gateway.

  • Para API obter detalhes, consulte UpdateApina Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar update-authorizer.

AWS CLI

Para atualizar um autorizador

O update-authorizer exemplo a seguir altera a fonte de identidade de um JWT autorizador para um cabeçalho chamadoAuthorization.

aws apigatewayv2 update-authorizer \
    --api-id a1b2c3d4 \
    --authorizer-id a1b2c3 \
    --identity-source '$request.header.Authorization'

Saída:

{
    "AuthorizerId": "a1b2c3",
    "AuthorizerType": "JWT",
    "IdentitySource": [
        "$request.header.Authorization"
    ],
    "JwtConfiguration": {
        "Audience": [
            "123456abc"
        ],
        "Issuer": "https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc123"
    },
    "Name": "my-jwt-authorizer"
}

Para obter mais informações, consulte Controle do acesso HTTP APIs com JWT autorizadores no Amazon API Gateway Developer Guide.

  • Para API obter detalhes, consulte UpdateAuthorizerna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar update-deployment.

AWS CLI

Para alterar a descrição de uma implantação

O update-deployment exemplo a seguir atualiza a descrição de uma implantação.

aws apigatewayv2 update-deployment \
    --api-id a1b2c3d4 \
    --deployment-id abcdef \
    --description 'Manual deployment to fix integration test failures.'

Saída:

{
    "AutoDeployed": false,
    "CreatedDate": "2020-02-05T16:21:48+00:00",
    "DeploymentId": "abcdef",
    "DeploymentStatus": "DEPLOYED",
    "Description": "Manual deployment to fix integration test failures."
}

Para obter mais informações, consulte Developing an HTTP API in API Gateway no Amazon API Gateway Developer Guide.

  • Para API obter detalhes, consulte UpdateDeploymentna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar update-domain-name.

AWS CLI

Para atualizar um nome de domínio personalizado

O update-domain-name exemplo a seguir especifica um novo ACM certificado para o nome de domínio api.example.com personalizado.

aws apigatewayv2 update-domain-name \
    --domain-name api.example.com \
    --domain-name-configurations CertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678

Saída:

{
    "ApiMappingSelectionExpression": "$request.basepath",
    "DomainName": "regional.example.com",
    "DomainNameConfigurations": [
        {
            "ApiGatewayDomainName": "d-id.execute-api.us-west-2.amazonaws.com",
            "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678",
            "EndpointType": "REGIONAL",
            "HostedZoneId": "123456789111",
            "SecurityPolicy": "TLS_1_2",
            "DomainNameStatus": "AVAILABLE"
        }
    ]
}

Para obter mais informações, consulte Configurando um nome de domínio regional personalizado no API Gateway no Amazon API Gateway Developer Guide.

  • Para API obter detalhes, consulte UpdateDomainNamena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar update-integration.

AWS CLI

Para atualizar uma integração com o Lambda

O update-integration exemplo a seguir atualiza uma integração existente do AWS Lambda para usar a função Lambda especificada.

aws apigatewayv2 update-integration \
    --api-id a1b2c3d4 \
    --integration-id a1b2c3 \
    --integration-uri arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:my-new-function/invocations

Saída:

{
    "ConnectionType": "INTERNET",
    "IntegrationId": "a1b2c3",
    "IntegrationMethod": "POST",
    "IntegrationType": "AWS_PROXY",
    "IntegrationUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:my-new-function/invocations",
    "PayloadFormatVersion": "2.0",
    "TimeoutInMillis": 5000
}

Para obter mais informações, consulte Como configurar integrações HTTP APIs e Configurar integrações no Amazon API Gateway WebSocket API Developer Guide.

  • Para API obter detalhes, consulte UpdateIntegrationna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar update-route.

AWS CLI

Exemplo 1: Para atualizar a integração de uma rota

O update-route exemplo a seguir atualiza a integração de uma rota especificada.

aws apigatewayv2 update-route \
    --api-id a1b2c3d4 \
    --route-id a1b2c3 \
    --target integrations/a1b2c6

Saída:

{
    "ApiKeyRequired": false,
    "AuthorizationType": "NONE",
    "RouteId": "a1b2c3",
    "RouteKey": "ANY /pets",
    "Target": "integrations/a1b2c6"
}

Exemplo 2: Para adicionar um autorizador a uma rota

O update-route exemplo a seguir atualiza a rota especificada para usar um JWT autorizador.

aws apigatewayv2 update-route \
    --api-id a1b2c3d4  \
    --route-id a1b2c3  \
    --authorization-type JWT \
    --authorizer-id a1b2c5 \
    --authorization-scopes user.id user.email

Saída:

{
    "ApiKeyRequired": false,
    "AuthorizationScopes": [
        "user.id",
        "user.email"
    ],
    "AuthorizationType": "JWT",
    "AuthorizerId": "a1b2c5",
    "OperationName": "GET HTTP",
    "RequestParameters": {},
    "RouteId": "a1b2c3",
    "RouteKey": "GET /pets",
    "Target": "integrations/a1b2c6"
}

Para obter mais informações, consulte Controle do acesso HTTP APIs com JWT autorizadores no Amazon API Gateway Developer Guide.

  • Para API obter detalhes, consulte UpdateRoutena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar update-stage.

AWS CLI

Para configurar a limitação personalizada

O update-stage exemplo a seguir configura a limitação personalizada para o estágio e a rota especificados de um. API

aws apigatewayv2 update-stage \
    --api-id a1b2c3d4 \
    --stage-name dev \
    --route-settings '{"GET /pets":{"ThrottlingBurstLimit":100,"ThrottlingRateLimit":2000}}'

Saída:

{
    "CreatedDate": "2020-04-05T16:21:16+00:00",
    "DefaultRouteSettings": {
        "DetailedMetricsEnabled": false
    },
    "DeploymentId": "shktxb",
    "LastUpdatedDate": "2020-04-08T22:23:17+00:00",
    "RouteSettings": {
        "GET /pets": {
            "ThrottlingBurstLimit": 100,
            "ThrottlingRateLimit": 2000.0
        }
    },
    "StageName": "dev",
    "StageVariables": {},
    "Tags": {}
}

Para obter mais informações, consulte Protegendo seu HTTP API no Guia do desenvolvedor do Amazon API Gateway.

  • Para API obter detalhes, consulte UpdateStagena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar update-vpc-link.

AWS CLI

Para atualizar um VPC link

O update-vpc-link exemplo a seguir atualiza o nome de um VPC link. Depois de criar um VPC link, você não poderá alterar seus grupos de segurança ou sub-redes.

aws apigatewayv2 update-vpc-link \
    --vpc-link-id abcd123 \
    --name MyUpdatedVpcLink

Saída:

{
    "CreatedDate": "2020-04-07T00:27:47Z",
    "Name": "MyUpdatedVpcLink",
    "SecurityGroupIds": [
        "sg1234",
        "sg5678"
    ],
    "SubnetIds": [
        "subnet-aaaa",
        "subnet-bbbb"
    ],
    "Tags": {},
    "VpcLinkId": "abcd123",
    "VpcLinkStatus": "AVAILABLE",
    "VpcLinkStatusMessage": "VPC link is ready to route traffic",
    "VpcLinkVersion": "V2"
}

Para obter mais informações, consulte Como trabalhar com VPC links HTTP APIs no Guia do desenvolvedor do Amazon API Gateway.

  • Para API obter detalhes, consulte UpdateVpcLinkna Referência de AWS CLI Comandos.