Sono disponibili altri esempi AWS SDK nel repository AWS Doc SDK
Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
API Gateway HTTP e esempi di WebSocket API che utilizzano AWS CLI
I seguenti esempi di codice mostrano come eseguire azioni e implementare scenari comuni utilizzando HTTP e WebSocket API AWS Command Line Interface with API Gateway.
Le operazioni sono estratti di codice da programmi più grandi e devono essere eseguite nel contesto. Sebbene le operazioni mostrino come richiamare le singole funzioni del servizio, è possibile visualizzarle contestualizzate negli scenari correlati.
Ogni esempio include un collegamento al codice sorgente completo, in cui è possibile trovare istruzioni su come configurare ed eseguire il codice nel contesto.
Argomenti
Azioni
Il seguente esempio di codice mostra come utilizzarecreate-api-mapping.
- AWS CLI
-
Per creare una mappatura API per un'API
L'
create-api-mappingesempio seguente mappa loteststadio di un'API sul/myApipercorso del nome di dominioregional.example.compersonalizzato.aws apigatewayv2 create-api-mapping \ --domain-nameregional.example.com\ --api-mapping-keymyApi\ --api-ida1b2c3d4\ --stagetestOutput:
{ "ApiId": "a1b2c3d4", "ApiMappingId": "0qzs2sy7bh", "ApiMappingKey": "myApi" "Stage": "test" }Per ulteriori informazioni, consulta Configurazione di un nome di dominio personalizzato regionale in API Gateway nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta CreateApiMapping AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarecreate-api.
- AWS CLI
-
Per creare un'API HTTP
L'
create-apiesempio seguente crea un'API HTTP utilizzando la creazione rapida. Puoi utilizzare la creazione rapida per creare un'API con un'integrazione AWS Lambda o HTTP, un percorso generico predefinito e una fase predefinita configurata per distribuire automaticamente le modifiche. Il comando seguente utilizza la creazione rapida per creare un'API HTTP che si integra con una funzione Lambda.aws apigatewayv2 create-api \ --namemy-http-api\ --protocol-typeHTTP\ --targetarn:aws:lambda:us-west-2:123456789012:function:my-lambda-functionOutput:
{ "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" }Per ulteriori informazioni, consulta la sezione Sviluppo di un'API HTTP in API Gateway nella Amazon API Gateway Developer Guide.
Per creare un' WebSocket API
L'
create-apiesempio seguente crea un' WebSocket API con il nome specificato.aws apigatewayv2 create-api \ --name"myWebSocketApi"\ --protocol-typeWEBSOCKET\ --route-selection-expression '$request.body.action'Output:
{ "ApiKeySelectionExpression": "$request.header.x-api-key", "Name": "myWebSocketApi", "CreatedDate": "2018-11-15T06:23:51Z", "ProtocolType": "WEBSOCKET", "RouteSelectionExpression": "'$request.body.action'", "ApiId": "aabbccddee" }Per ulteriori informazioni, consulta Creare un' WebSocket API in API Gateway nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta CreateApi AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarecreate-authorizer.
- AWS CLI
-
Per creare un autorizzatore JWT per un'API HTTP
L'
create-authorizeresempio seguente crea un autorizzatore JWT che utilizza Amazon Cognito come provider di identità.aws apigatewayv2 create-authorizer \ --namemy-jwt-authorizer\ --api-ida1b2c3d4\ --authorizer-typeJWT\ --identity-source '$request.header.Authorization' \ --jwt-configurationAudience=123456abc,Issuer=https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc123Output:
{ "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" }Per ulteriori informazioni, consulta Controllare l'accesso a HTTP APIs con gli autorizzatori JWT nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta AWS CLI Command CreateAuthorizer
Reference.
-
Il seguente esempio di codice mostra come utilizzarecreate-deployment.
- AWS CLI
-
Per creare una distribuzione per un'API
L'
create-deploymentesempio seguente crea una distribuzione per un'API e associa tale distribuzione alladevfase dell'API.aws apigatewayv2 create-deployment \ --api-ida1b2c3d4\ --stage-namedevOutput:
{ "AutoDeployed": false, "CreatedDate": "2020-04-06T23:38:08Z", "DeploymentId": "53lz9l", "DeploymentStatus": "DEPLOYED" }Per ulteriori informazioni, consulta la pagina relativa alla distribuzione delle API nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta CreateDeployment AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarecreate-domain-name.
- AWS CLI
-
Per creare un nome di dominio personalizzato
L'
create-domain-nameesempio seguente crea un nome di dominio personalizzato regionale per un'API.aws apigatewayv2 create-domain-name \ --domain-nameregional.example.com\ --domain-name-configurationsCertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678Output:
{ "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" } ] }Per ulteriori informazioni, consulta Configurazione di un nome di dominio personalizzato regionale in API Gateway nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta CreateDomainName AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarecreate-integration.
- AWS CLI
-
Per creare un'integrazione WebSocket API
L'
create-integrationesempio seguente crea un'integrazione fittizia per un' WebSocket API.aws apigatewayv2 create-integration \ --api-idaabbccddee\ --passthrough-behaviorWHEN_NO_MATCH\ --timeout-in-millis29000\ --connection-typeINTERNET\ --integration-typeMOCKOutput:
{ "ConnectionType": "INTERNET", "IntegrationId": "0abcdef", "IntegrationResponseSelectionExpression": "${integration.response.statuscode}", "IntegrationType": "MOCK", "PassthroughBehavior": "WHEN_NO_MATCH", "PayloadFormatVersion": "1.0", "TimeoutInMillis": 29000 }Per ulteriori informazioni, consulta Configurare una richiesta di integrazione WebSocket API in API Gateway nella Amazon API Gateway Developer Guide.
Per creare un'integrazione API HTTP
L'
create-integrationesempio seguente crea un'integrazione AWS Lambda per un'API HTTP.aws apigatewayv2 create-integration \ --api-ida1b2c3d4\ --integration-typeAWS_PROXY\ --integration-uriarn:aws:lambda:us-west-2:123456789012:function:my-function\ --payload-format-version2.0Output:
{ "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 }Per ulteriori informazioni, consulta Configurazione delle integrazioni per HTTP APIs nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta AWS CLI Command CreateIntegration
Reference.
-
Il seguente esempio di codice mostra come utilizzarecreate-route.
- AWS CLI
-
Per creare una route $default per un'API WebSocket o HTTP
L'
create-routeesempio seguente crea una$defaultroute per un'API WebSocket o HTTP.aws apigatewayv2 create-route \ --api-idaabbccddee\ --route-key '$default'Output:
{ "ApiKeyRequired": false, "AuthorizationType": "NONE", "RouteKey": "$default", "RouteId": "1122334" }Per ulteriori informazioni, consulta Working with routes for WebSocket APIs nella Amazon API Gateway Developer Guide
Per creare un percorso per un'API HTTP
L'
create-routeesempio seguente crea una route denominatasignupche accetta richieste POST.aws apigatewayv2 create-route \ --api-idaabbccddee\ --route-key 'POST /signup'Output:
{ "ApiKeyRequired": false, "AuthorizationType": "NONE", "RouteKey": "POST /signup", "RouteId": "1122334" }Per ulteriori informazioni, consulta Working with routes for HTTP APIs nella Amazon API Gateway Developer Guide
-
Per i dettagli sull'API, consulta CreateRoute AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarecreate-routing-rule.
- AWS CLI
-
Per creare una regola di routing
L'
create-routing-ruleesempio seguente crea una regola di routing con una priorità di.50aws apigatewayv2 create-routing-rule \ --domain-name 'regional.example.com' \ --priority50\ --conditions '[ \ { \ "MatchBasePaths": { \ "AnyOf": [ \ "PetStoreShopper" \ ] \ } \ } \ ]' \ --actions '[ \ { \ "InvokeApi": { \ "ApiId": "abcd1234", \ "Stage": "prod" \ } \ } \ ]'Output:
{ "Actions": [ { "InvokeApi": { "ApiId": "abcd1234", "Stage": "prod", "StripBasePath": false } } ], "Conditions": [ { "MatchBasePaths": { "AnyOf": [ "PetStoreShopper" ] } } ], "Priority": 50, "RoutingRuleArn": "arn:aws:apigateway:us-east-2:123456789012:/domainnames/regional.example.com/routingrules/aaa111", "RoutingRuleId": "aaa111" }Per ulteriori informazioni, consulta Regole di routing per connettere le fasi dell'API a un nome di dominio personalizzato per REST APIs nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta CreateRoutingRule AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarecreate-stage.
- AWS CLI
-
Per creare uno stage
L'
create-stageesempio seguente crea una fase denominata dev per un'API.aws apigatewayv2 create-stage \ --api-ida1b2c3d4\ --stage-namedevOutput:
{ "CreatedDate": "2020-04-06T23:23:46Z", "DefaultRouteSettings": { "DetailedMetricsEnabled": false }, "LastUpdatedDate": "2020-04-06T23:23:46Z", "RouteSettings": {}, "StageName": "dev", "StageVariables": {}, "Tags": {} }Per ulteriori informazioni, consulta Working with stages for HTTP APIs nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta CreateStage AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarecreate-vpc-link.
- AWS CLI
-
Per creare un collegamento VPC per un'API HTTP
L'
create-vpc-linkesempio seguente crea un collegamento VPC per HTTP. APIsaws apigatewayv2 create-vpc-link \ --nameMyVpcLink\ --subnet-idssubnet-aaaasubnet-bbbb\ --security-group-idssg1234sg5678Output:
{ "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" }Per ulteriori informazioni, consulta Working with VPC links for HTTP APIs nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta CreateVpcLink AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-access-log-settings.
- AWS CLI
-
Per disabilitare la registrazione degli accessi per un'API
L'
delete-access-log-settingsesempio seguente elimina le impostazioni del registro di accesso per la$defaultfase di un'API. Per disabilitare la registrazione degli accessi per una fase, eliminate le relative impostazioni del registro di accesso.aws apigatewayv2 delete-access-log-settings \ --api-ida1b2c3d4\ --stage-name '$default'Questo comando non produce alcun output.
Per ulteriori informazioni, consulta Configurazione della registrazione per un'API HTTP nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta AWS CLI Command DeleteAccessLogSettings
Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-api-mapping.
- AWS CLI
-
Per eliminare una mappatura API
L'
delete-api-mappingesempio seguente elimina una mappatura API per il nome di dominioapi.example.compersonalizzato.aws apigatewayv2 delete-api-mapping \ --api-mapping-ida1b2c3\ --domain-nameapi.example.comQuesto comando non produce alcun output.
Per ulteriori informazioni, consulta Configurazione di un nome di dominio personalizzato regionale in API Gateway nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta DeleteApiMapping AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-api.
- AWS CLI
-
Per eliminare un'API
L'
delete-apiesempio seguente elimina un'API.aws apigatewayv2 delete-api \ --api-ida1b2c3d4Questo comando non produce alcun output.
Per ulteriori informazioni, consulta Working with HTTP APIs e Working with WebSocket APIs nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta DeleteApi AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-authorizer.
- AWS CLI
-
Per eliminare un autorizzatore
L'
delete-authorizeresempio seguente elimina un autorizzatore.aws apigatewayv2 delete-authorizer \ --api-ida1b2c3d4\ --authorizer-ida1b2c3Questo comando non produce alcun output.
Per ulteriori informazioni, consulta Controllare l'accesso a HTTP APIs con gli autorizzatori JWT nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta AWS CLI Command DeleteAuthorizer
Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-cors-configuration.
- AWS CLI
-
Per eliminare la configurazione CORS per un'API HTTP
L'
delete-cors-configurationesempio seguente disabilita CORS per un'API HTTP eliminando la relativa configurazione CORS.aws apigatewayv2 delete-cors-configuration \ --api-ida1b2c3d4Questo comando non produce alcun output.
Per ulteriori informazioni, consulta Configurazione di CORS per un'API HTTP nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta AWS CLI Command DeleteCorsConfiguration
Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-deployment.
- AWS CLI
-
Per eliminare una distribuzione
L'
delete-deploymentesempio seguente elimina una distribuzione di un'API.aws apigatewayv2 delete-deployment \ --api-ida1b2c3d4\ --deployment-ida1b2c3Questo comando non produce alcun output.
Per ulteriori informazioni, consulta la pagina relativa alla distribuzione delle API nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta DeleteDeployment AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-domain-name.
- AWS CLI
-
Per eliminare un nome di dominio personalizzato
L'
delete-domain-nameesempio seguente elimina un nome di dominio personalizzato.aws apigatewayv2 delete-domain-name \ --domain-nameapi.example.comQuesto comando non produce alcun output.
Per ulteriori informazioni, consulta Configurazione di un nome di dominio personalizzato regionale in API Gateway nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta DeleteDomainName AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-integration.
- AWS CLI
-
Per eliminare un'integrazione
L'
delete-integrationesempio seguente elimina un'integrazione API.aws apigatewayv2 delete-integration \ --api-ida1b2c3d4\ --integration-ida1b2c3Questo comando non produce alcun output.
Per ulteriori informazioni, consulta Configurazione delle integrazioni per HTTP APIs e Configurazione delle integrazioni WebSocket API nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta Command DeleteIntegration
Reference AWS CLI .
-
Il seguente esempio di codice mostra come utilizzaredelete-route-settings.
- AWS CLI
-
Per eliminare le impostazioni del percorso
L'
delete-route-settingsesempio seguente elimina le impostazioni del percorso per il percorso specificato.aws apigatewayv2 delete-route-settings \ --api-ida1b2c3d4\ --stage-namedev\ --route-key 'GET /pets'Questo comando non produce alcun output.
Per ulteriori informazioni, consulta Working with routes for HTTP APIs nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta DeleteRouteSettings AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-route.
- AWS CLI
-
Per eliminare un percorso
L'
delete-routeesempio seguente elimina una route API.aws apigatewayv2 delete-route \ --api-ida1b2c3d4\ --route-ida1b2c3Questo comando non produce alcun output.
Per ulteriori informazioni, consulta Working with routes for HTTP APIs nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta DeleteRoute AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-routing-rule.
- AWS CLI
-
Per eliminare una regola di routing
L'
delete-routing-ruleesempio seguente elimina una regola di routing per un nome di dominio personalizzato.aws apigatewayv2 delete-routing-rule \ --domain-name 'regional.example.com' \ --routing-rule-idaaa111Questo comando non produce alcun output.
Per ulteriori informazioni, consulta Regole di routing per connettere le fasi dell'API a un nome di dominio personalizzato per REST APIs nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta DeleteRoutingRule AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-stage.
- AWS CLI
-
Per eliminare una fase
L'
delete-stageesempio seguente elimina loteststadio di un'API.aws apigatewayv2 delete-stage \ --api-ida1b2c3d4\ --stage-nametestQuesto comando non produce alcun output.
Per ulteriori informazioni, consulta Working with stages for HTTP APIs nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta DeleteStage AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-vpc-link.
- AWS CLI
-
Per eliminare un collegamento VPC per un'API HTTP
L'
delete-vpc-linkesempio seguente elimina un link VPC.aws apigatewayv2 delete-vpc-link \ --vpc-link-idabcd123Questo comando non produce alcun output.
Per ulteriori informazioni, consulta Working with VPC links for HTTP APIs nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta DeleteVpcLink AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareexport-api.
- AWS CLI
-
Per esportare una definizione OpenAPI di un'API HTTP
L'
export-apiesempio seguente esporta una definizione OpenAPI 3.0 di uno stadio API denominatoprodin un file YAML denominato.stage-definition.yamlPer impostazione predefinita il file di definizione esportato include le estensioni API Gateway.aws apigatewayv2 export-api \ --api-ida1b2c3d4\ --output-typeYAML\ --specificationOAS30\ --stage-nameprod\stage-definition.yamlQuesto comando non produce alcun output.
Per ulteriori informazioni, consulta Esportazione di un'API HTTP da API Gateway nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta ExportApi AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareget-api-mapping.
- AWS CLI
-
Per ottenere informazioni sulla mappatura delle API per un nome di dominio personalizzato
L'
get-api-mappingesempio seguente mostra informazioni su una mappatura delle API per ilapi.example.comnome di dominio personalizzato.aws apigatewayv2 get-api-mapping \ --api-mapping-ida1b2c3\ --domain-nameapi.example.comOutput:
{ "ApiId": "a1b2c3d4", "ApiMappingId": "a1b2c3d5", "ApiMappingKey": "myTestApi" "Stage": "test" }Per ulteriori informazioni, consulta Configurazione di un nome di dominio personalizzato regionale in API Gateway nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta GetApiMapping AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareget-api-mappings.
- AWS CLI
-
Per ottenere mappature API per un nome di dominio personalizzato
L'
get-api-mappingsesempio seguente visualizza un elenco di tutte le mappature API per ilapi.example.comnome di dominio personalizzato.aws apigatewayv2 get-api-mappings \ --domain-nameapi.example.comOutput:
{ "Items": [ { "ApiId": "a1b2c3d4", "ApiMappingId": "a1b2c3d5", "ApiMappingKey": "myTestApi" "Stage": "test" }, { "ApiId": "a5b6c7d8", "ApiMappingId": "a1b2c3d6", "ApiMappingKey": "myDevApi" "Stage": "dev" }, ] }Per ulteriori informazioni, consulta Configurazione di un nome di dominio personalizzato regionale in API Gateway nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta GetApiMappings AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareget-api.
- AWS CLI
-
Per recuperare informazioni su un'API
L'
get-apiesempio seguente mostra informazioni su un'API.aws apigatewayv2 get-api \ --api-ida1b2c3d4Output:
{ "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" } }-
Per i dettagli sull'API, vedere GetApi
in AWS CLI Command Reference.
-
Il seguente esempio di codice mostra come utilizzareget-apis.
- AWS CLI
-
Per recuperare un elenco di APIs
L'
get-apisesempio seguente elenca tutti i dati APIs relativi all'utente corrente.aws apigatewayv2 get-apisOutput:
{ "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": {} } ] }Per ulteriori informazioni, consulta Working with HTTP APIs e Working with WebSocket APIs nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta GetApis AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareget-authorizer.
- AWS CLI
-
Per recuperare informazioni su un autorizzatore
L'
get-authorizeresempio seguente visualizza informazioni su un autorizzatore.aws apigatewayv2 get-authorizer \ --api-ida1b2c3d4\ --authorizer-ida1b2c3Output:
{ "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" }Per ulteriori informazioni, consulta Controllare l'accesso a HTTP APIs con gli autorizzatori JWT nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta AWS CLI Command GetAuthorizer
Reference.
-
Il seguente esempio di codice mostra come utilizzareget-authorizers.
- AWS CLI
-
Per recuperare un elenco di autorizzatori per un'API
L'
get-authorizersesempio seguente mostra un elenco di tutti gli autorizzatori per un'API.aws apigatewayv2 get-authorizers \ --api-ida1b2c3d4Output:
{ "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" } ] }Per ulteriori informazioni, consulta Controllare l'accesso a HTTP APIs con gli autorizzatori JWT nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta AWS CLI Command GetAuthorizers
Reference.
-
Il seguente esempio di codice mostra come utilizzareget-deployment.
- AWS CLI
-
Per recuperare informazioni su una distribuzione
L'
get-deploymentesempio seguente visualizza informazioni su una distribuzione.aws apigatewayv2 get-deployment \ --api-ida1b2c3d4\ --deployment-idabcdefOutput:
{ "AutoDeployed": true, "CreatedDate": "2020-04-07T23:58:40Z", "DeploymentId": "abcdef", "DeploymentStatus": "DEPLOYED", "Description": "Automatic deployment triggered by changes to the Api configuration" }Per ulteriori informazioni, consulta la pagina relativa alla distribuzione delle API nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta GetDeployment AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareget-deployments.
- AWS CLI
-
Per recuperare un elenco di distribuzioni
L'
get-deploymentsesempio seguente mostra un elenco di tutte le distribuzioni di un'API.aws apigatewayv2 get-deployments \ --api-ida1b2c3d4Output:
{ "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" } ] }Per ulteriori informazioni, consulta la pagina relativa alla distribuzione delle API nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta GetDeployments AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareget-domain-name.
- AWS CLI
-
Per recuperare informazioni su un nome di dominio personalizzato
L'
get-domain-nameesempio seguente visualizza informazioni su un nome di dominio personalizzato.aws apigatewayv2 get-domain-name \ --domain-nameapi.example.comOutput:
{ "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": {} }Per ulteriori informazioni, consulta Configurazione di un nome di dominio personalizzato regionale in API Gateway nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta GetDomainName AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareget-domain-names.
- AWS CLI
-
Per recuperare un elenco di nomi di dominio personalizzati
L'
get-domain-namesesempio seguente visualizza un elenco di tutti i nomi di dominio personalizzati per l'utente corrente.aws apigatewayv2 get-domain-namesOutput:
{ "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" } ] } ] }Per ulteriori informazioni, consulta Configurazione di un nome di dominio personalizzato regionale in API Gateway nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta GetDomainNames AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareget-integration.
- AWS CLI
-
Per recuperare informazioni su un'integrazione
L'
get-integrationesempio seguente mostra informazioni su un'integrazione.aws apigatewayv2 get-integration \ --api-ida1b2c3d4\ --integration-ida1b2c3Output:
{ "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 }Per ulteriori informazioni, consulta Configurazione delle integrazioni per HTTP APIs e Configurazione delle integrazioni WebSocket API nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta Command GetIntegration
Reference AWS CLI .
-
Il seguente esempio di codice mostra come utilizzareget-integrations.
- AWS CLI
-
Per recuperare un elenco di integrazioni
L'
get-integrationsesempio seguente mostra un elenco di tutte le integrazioni di un'API.aws apigatewayv2 get-integrations \ --api-ida1b2c3d4Output:
{ "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 } ] }Per ulteriori informazioni, consulta Configurazione delle integrazioni per HTTP APIs e Configurazione delle integrazioni WebSocket API nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta Command GetIntegrations
Reference AWS CLI .
-
Il seguente esempio di codice mostra come utilizzareget-route.
- AWS CLI
-
Per recuperare informazioni su un percorso
L'
get-routeesempio seguente visualizza informazioni su un percorso.aws apigatewayv2 get-route \ --api-ida1b2c3d4\ --route-id72jz1wkOutput:
{ "ApiKeyRequired": false, "AuthorizationType": "NONE", "RouteId": "72jz1wk", "RouteKey": "ANY /pets", "Target": "integrations/a1b2c3" }Per ulteriori informazioni, consulta Working with routes for HTTP APIs nella Amazon API Gateway Developer Guide
-
Per i dettagli sull'API, consulta GetRoute AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareget-routes.
- AWS CLI
-
Per recuperare un elenco di percorsi
L'
get-routesesempio seguente mostra un elenco di tutte le rotte di un'API.aws apigatewayv2 get-routes \ --api-ida1b2c3d4Output:
{ "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" } ] }Per ulteriori informazioni, consulta Working with routes for HTTP APIs nella Amazon API Gateway Developer Guide
-
Per i dettagli sull'API, consulta GetRoutes AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareget-routing-rule.
- AWS CLI
-
Per ottenere una regola di routing
L'
get-routing-ruleesempio seguente ottiene una regola di routing per un nome di dominio.aws apigatewayv2 get-routing-rule \ --domain-name 'regional.example.com' \ --routing-rule-idaaa111Output:
{ "Actions": [ { "InvokeApi": { "ApiId": "abcd1234", "Stage": "prod", "StripBasePath": false } } ], "Conditions": [ { "MatchBasePaths": { "AnyOf": [ "PetStoreShopper" ] } } ], "Priority": 50, "RoutingRuleArn": "arn:aws:apigateway:us-east-2:123456789012:/domainnames/regional.example.com/routingrules/aaa111", "RoutingRuleId": "aaa111" }Per ulteriori informazioni, consulta Regole di routing per connettere le fasi dell'API a un nome di dominio personalizzato per REST APIs nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta GetRoutingRule AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareget-stage.
- AWS CLI
-
Per recuperare informazioni su una fase
L'
get-stageesempio seguente mostra informazioni sulloprodstadio di un'API.aws apigatewayv2 get-stage \ --api-ida1b2c3d4\ --stage-nameprodOutput:
{ "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": {} }Per ulteriori informazioni, consulta Working with stages for HTTP APIs nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta GetStage AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareget-stages.
- AWS CLI
-
Per recuperare un elenco di fasi
L'
get-stagesesempio seguente elenca tutte le fasi di un'API.aws apigatewayv2 get-stages \ --api-ida1b2c3d4Output:
{ "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": {} } ] }Per ulteriori informazioni, consulta Working with stages for HTTP APIs nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta GetStages AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareget-tags.
- AWS CLI
-
Per recuperare un elenco di tag per una risorsa
L'
get-tagsesempio seguente elenca tutti i tag di un'API.aws apigatewayv2 get-tags \ --resource-arnarn:aws:apigateway:us-west-2::/apis/a1b2c3d4Output:
{ "Tags": { "owner": "dev-team", "environment": "prod" } }Per ulteriori informazioni, consulta Tagging your API Gateway resources nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta GetTags AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareget-vpc-link.
- AWS CLI
-
Per recuperare informazioni su un collegamento VPC
L'
get-vpc-linkesempio seguente visualizza informazioni su un collegamento VPC.aws apigatewayv2 get-vpc-link \ --vpc-link-idabcd123Output:
{ "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" }Per ulteriori informazioni, consulta Working with VPC links for HTTP APIs nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta GetVpcLink AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareget-vpc-links.
- AWS CLI
-
Per recuperare un elenco di link VPC
L'
get-vpc-linksesempio seguente visualizza un elenco di tutti i link VPC per l'utente corrente.aws apigatewayv2 get-vpc-linksOutput:
{ "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" } ] }Per ulteriori informazioni, consulta Working with VPC links for HTTP APIs nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta GetVpcLinks AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareimport-api.
- AWS CLI
-
Per importare un'API HTTP
L'
import-apiesempio seguente crea un'API HTTP da un file di definizione OpenAPI 3.0 denominato.api-definition.yamlaws apigatewayv2 import-api \ --bodyfile://api-definition.yamlContenuto di
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: INTERNETOutput:
{ "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" }Per ulteriori informazioni, consulta Lavorare con le definizioni di OpenAPI per HTTP APIs nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta ImportApi AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarelist-routing-rules.
- AWS CLI
-
Per elencare le regole di routing
L'
list-routing-rulesesempio seguente elenca le regole di routing per un nome di dominio.aws apigatewayv2 list-routing-rules \ --domain-name 'regional.example.com'Output:
{ "RoutingRules": [ { "Actions": [ { "InvokeApi": { "ApiId": "abcd1234", "Stage": "prod", "StripBasePath": false } } ], "Conditions": [ { "MatchBasePaths": { "AnyOf": [ "PetStoreShopper" ] } } ], "Priority": 150, "RoutingRuleArn": "arn:aws:apigateway:us-east-1:123456789012:/domainnames/regional.example.com/routingrules/aaa111", "RoutingRuleId": "aaa111" } ] }Per ulteriori informazioni, consulta Regole di routing per connettere le fasi dell'API a un nome di dominio personalizzato per REST APIs nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta ListRoutingRules AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareput-routing-rule.
- AWS CLI
-
Per aggiornare una regola di routing
L'
put-routing-ruleesempio seguente aggiorna la priorità di una regola di routing.aws apigatewayv2 put-routing-rule \ --domain-name 'regional.example.com' \ --priority150\ --conditions '[ \ { \ "MatchBasePaths": { \ "AnyOf": [ \ "PetStoreShopper" \ ] \ } \ } \ ]' \ --actions '[ \ { \ "InvokeApi": { \ "ApiId": "abcd1234", \ "Stage": "prod" \ } \ } \ ]'Output:
{ "Actions": [ { "InvokeApi": { "ApiId": "abcd1234", "Stage": "prod", "StripBasePath": false } } ], "Conditions": [ { "MatchBasePaths": { "AnyOf": [ "PetStoreShopper" ] } } ], "Priority": 150, "RoutingRuleArn": "arn:aws:apigateway:us-east-2:123456789012:/domainnames/regional.example.com/routingrules/aaa111", "RoutingRuleId": "aaa111" }Per ulteriori informazioni, consulta Regole di routing per connettere le fasi dell'API a un nome di dominio personalizzato per REST APIs nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta PutRoutingRule AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarereimport-api.
- AWS CLI
-
Per reimportare un'API HTTP
L'
reimport-apiesempio seguente aggiorna un'API HTTP esistente per utilizzare la definizione OpenAPI 3.0 specificata in.api-definition.yamlaws apigatewayv2 reimport-api \ --bodyfile://api-definition.yaml\ --api-ida1b2c3d4Contenuto di
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: INTERNETOutput:
{ "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" }Per ulteriori informazioni, consulta Lavorare con le definizioni di OpenAPI per HTTP APIs nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta ReimportApi AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaretag-resource.
- AWS CLI
-
Per etichettare una risorsa
L'
tag-resourceesempio seguente aggiunge un tag con il nome della chiaveDepartmente il valore diAccountingall'API specificata.aws apigatewayv2 tag-resource \ --resource-arnarn:aws:apigateway:us-west-2::/apis/a1b2c3d4\ --tagsDepartment=AccountingQuesto comando non produce alcun output.
Per ulteriori informazioni, consulta Tagging your API Gateway resources nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta TagResource AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareuntag-resource.
- AWS CLI
-
Per rimuovere i tag da una risorsa
L'
untag-resourceesempio seguente rimuove i tag con i nomi delle chiaviProjecteOwnerdall'API specificata.aws apigatewayv2 untag-resource \ --resource-arnarn:aws:apigateway:us-west-2::/apis/a1b2c3d4\ --tag-keysProjectOwnerQuesto comando non produce alcun output.
Per ulteriori informazioni, consulta Tagging your API Gateway resources nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta UntagResource AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareupdate-api-mapping.
- AWS CLI
-
Per aggiornare una mappatura delle API
L'
update-api-mappingesempio seguente modifica una mappatura API per un nome di dominio personalizzato. Di conseguenza, l'URL di base che utilizza il nome di dominio personalizzato per l'API e lo stage specificati diventahttps://api.example.com/dev.aws apigatewayv2 update-api-mapping \ --api-ida1b2c3d4\ --stagedev\ --domain-nameapi.example.com\ --api-mapping-id0qzs2sy7bh\ --api-mapping-keydevOutput:
{ "ApiId": "a1b2c3d4", "ApiMappingId": "0qzs2sy7bh", "ApiMappingKey": "dev" "Stage": "dev" }Per ulteriori informazioni, consulta Configurazione di un nome di dominio personalizzato regionale in API Gateway nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta UpdateApiMapping AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareupdate-api.
- AWS CLI
-
Per abilitare CORS per un'API HTTP
L'
update-apiesempio seguente aggiorna la configurazione CORS dell'API specificata per consentire le richieste da.https://www.example.comaws apigatewayv2 update-api \ --api-ida1b2c3d4\ --cors-configurationAllowOrigins=https://www.example.comOutput:
{ "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" }Per ulteriori informazioni, consulta Configurazione di CORS per un'API HTTP nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta AWS CLI Command UpdateApi
Reference.
-
Il seguente esempio di codice mostra come utilizzareupdate-authorizer.
- AWS CLI
-
Per aggiornare un autorizzatore
L'
update-authorizeresempio seguente modifica la fonte di identità di un autorizzatore JWT in un'intestazione denominata.Authorizationaws apigatewayv2 update-authorizer \ --api-ida1b2c3d4\ --authorizer-ida1b2c3\ --identity-source '$request.header.Authorization'Output:
{ "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" }Per ulteriori informazioni, consulta Controllare l'accesso a HTTP APIs con gli autorizzatori JWT nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta AWS CLI Command UpdateAuthorizer
Reference.
-
Il seguente esempio di codice mostra come utilizzareupdate-deployment.
- AWS CLI
-
Per modificare la descrizione di una distribuzione
L'
update-deploymentesempio seguente aggiorna la descrizione di una distribuzione.aws apigatewayv2 update-deployment \ --api-ida1b2c3d4\ --deployment-idabcdef\ --description 'Manual deployment to fix integration test failures.'Output:
{ "AutoDeployed": false, "CreatedDate": "2020-02-05T16:21:48+00:00", "DeploymentId": "abcdef", "DeploymentStatus": "DEPLOYED", "Description": "Manual deployment to fix integration test failures." }Per ulteriori informazioni, consulta la sezione Sviluppo di un'API HTTP in API Gateway nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta UpdateDeployment AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareupdate-domain-name.
- AWS CLI
-
Per aggiornare un nome di dominio personalizzato
L'
update-domain-nameesempio seguente specifica un nuovo certificato ACM per il nome di dominioapi.example.compersonalizzato.aws apigatewayv2 update-domain-name \ --domain-nameapi.example.com\ --domain-name-configurationsCertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678Output:
{ "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" } ] }Per ulteriori informazioni, consulta Configurazione di un nome di dominio personalizzato regionale in API Gateway nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta UpdateDomainName AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareupdate-integration.
- AWS CLI
-
Per aggiornare un'integrazione Lambda
L'
update-integrationesempio seguente aggiorna un'integrazione AWS Lambda esistente per utilizzare la funzione Lambda specificata.aws apigatewayv2 update-integration \ --api-ida1b2c3d4\ --integration-ida1b2c3\ --integration-uriarn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:my-new-function/invocationsOutput:
{ "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 }Per ulteriori informazioni, consulta Configurazione delle integrazioni per HTTP APIs e Configurazione delle integrazioni WebSocket API nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta Command UpdateIntegration
Reference AWS CLI .
-
Il seguente esempio di codice mostra come utilizzareupdate-route.
- AWS CLI
-
Esempio 1: per aggiornare l'integrazione di una rotta
L'
update-routeesempio seguente aggiorna l'integrazione di una rotta specificata.aws apigatewayv2 update-route \ --api-ida1b2c3d4\ --route-ida1b2c3\ --targetintegrations/a1b2c6Output:
{ "ApiKeyRequired": false, "AuthorizationType": "NONE", "RouteId": "a1b2c3", "RouteKey": "ANY /pets", "Target": "integrations/a1b2c6" }Esempio 2: aggiungere un autorizzatore a una rotta
L'
update-routeesempio seguente aggiorna il percorso specificato per utilizzare un autorizzatore JWT.aws apigatewayv2 update-route \ --api-ida1b2c3d4\ --route-ida1b2c3\ --authorization-typeJWT\ --authorizer-ida1b2c5\ --authorization-scopesuser.iduser.emailOutput:
{ "ApiKeyRequired": false, "AuthorizationScopes": [ "user.id", "user.email" ], "AuthorizationType": "JWT", "AuthorizerId": "a1b2c5", "OperationName": "GET HTTP", "RequestParameters": {}, "RouteId": "a1b2c3", "RouteKey": "GET /pets", "Target": "integrations/a1b2c6" }Per ulteriori informazioni, consulta Controllare l'accesso a HTTP APIs con gli autorizzatori JWT nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta AWS CLI Command UpdateRoute
Reference.
-
Il seguente esempio di codice mostra come utilizzareupdate-stage.
- AWS CLI
-
Per configurare un throttling personalizzato
L'
update-stageesempio seguente configura la limitazione personalizzata per la fase e il percorso specificati di un'API.aws apigatewayv2 update-stage \ --api-ida1b2c3d4\ --stage-namedev\ --route-settings '{"GET /pets":{"ThrottlingBurstLimit":100,"ThrottlingRateLimit":2000}}'Output:
{ "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": {} }Per ulteriori informazioni, consulta la sezione Protezione dell'API HTTP nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta UpdateStage AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareupdate-vpc-link.
- AWS CLI
-
Per aggiornare un link VPC
L'
update-vpc-linkesempio seguente aggiorna il nome di un link VPC. Dopo aver creato un link VPC, non puoi modificarne i gruppi di sicurezza o le sottoreti.aws apigatewayv2 update-vpc-link \ --vpc-link-idabcd123\ --nameMyUpdatedVpcLinkOutput:
{ "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" }Per ulteriori informazioni, consulta Working with VPC links for HTTP APIs nella Amazon API Gateway Developer Guide.
-
Per i dettagli sull'API, consulta UpdateVpcLink AWS CLI
Command Reference.
-