APIExemplos de gateway 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á.

APIExemplos de gateway 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.

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

AWS CLI

Para criar uma API chave que esteja habilitada para um Palco existente API

Comando:

aws apigateway create-api-key --name 'Dev API Key' --description 'Used for development' --enabled --stage-keys restApiId='a1b2c3d4e5',stageName='dev'

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

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

AWS CLI

Exemplo 1: Para criar um API Gateway Custom Authorizer baseado em token para o API

O create-authorizer exemplo a seguir cria um autorizador baseado em token.

aws apigateway create-authorizer \
    --rest-api-id 1234123412 \
    --name 'First_Token_Custom_Authorizer' \
    --type TOKEN \
    --authorizer-uri 'arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:customAuthFunction/invocations' \
    --identity-source 'method.request.header.Authorization' \
    --authorizer-result-ttl-in-seconds 300

Saída:

{
    "authType": "custom",
    "name": "First_Token_Custom_Authorizer",
    "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:customAuthFunction/invocations",
    "authorizerResultTtlInSeconds": 300,
    "identitySource": "method.request.header.Authorization",
    "type": "TOKEN",
    "id": "z40xj0"
}

Exemplo 2: Para criar um Autorizador Personalizado de API Gateway baseado em Grupos de Usuários do Cognito para o API

O create-authorizer exemplo a seguir cria um Autorizador Personalizado de API Gateway baseado em Grupos de Usuários do Cognito.

aws apigateway create-authorizer \
    --rest-api-id 1234123412 \
    --name 'First_Cognito_Custom_Authorizer' \
    --type COGNITO_USER_POOLS \
    --provider-arns 'arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_aWcZeQbuD' \
    --identity-source 'method.request.header.Authorization'

Saída:

{
    "authType": "cognito_user_pools",
    "identitySource": "method.request.header.Authorization",
    "name": "First_Cognito_Custom_Authorizer",
    "providerARNs": [
        "arn:aws:cognito-idp:us-east-1:342398297714:userpool/us-east-1_qWbZzQhzE"
    ],
    "type": "COGNITO_USER_POOLS",
    "id": "5yid1t"
}

Exemplo 3: Para criar um API Gateway Custom Authorizer baseado em solicitações para o API

O create-authorizer exemplo a seguir cria um autorizador baseado em solicitações.

aws apigateway create-authorizer \
    --rest-api-id 1234123412 \
    --name 'First_Request_Custom_Authorizer' \
    --type REQUEST \
    --authorizer-uri 'arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:customAuthFunction/invocations' \
    --identity-source 'method.request.header.Authorization,context.accountId' \
    --authorizer-result-ttl-in-seconds 300

Saída:

{
    "id": "z40xj0",
    "name": "First_Request_Custom_Authorizer",
    "type": "REQUEST",
    "authType": "custom",
    "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:customAuthFunction/invocations",
    "identitySource": "method.request.header.Authorization,context.accountId",
    "authorizerResultTtlInSeconds": 300
}

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

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

AWS CLI

Para criar o mapeamento do caminho base para um nome de domínio personalizado

Comando:

aws apigateway create-base-path-mapping --domain-name subdomain.domain.tld --rest-api-id 1234123412 --stage prod --base-path v1

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

AWS CLI

Para implantar os recursos configurados API para um novo estágio

Comando:

aws apigateway create-deployment --rest-api-id 1234123412 --stage-name dev --stage-description 'Development Stage' --description 'First deployment to the dev stage'

Para implantar os recursos configurados API para um estágio existente

Comando:

aws apigateway create-deployment --rest-api-id 1234123412 --stage-name dev --description 'Second deployment to the dev stage'

Para implantar os recursos configurados API para um estágio existente com variáveis de estágio

aws apigateway create-deployment -- rest-api-id 1234123412 --stage-name dev --description 'Terceira implantação no estágio de desenvolvimento' --variables key='value', =' 'otherKeyotherValue

  • 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 o nome de domínio personalizado

Comando:

aws apigateway create-domain-name --domain-name 'my.domain.tld' --certificate-name 'my.domain.tld cert' --certificate-arn 'arn:aws:acm:us-east-1:012345678910:certificate/fb1b9770-a305-495d-aefb-27e5e101ff3'

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

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

AWS CLI

Para criar um modelo para um API

Comando:

aws apigateway create-model --rest-api-id 1234123412 --name 'firstModel' --description 'The First Model' --content-type 'application/json'  --schema '{ "$schema": "http://json-schema.org/draft-04/schema#", "title": "firstModel", "type": "object", "properties": { "firstProperty" : { "type": "object", "properties": { "key": { "type": "string" } } } } }'

Saída:

{
    "contentType": "application/json",
    "description": "The First Model",
    "name": "firstModel",
    "id": "2rzg0l",
    "schema": "{ \"$schema\": \"http://json-schema.org/draft-04/schema#\", \"title\": \"firstModel\", \"type\": \"object\", \"properties\": { \"firstProperty\" : { \"type\": \"object\", \"properties\": { \"key\": { \"type\": \"string\" } } } } }"
}

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

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

AWS CLI

Para criar um recurso em um API

Comando:

aws apigateway create-resource --rest-api-id 1234123412 --parent-id a1b2c3 --path-part 'new-resource'

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

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

AWS CLI

Para criar um API

Comando:

aws apigateway create-rest-api --name 'My First API' --description 'This is my first API'

Para criar uma duplicata a API partir de uma existente API

Comando:

aws apigateway create-rest-api --name 'Copy of My First API' --description 'This is a copy of my first API' --clone-from 1234123412

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

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

AWS CLI

Para criar um estágio em um API que conterá uma implantação existente

Comando:

aws apigateway create-stage --rest-api-id 1234123412 --stage-name 'dev' --description 'Development stage' --deployment-id a1b2c3

Para criar um estágio em um API que conterá uma implantação existente e variáveis de estágio personalizadas

Comando:

aws apigateway create-stage --rest-api-id 1234123412 --stage-name 'dev' --description 'Development stage' --deployment-id a1b2c3 --variables key='value',otherKey='otherValue'

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

O código de exemplo a seguir mostra como usar create-usage-plan-key.

AWS CLI

Associar uma API chave existente a um plano de uso

Comando:

aws apigateway create-usage-plan-key --usage-plan-id a1b2c3 --key-type "API_KEY" --key-id 4vq3yryqm5

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

AWS CLI

Para criar um plano de uso com limites de aceleração e cota que são redefinidos no início do mês

Comando:

aws apigateway create-usage-plan --name "New Usage Plan" --description "A new usage plan" --throttle burstLimit=10,rateLimit=5 --quota limit=500,offset=0,period=MONTH

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

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

AWS CLI

Para excluir uma API chave

Comando:

aws apigateway delete-api-key --api-key 8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk

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

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

AWS CLI

Para excluir um Autorizador personalizado em um API

Comando:

aws apigateway delete-authorizer --rest-api-id 1234123412 --authorizer-id 7gkfbo

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

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

AWS CLI

Para excluir um mapeamento de caminho base para um nome de domínio personalizado

Comando:

aws apigateway delete-base-path-mapping --domain-name 'api.domain.tld' --base-path 'dev'

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

AWS CLI

Para excluir um certificado de cliente

Comando:

aws apigateway delete-client-certificate --client-certificate-id a1b2c3

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

AWS CLI

Para excluir uma implantação em um API

Comando:

aws apigateway delete-deployment --rest-api-id 1234123412 --deployment-id a1b2c3

  • 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

Comando:

aws apigateway delete-domain-name --domain-name 'api.domain.tld'

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

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

AWS CLI

Para excluir uma resposta de integração para um determinado recurso, método e código de status em um API

Comando:

aws apigateway delete-integration-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200

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

AWS CLI

Para excluir uma integração para um determinado recurso e método em um API

Comando:

aws apigateway delete-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET

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

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

AWS CLI

Para excluir uma resposta de método para o determinado recurso, método e código de status em um API

Comando:

aws apigateway delete-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200

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

AWS CLI

Para excluir um método para um determinado recurso em um API

Comando:

aws apigateway delete-method --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET

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

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

AWS CLI

Para excluir um modelo em determinado API

Comando:

aws apigateway delete-model --rest-api-id 1234123412 --model-name 'customModel'

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

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

AWS CLI

Para excluir um recurso em um API

Comando:

aws apigateway delete-resource --rest-api-id 1234123412 --resource-id a1b2c3

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

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

AWS CLI

Para excluir um API

Comando:

aws apigateway delete-rest-api --rest-api-id 1234123412

  • Para API obter detalhes, consulte DeleteRestApina 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 em um API

Comando:

aws apigateway delete-stage --rest-api-id 1234123412 --stage-name 'dev'

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

O código de exemplo a seguir mostra como usar delete-usage-plan-key.

AWS CLI

Para remover uma API chave de um plano de uso

Comando:

aws apigateway delete-usage-plan-key --usage-plan-id a1b2c3 --key-id 1NbjQzMReAkeEQPNAW8r3dXsU2rDD7fc7f2Sipnu

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

AWS CLI

Para excluir um plano de uso

Comando:

aws apigateway delete-usage-plan --usage-plan-id a1b2c3

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

O código de exemplo a seguir mostra como usar flush-stage-authorizers-cache.

AWS CLI

Para limpar todas as entradas do cache do autorizador em um palco

Comando:

aws apigateway flush-stage-authorizers-cache --rest-api-id 1234123412 --stage-name dev

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

AWS CLI

Para limpar o cache do estágio API de um

Comando:

aws apigateway flush-stage-cache --rest-api-id 1234123412 --stage-name dev

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

O código de exemplo a seguir mostra como usar generate-client-certificate.

AWS CLI

Para criar um certificado do lado do cliente SSL

Comando:

aws apigateway generate-client-certificate --description 'My First Client Certificate'

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

AWS CLI

Para obter as configurações da conta do API Gateway

Comando:

aws apigateway get-account

Saída:

{
    "cloudwatchRoleArn": "arn:aws:iam::123412341234:role/APIGatewayToCloudWatchLogsRole",
    "throttleSettings": {
        "rateLimit": 500.0,
        "burstLimit": 1000
    }
}

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

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

AWS CLI

Para obter as informações sobre uma API chave específica

Comando:

aws apigateway get-api-key --api-key 8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk

Saída:

{
    "description": "My first key",
    "enabled": true,
    "stageKeys": [
        "a1b2c3d4e5/dev",
        "e5d4c3b2a1/dev"
    ],
    "lastUpdatedDate": 1456184515,
    "createdDate": 1456184452,
    "id": "8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk",
    "name": "My key"
}

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

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

AWS CLI

Para obter a lista de API chaves

Comando:

aws apigateway get-api-keys

Saída:

{
    "items": [
        {
            "description": "My first key",
            "enabled": true,
            "stageKeys": [
                "a1b2c3d4e5/dev",
                "e5d4c3b2a1/dev"
            ],
            "lastUpdatedDate": 1456184515,
            "createdDate": 1456184452,
            "id": "8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk",
            "name": "My key"
        }
    ]
}

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

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

AWS CLI

Para obter as configurações do API Gateway per- API Authorizer

Comando:

aws apigateway get-authorizer --rest-api-id 1234123412 --authorizer-id gfi4n3

Saída:

{
    "authorizerResultTtlInSeconds": 300,
    "name": "MyAuthorizer",
    "type": "TOKEN",
    "identitySource": "method.request.header.Authorization",
    "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:authorizer_function/invocations",
    "id": "gfi4n3"
}

  • 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 obter a lista de autorizadores de um REST API

Comando:

aws apigateway get-authorizers --rest-api-id 1234123412

Saída:

{
    "items": [
        {
            "name": "MyAuthorizer",
            "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:My_Authorizer_Function/invocations",
            "authorizerResultTtlInSeconds": 300,
            "identitySource": "method.request.header.Authorization",
            "type": "TOKEN",
            "id": "gfi4n3"
        }
    ]
}

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

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

AWS CLI

Como obter o mapeamento de caminho base para um nome de domínio personalizado

Comando:

aws apigateway get-base-path-mapping --domain-name subdomain.domain.tld --base-path v1

Saída:

{
    "basePath": "v1",
    "restApiId": "1234w4321e",
    "stage": "api"
}

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

AWS CLI

Para obter os mapeamentos de caminho base para um nome de domínio personalizado

Comando:

aws apigateway get-base-path-mappings --domain-name subdomain.domain.tld

Saída:

{
    "items": [
        {
            "basePath": "(none)",
            "restApiId": "1234w4321e",
            "stage": "dev"
        },
        {
            "basePath": "v1",
            "restApiId": "1234w4321e",
            "stage": "api"
        }
    ]
}

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

AWS CLI

Para obter um certificado de cliente

Comando:

aws apigateway get-client-certificate --client-certificate-id a1b2c3

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

AWS CLI

Para obter uma lista de certificados de clientes

Comando:

aws apigateway get-client-certificates

Saída:

{
    "items": [
        {
            "pemEncodedCertificate": "-----BEGIN CERTIFICATE----- <certificate content> -----END CERTIFICATE-----",
            "clientCertificateId": "a1b2c3",
            "expirationDate": 1483556561,
            "description": "My Client Certificate",
            "createdDate": 1452020561
        }
    ]
}

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

AWS CLI

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

Comando:

aws apigateway get-deployment --rest-api-id 1234123412 --deployment-id ztt4m2

Saída:

{
    "description": "myDeployment",
    "id": "ztt4m2",
    "createdDate": 1455218022
}

  • 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 obter uma lista de implantações para um REST API

Comando:

aws apigateway get-deployments --rest-api-id 1234123412

Saída:

{
    "items": [
        {
            "createdDate": 1453797217,
            "id": "0a2b4c",
            "description": "Deployed my API for the first time"
        }
    ]
}

  • 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 obter informações sobre um nome de domínio personalizado

Comando:

aws apigateway get-domain-name --domain-name api.domain.tld

Saída:

{
    "domainName": "api.domain.tld",
    "distributionDomainName": "d1a2f3a4c5o6d.cloudfront.net",
    "certificateName": "uploadedCertificate",
    "certificateUploadDate": 1462565487
}

  • 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 obter uma lista de nomes de domínio personalizados

Comando:

aws apigateway get-domain-names

Saída:

{
    "items": [
        {
            "distributionDomainName": "d9511k3l09bkd.cloudfront.net",
            "certificateUploadDate": 1452812505,
            "certificateName": "my_custom_domain-certificate",
            "domainName": "subdomain.domain.tld"
        }
    ]
}

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

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

AWS CLI

Para obter o modelo JSON Swagger para um palco

Comando:

aws apigateway get-export --rest-api-id a1b2c3d4e5 --stage-name dev --export-type swagger /path/to/filename.json

Para obter o modelo JSON Swagger + API Gateway Extensions para um estágio

Comando:

aws apigateway get-export --parameters extensions='integrations' --rest-api-id a1b2c3d4e5 --stage-name dev --export-type swagger /path/to/filename.json

Para obter o modelo JSON Swagger + Postman Extensions para um palco

Comando:

aws apigateway get-export --parameters extensions='postman' --rest-api-id a1b2c3d4e5 --stage-name dev --export-type swagger /path/to/filename.json

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

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

AWS CLI

Para obter a configuração da resposta de integração para um HTTP método definido no recurso REST API de a

Comando:

aws apigateway get-integration-response --rest-api-id 1234123412 --resource-id y9h6rt --http-method GET --status-code 200

Saída:

{
    "statusCode": "200",
    "responseTemplates": {
        "application/json": null
    }
}

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

AWS CLI

Para obter a configuração de integração para um HTTP método definido no recurso REST API de a

Comando:

aws apigateway get-integration --rest-api-id 1234123412 --resource-id y9h6rt --http-method GET

Saída:

{
    "httpMethod": "POST",
    "integrationResponses": {
        "200": {
            "responseTemplates": {
                "application/json": null
            },
            "statusCode": "200"
        }
    },
    "cacheKeyParameters": [],
    "type": "AWS",
    "uri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:My_Function/invocations",
    "cacheNamespace": "y9h6rt"
}

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

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

AWS CLI

Para obter a configuração do recurso de resposta do método para um HTTP método definido no recurso REST API de a

Comando:

aws apigateway get-method-response --rest-api-id 1234123412 --resource-id y9h6rt --http-method GET --status-code 200

Saída:

{
    "responseModels": {
        "application/json": "Empty"
    },
    "statusCode": "200"
}

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

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

AWS CLI

Para obter a configuração do recurso de método para um HTTP método definido no recurso REST API de a

Comando:

aws apigateway get-method --rest-api-id 1234123412 --resource-id y9h6rt --http-method GET

Saída:

{
    "apiKeyRequired": false,
    "httpMethod": "GET",
    "methodIntegration": {
        "integrationResponses": {
            "200": {
                "responseTemplates": {
                    "application/json": null
                },
                "statusCode": "200"
            }
        },
        "cacheKeyParameters": [],
        "uri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:My_Function/invocations",
        "httpMethod": "POST",
        "cacheNamespace": "y9h6rt",
        "type": "AWS"
    },
    "requestParameters": {},
    "methodResponses": {
        "200": {
            "responseModels": {
                "application/json": "Empty"
            },
            "statusCode": "200"
        }
    },
    "authorizationType": "NONE"
}

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

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

AWS CLI

Para obter o modelo de mapeamento para um modelo definido em REST API

Comando:

aws apigateway get-model-template --rest-api-id 1234123412 --model-name Empty

Saída:

{
    "value": "#set($inputRoot = $input.path('$'))\n{ }"
}

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

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

AWS CLI

Para obter a configuração de um modelo definido em REST API

Comando:

aws apigateway get-model --rest-api-id 1234123412 --model-name Empty

Saída:

{
    "contentType": "application/json",
    "description": "This is a default empty schema model",
    "name": "Empty",
    "id": "etd5w5",
    "schema": "{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"title\" : \"Empty Schema\",\n  \"type\" : \"object\"\n}"
}

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

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

AWS CLI

Para obter uma lista de modelos para um REST API

Comando:

aws apigateway get-models --rest-api-id 1234123412

Saída:

{
    "items": [
        {
            "description": "This is a default error schema model",
            "schema": "{\n  \"$schema\" : \"http://json-schema.org/draft-04/schema#\",\n  \"title\" : \"Error Schema\",\n  \"type\" : \"object\",\n  \"properties\" : {\n    \"message\" : { \"type\" : \"string\" }\n  }\n}",
            "contentType": "application/json",
            "id": "7tpbze",
            "name": "Error"
        },
        {
            "description": "This is a default empty schema model",
            "schema": "{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"title\" : \"Empty Schema\",\n  \"type\" : \"object\"\n}",
            "contentType": "application/json",
            "id": "etd5w5",
            "name": "Empty"
        }
    ]
}

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

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

AWS CLI

Para obter informações sobre um recurso

Comando:

aws apigateway get-resource --rest-api-id 1234123412 --resource-id zwo0y3

Saída:

{
    "path": "/path",
    "pathPart": "path",
    "id": "zwo0y3",
    "parentId": "uyokt6ij2g"
}

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

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

AWS CLI

Para obter uma lista de recursos para um REST API

Comando:

aws apigateway get-resources --rest-api-id 1234123412

Saída:

{
    "items": [
        {
            "path": "/resource/subresource",
            "resourceMethods": {
                "POST": {}
            },
            "id": "024ace",
            "pathPart": "subresource",
            "parentId": "ai5b02"
        }
    ]
}

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

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

AWS CLI

Para obter informações sobre um API

Comando:

aws apigateway get-rest-api --rest-api-id 1234123412

Saída:

{
    "name": "myAPI",
    "id": "o1y243m4f5",
    "createdDate": 1453416433
}

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

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

AWS CLI

Para obter uma lista de REST APIs

Comando:

aws apigateway get-rest-apis

Saída:

{
    "items": [
        {
            "createdDate": 1438884790,
            "id": "12s44z21rb",
            "name": "My First API"
        }
    ]
}

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

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

AWS CLI

Para obter o Android SDK para um REST API estágio

Comando:

aws apigateway get-sdk --rest-api-id 1234123412 --stage-name dev --sdk-type android --parameters groupId='com.mycompany',invokerPackage='com.mycompany.clientsdk',artifactId='Mycompany-client',artifactVersion='1.0.0' /path/to/android_sdk.zip

Saída:

{
    "contentType": "application/octet-stream",
    "contentDisposition": "attachment; filename=\"android_2016-02-22_23-52Z.zip\""
}

Para obter o IOS SDK para um REST API palco

Comando:

aws apigateway get-sdk --rest-api-id 1234123412 --stage-name dev --sdk-type objectivec --parameters classPrefix='myprefix' /path/to/iOS_sdk.zip

Saída:

{
    "contentType": "application/octet-stream",
    "contentDisposition": "attachment; filename=\"objectivec_2016-02-22_23-52Z.zip\""
}

Para obter o Javascript SDK para um REST API estágio

Comando:

aws apigateway get-sdk --rest-api-id 1234123412 --stage-name dev --sdk-type javascript /path/to/javascript_sdk.zip

Saída:

{
    "contentType": "application/octet-stream",
    "contentDisposition": "attachment; filename=\"javascript_2016-02-22_23-52Z.zip\""
}

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

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

AWS CLI

Para obter informações sobre o estágio API de um

Comando:

aws apigateway get-stage --rest-api-id 1234123412 --stage-name dev

Saída:

{
    "stageName": "dev",
    "cacheClusterSize": "0.5",
    "cacheClusterEnabled": false,
    "cacheClusterStatus": "NOT_AVAILABLE",
    "deploymentId": "rbh1fj",
    "lastUpdatedDate": 1466802961,
    "createdDate": 1460682074,
    "methodSettings": {
        "*/*": {
            "cacheTtlInSeconds": 300,
            "loggingLevel": "INFO",
            "dataTraceEnabled": false,
            "metricsEnabled": true,
            "unauthorizedCacheControlHeaderStrategy": "SUCCEED_WITH_RESPONSE_HEADER",
            "throttlingRateLimit": 500.0,
            "cacheDataEncrypted": false,
            "cachingEnabled": false,
            "throttlingBurstLimit": 1000,
            "requireAuthorizationForCacheControl": true
        },
        "~1resource/GET": {
            "cacheTtlInSeconds": 300,
            "loggingLevel": "INFO",
            "dataTraceEnabled": false,
            "metricsEnabled": true,
            "unauthorizedCacheControlHeaderStrategy": "SUCCEED_WITH_RESPONSE_HEADER",
            "throttlingRateLimit": 500.0,
            "cacheDataEncrypted": false,
            "cachingEnabled": false,
            "throttlingBurstLimit": 1000,
            "requireAuthorizationForCacheControl": true
        }
    }
}

  • 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 obter a lista de estágios de um REST API

Comando:

aws apigateway get-stages --rest-api-id 1234123412

Saída:

{
    "item": [
        {
            "stageName": "dev",
            "cacheClusterSize": "0.5",
            "cacheClusterEnabled": true,
            "cacheClusterStatus": "AVAILABLE",
            "deploymentId": "123h64",
            "lastUpdatedDate": 1456185138,
            "createdDate": 1453589092,
            "methodSettings": {
                "~1resource~1subresource/POST": {
                    "cacheTtlInSeconds": 300,
                    "loggingLevel": "INFO",
                    "dataTraceEnabled": true,
                    "metricsEnabled": true,
                    "throttlingRateLimit": 500.0,
                    "cacheDataEncrypted": false,
                    "cachingEnabled": false,
                    "throttlingBurstLimit": 1000
                }
            }
        }
    ]
}

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

O código de exemplo a seguir mostra como usar get-usage-plan-key.

AWS CLI

Para obter os detalhes de uma API chave associada a um plano de uso

Comando:

aws apigateway get-usage-plan-key --usage-plan-id a1b2c3 --key-id 1NbjQzMReAkeEQPNAW8r3dXsU2rDD7fc7f2Sipnu

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

O código de exemplo a seguir mostra como usar get-usage-plan-keys.

AWS CLI

Para obter a lista de API chaves associadas a um plano de uso

Comando:

aws apigateway get-usage-plan-keys --usage-plan-id a1b2c3

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

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

AWS CLI

Para obter os detalhes de um plano de uso

Comando:

aws apigateway get-usage-plan --usage-plan-id a1b2c3

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

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

AWS CLI

Para obter os detalhes de todos os planos de uso

Comando:

aws apigateway get-usage-plans

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

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

AWS CLI

Para obter os detalhes de uso de um plano de uso

Comando:

aws apigateway get-usage --usage-plan-id a1b2c3 --start-date "2016-08-16" --end-date "2016-08-17"

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

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

AWS CLI

Para importar um modelo do Swagger e criar um API

Comando:

aws apigateway import-rest-api --body 'file:///path/to/API_Swagger_template.json'

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

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

AWS CLI

Como criar uma resposta de integração como a resposta padrão com um modelo de mapeamento definido

Comando:

aws apigateway put-integration-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 --selection-pattern "" --response-templates '{"application/json": "{\"json\": \"template\"}"}'

Como criar uma resposta de integração com um regex de 400 e um valor de cabeçalho definido de forma estática

Comando:

aws apigateway put-integration-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 400 --selection-pattern 400 --response-parameters '{"method.response.header.custom-header": "'"'"'custom-value'"'"'"}'

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

AWS CLI

Para criar uma solicitação MOCK de integração

Comando:

aws apigateway put-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --type MOCK --request-templates '{ "application/json": "{\"statusCode\": 200}" }'

Para criar uma solicitação HTTP de integração

Comando:

aws apigateway put-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --type HTTP --integration-http-method GET --uri 'https://domain.tld/path'

Para criar uma solicitação de AWS integração com um endpoint da Função Lambda

Comando:

aws apigateway put-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --type AWS --integration-http-method POST --uri 'arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:function_name/invocations'

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

O código de exemplo a seguir mostra como usar put-method-response.

AWS CLI

Como criar uma resposta de método de acordo com o código de status especificado com um cabeçalho de resposta de método personalizado

Comando:

aws apigateway put-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 400 --response-parameters "method.response.header.custom-header=false"

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

O código de exemplo a seguir mostra como usar put-method.

AWS CLI

Para criar um método para um recurso em um API cabeçalho de solicitação de método personalizado sem autorização, sem API chave

Comando:

aws apigateway put-method --rest-api-id 1234123412 --resource-id a1b2c3 --http-method PUT --authorization-type "NONE" --no-api-key-required --request-parameters "method.request.header.custom-header=false"

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

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

AWS CLI

Para sobrescrever um existente API usando um modelo Swagger

Comando:

aws apigateway put-rest-api --rest-api-id 1234123412 --mode overwrite --body 'fileb:///path/to/API_Swagger_template.json'

Para mesclar um modelo do Swagger em um existente API

Comando:

aws apigateway put-rest-api --rest-api-id 1234123412 --mode merge --body 'fileb:///path/to/API_Swagger_template.json'

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

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

AWS CLI

Para testar, invoque uma solicitação para um Autorizador Personalizado, incluindo o cabeçalho e o valor necessários.

Comando:

aws apigateway test-invoke-authorizer --rest-api-id 1234123412 --authorizer-id 5yid1t --headers Authorization='Value'

O código de exemplo a seguir mostra como usar test-invoke-method.

AWS CLI

Para testar, invoque o recurso raiz em um API fazendo uma solicitação GET

Comando:

aws apigateway test-invoke-method --rest-api-id 1234123412 --resource-id avl5sg8fw8 --http-method GET --path-with-query-string '/'

Para testar, invocar um sub-recurso em um API fazendo uma GET solicitação com um valor de parâmetro de caminho especificado

Comando:

aws apigateway test-invoke-method --rest-api-id 1234123412 --resource-id 3gapai --http-method GET --path-with-query-string '/pets/1'

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

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

AWS CLI

Para alterar a IAM função ARN de registro em CloudWatch registros

Comando:

aws apigateway update-account --patch-operations op='replace',path='/cloudwatchRoleArn',value='arn:aws:iam::123412341234:role/APIGatewayToCloudWatchLogs'

Saída:

{
    "cloudwatchRoleArn": "arn:aws:iam::123412341234:role/APIGatewayToCloudWatchLogs",
    "throttleSettings": {
        "rateLimit": 1000.0,
        "burstLimit": 2000
    }
}

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

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

AWS CLI

Para alterar o nome de uma API chave

Comando:

aws apigateway update-api-key --api-key sNvjQDMReA1eEQPNAW8r37XsU2rDD7fc7m2SiMnu --patch-operations op='replace',path='/name',value='newName'

Saída:

{
    "description": "currentDescription",
    "enabled": true,
    "stageKeys": [
        "41t2j324r5/dev"
    ],
    "lastUpdatedDate": 1470086052,
    "createdDate": 1445460347,
    "id": "sNvjQDMReA1vEQPNzW8r3dXsU2rrD7fcjm2SiMnu",
    "name": "newName"
}

Para desativar a API chave

Comando:

aws apigateway update-api-key --api-key sNvjQDMReA1eEQPNAW8r37XsU2rDD7fc7m2SiMnu --patch-operations op='replace',path='/enabled',value='false'

Saída:

{
    "description": "currentDescription",
    "enabled": false,
    "stageKeys": [
        "41t2j324r5/dev"
    ],
    "lastUpdatedDate": 1470086052,
    "createdDate": 1445460347,
    "id": "sNvjQDMReA1vEQPNzW8r3dXsU2rrD7fcjm2SiMnu",
    "name": "newName"
}

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

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

AWS CLI

Para alterar o nome do Autorizador Personalizado

Comando:

aws apigateway update-authorizer --rest-api-id 1234123412 --authorizer-id gfi4n3 --patch-operations op='replace',path='/name',value='testAuthorizer'

Saída:

{
    "authType": "custom",
    "name": "testAuthorizer",
    "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:customAuthorizer/invocations",
    "authorizerResultTtlInSeconds": 300,
    "identitySource": "method.request.header.Authorization",
    "type": "TOKEN",
    "id": "gfi4n3"
}

Para alterar a função Lambda que é invocada pelo Autorizador personalizado

Comando:

aws apigateway update-authorizer --rest-api-id 1234123412 --authorizer-id gfi4n3 --patch-operations op='replace',path='/authorizerUri',value='arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:newAuthorizer/invocations'

Saída:

{
    "authType": "custom",
    "name": "testAuthorizer",
    "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:newAuthorizer/invocations",
    "authorizerResultTtlInSeconds": 300,
    "identitySource": "method.request.header.Authorization",
    "type": "TOKEN",
    "id": "gfi4n3"
}

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

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

AWS CLI

Como alterar o caminho base de um nome de domínio personalizado

Comando:

aws apigateway update-base-path-mapping --domain-name api.domain.tld --base-path prod --patch-operations op='replace',path='/basePath',value='v1'

Saída:

{
    "basePath": "v1",
    "restApiId": "1234123412",
    "stage": "api"
}

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

AWS CLI

Para atualizar a descrição de um certificado de cliente

Comando:

aws apigateway update-client-certificate --client-certificate-id a1b2c3 --patch-operations op='replace',path='/description',value='My new description'

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

AWS CLI

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

Comando:

aws apigateway update-deployment --rest-api-id 1234123412 --deployment-id ztt4m2 --patch-operations op='replace',path='/description',value='newDescription'

Saída:

{
    "description": "newDescription",
    "id": "ztt4m2",
    "createdDate": 1455218022
}

  • 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 alterar o nome do certificado para um nome de domínio personalizado

O update-domain-name exemplo a seguir altera o nome do certificado para um domínio personalizado.

aws apigateway update-domain-name \
    --domain-name api.domain.tld \
    --patch-operations op='replace',path='/certificateArn',value='arn:aws:acm:us-west-2:111122223333:certificate/CERTEXAMPLE123EXAMPLE'

Saída:

{
    "domainName": "api.domain.tld",
    "distributionDomainName": "d123456789012.cloudfront.net",
    "certificateArn": "arn:aws:acm:us-west-2:111122223333:certificate/CERTEXAMPLE123EXAMPLE",
    "certificateUploadDate": 1462565487
}

Para obter mais informações, consulte Configurar um nome de domínio personalizado para um API gateway API 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-response.

AWS CLI

Para alterar um cabeçalho de resposta de integração para ter um mapeamento estático de '*'

Comando:

aws apigateway update-integration-response --rest-api-id 1234123412 --resource-id 3gapai --http-method GET --status-code 200 --patch-operations op='replace',path='/responseParameters/method.response.header.Access-Control-Allow-Origin',value='"'"'*'"'"'

Saída:

{
    "statusCode": "200",
    "responseParameters": {
        "method.response.header.Access-Control-Allow-Origin": "'*'"
    }
}

Para remover um cabeçalho de resposta de integração

Comando:

aws apigateway update-integration-response --rest-api-id 1234123412 --resource-id 3gapai --http-method GET --status-code 200 --patch-operations op='remove',path='/responseParameters/method.response.header.Access-Control-Allow-Origin'

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

AWS CLI

Para adicionar o modelo de mapeamento 'Content-Type: application/json' configurado com passagem de entrada

Comando:

aws apigateway update-integration \
    --rest-api-id a1b2c3d4e5 \
    --resource-id a1b2c3 \
    --http-method POST \
    --patch-operations "op='add',path='/requestTemplates/application~1json'"

Para atualizar (substituir) o modelo de mapeamento 'Content-Type: application/json' configurado por um modelo personalizado

Comando:

aws apigateway update-integration \
    --rest-api-id a1b2c3d4e5 \
    --resource-id a1b2c3 \
    --http-method POST \
    --patch-operations "op='replace',path='/requestTemplates/application~1json',value='{"example": "json"}'"

Para atualizar (substituir) um modelo personalizado associado a 'Content-Type: application/json' com Input Passthrough

Comando:

aws apigateway update-integration \
    --rest-api-id a1b2c3d4e5 \
    --resource-id a1b2c3 \
    --http-method POST \
    --patch-operations "op='replace',path='requestTemplates/application~1json'"

Para remover o modelo de mapeamento 'Content-Type: application/json'

Comando:

aws apigateway update-integration \
    --rest-api-id a1b2c3d4e5 \
    --resource-id a1b2c3 \
    --http-method POST \
    --patch-operations "op='remove',path='/requestTemplates/application~1json'"

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

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

AWS CLI

Para criar um novo cabeçalho de resposta de método para a resposta 200 em um método e defini-lo como não obrigatório (padrão)

Comando:

aws apigateway update-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 --patch-operations op="add",path="/responseParameters/method.response.header.custom-header",value="false"

Para excluir um modelo de resposta para a resposta 200 em um método

Comando:

aws apigateway update-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 --patch-operations op="remove",path="/responseModels/application~1json"

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

AWS CLI

Exemplo 1: Para modificar um método para exigir uma API chave

O update-method exemplo a seguir modifica o método para exigir uma API chave.

aws apigateway update-method \
    --rest-api-id 1234123412 \
    --resource-id a1b2c3 \
    --http-method GET \
    --patch-operations op="replace",path="/apiKeyRequired",value="true"

Saída:

{
    "httpMethod": "GET",
    "authorizationType": "NONE",
    "apiKeyRequired": true,
    "methodResponses": {
        "200": {
            "statusCode": "200",
            "responseModels": {}
        }
    },
    "methodIntegration": {
        "type": "AWS",
        "httpMethod": "POST",
        "uri": "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:123456789111:function:hello-world/invocations",
        "passthroughBehavior": "WHEN_NO_MATCH",
        "contentHandling": "CONVERT_TO_TEXT",
        "timeoutInMillis": 29000,
        "cacheNamespace": "h7i8j9",
        "cacheKeyParameters": [],
        "integrationResponses": {
            "200": {
                "statusCode": "200",
                "responseTemplates": {}
            }
        }
    }
}

Exemplo 2: Para modificar um método para exigir IAM autorização

O update-method exemplo a seguir modifica o método para exigir IAM autorização.

aws apigateway update-method \
    --rest-api-id 1234123412 \
    --resource-id a1b2c3 \
    --http-method GET \
    --patch-operations op="replace",path="/authorizationType",value="AWS_IAM"

Saída:

 {
    "httpMethod": "GET",
    "authorizationType": "AWS_IAM",
    "apiKeyRequired": false,
    "methodResponses": {
        "200": {
            "statusCode": "200",
            "responseModels": {}
        }
    },
    "methodIntegration": {
        "type": "AWS",
        "httpMethod": "POST",
        "uri": "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:123456789111:function:hello-world/invocations",
        "passthroughBehavior": "WHEN_NO_MATCH",
        "contentHandling": "CONVERT_TO_TEXT",
        "timeoutInMillis": 29000,
        "cacheNamespace": "h7i8j9",
        "cacheKeyParameters": [],
        "integrationResponses": {
            "200": {
                "statusCode": "200",
                "responseTemplates": {}
            }
        }
    }
}

Exemplo 3: Modificar um método para exigir autorização Lambda

O update-method exemplo a seguir modifica o método para a autorização Lambda necessária.

aws apigateway update-method --rest-api-id 1234123412 \
    --resource-id a1b2c3 \
    --http-method GET \
    --patch-operations op="replace",path="/authorizationType",value="CUSTOM" op="replace",path="/authorizerId",value="e4f5g6"

Saída:

 {
    "httpMethod": "GET",
    "authorizationType": "CUSTOM",
    "authorizerId" : "e4f5g6",
    "apiKeyRequired": false,
    "methodResponses": {
        "200": {
            "statusCode": "200",
            "responseModels": {}
        }
    },
    "methodIntegration": {
        "type": "AWS",
        "httpMethod": "POST",
        "uri": "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:123456789111:function:hello-world/invocations",
        "passthroughBehavior": "WHEN_NO_MATCH",
        "contentHandling": "CONVERT_TO_TEXT",
        "timeoutInMillis": 29000,
        "cacheNamespace": "h7i8j9",
        "cacheKeyParameters": [],
        "integrationResponses": {
            "200": {
                "statusCode": "200",
                "responseTemplates": {}
            }
        }
    }
}

Para obter mais informações, consulte Criar, configurar e testar planos de uso usando o API Gateway CLI e Controlar REST API e gerenciar o acesso a um API gateway REST API no Amazon API Gateway Developer Guide.

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

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

AWS CLI

Para alterar a descrição de um modelo em um API

Comando:

aws apigateway update-model --rest-api-id 1234123412 --model-name 'Empty' --patch-operations op=replace,path=/description,value='New Description'

Para alterar o esquema de um modelo em um API

Comando:

aws apigateway update-model --rest-api-id 1234123412 --model-name 'Empty' --patch-operations op=replace,path=/schema,value='"{ \"$schema\": \"http://json-schema.org/draft-04/schema#\", \"title\" : \"Empty Schema\", \"type\" : \"object\" }"'

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

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

AWS CLI

Para mover um recurso e colocá-lo sob um recurso principal diferente em um API

Comando:

aws apigateway update-resource --rest-api-id 1234123412 --resource-id 1a2b3c --patch-operations op=replace,path=/parentId,value='3c2b1a'

Saída:

{
    "path": "/resource",
    "pathPart": "resource",
    "id": "1a2b3c",
    "parentId": "3c2b1a"
}

Para renomear um recurso (pathPart) em um API

Comando:

aws apigateway update-resource --rest-api-id 1234123412 --resource-id 1a2b3c --patch-operations op=replace,path=/pathPart,value=newresourcename

Saída:

{
    "path": "/newresourcename",
    "pathPart": "newresourcename",
    "id": "1a2b3c",
    "parentId": "3c2b1a"
}

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

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

AWS CLI

Para alterar o nome de um API

Comando:

aws apigateway update-rest-api --rest-api-id 1234123412 --patch-operations op=replace,path=/name,value='New Name'

Para alterar a descrição de um API

Comando:

aws apigateway update-rest-api --rest-api-id 1234123412 --patch-operations op=replace,path=/description,value='New Description'

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

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

AWS CLI

Exemplo 1: Para substituir as configurações de estágio de um recurso e método

O update-stage exemplo a seguir substitui as configurações do estágio e desativa o registro completo de solicitação/resposta para um recurso e método específicos.

aws apigateway update-stage \
    --rest-api-id 1234123412 \
    --stage-name 'dev' \
    --patch-operations op=replace,path=/~1resourceName/GET/logging/dataTrace,value=false

Saída:

{
    "deploymentId": "5ubd17",
    "stageName": "dev",
    "cacheClusterEnabled": false,
    "cacheClusterStatus": "NOT_AVAILABLE",
    "methodSettings": {
        "~1resourceName/GET": {
            "metricsEnabled": false,
            "dataTraceEnabled": false,
            "throttlingBurstLimit": 5000,
            "throttlingRateLimit": 10000.0,
            "cachingEnabled": false,
            "cacheTtlInSeconds": 300,
            "cacheDataEncrypted": false,
            "requireAuthorizationForCacheControl": true,
            "unauthorizedCacheControlHeaderStrategy": "SUCCEED_WITH_RESPONSE_HEADER"
        }
    },
    "tracingEnabled": false,
    "createdDate": "2022-07-18T10:11:18-07:00",
    "lastUpdatedDate": "2022-07-18T10:19:04-07:00"
}

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

Exemplo 2: Para atualizar as configurações do estágio para todos os recursos e métodos de um API estágio

O update-stage exemplo a seguir ativa o registro completo de solicitação/resposta para todos os recursos e métodos de um estágio. API

aws apigateway update-stage \
    --rest-api-id 1234123412 \
    --stage-name 'dev' \
    --patch-operations 'op=replace,path=/*/*/logging/dataTrace,value=true'

Saída:

{
    "deploymentId": "5ubd17",
    "stageName": "dev",
    "cacheClusterEnabled": false,
    "cacheClusterStatus": "NOT_AVAILABLE",
    "methodSettings": {
        "*/*": {
            "metricsEnabled": false,
            "dataTraceEnabled": true,
            "throttlingBurstLimit": 5000,
            "throttlingRateLimit": 10000.0,
            "cachingEnabled": false,
            "cacheTtlInSeconds": 300,
            "cacheDataEncrypted": false,
            "requireAuthorizationForCacheControl": true,
            "unauthorizedCacheControlHeaderStrategy": "SUCCEED_WITH_RESPONSE_HEADER"
        }
    },
    "tracingEnabled": false,
    "createdDate": "2022-07-18T10:11:18-07:00",
    "lastUpdatedDate": "2022-07-18T10:31:04-07:00"
}

Para obter mais informações, consulte Como configurar um palco para um REST 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-usage-plan.

AWS CLI

Para alterar o período definido em um Plano de Uso

Comando:

aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/quota/period",value="MONTH"

Para alterar o limite de cota definido em um plano de uso

Comando:

aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/quota/limit",value="500"

Para alterar o limite da taxa de aceleração definido em um Plano de Uso

Comando:

aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/throttle/rateLimit",value="10"

Para alterar o limite de pico de aceleração definido em um Plano de Uso

Comando:

aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/throttle/burstLimit",value="20"

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

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

AWS CLI

Para modificar temporariamente a cota em uma API chave para o período atual definido no Plano de Uso

Comando:

aws apigateway update-usage --usage-plan-id a1b2c3 --key-id 1NbjQzMReAkeEQPNAW8r3dXsU2rDD7fc7f2Sipnu --patch-operations op="replace",path="/remaining",value="50"

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