Weitere AWS SDK-Beispiele sind im GitHub Repo [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) verfügbar.
Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
# API Gateway HTTP- und WebSocket API-Beispiele mit AWS CLI
Die folgenden Codebeispiele zeigen Ihnen, wie Sie Aktionen ausführen und allgemeine Szenarien implementieren, indem Sie AWS Command Line Interface mit API Gateway HTTP und WebSocket API arbeiten.
*Aktionen* sind Codeauszüge aus größeren Programmen und müssen im Kontext ausgeführt werden. Während Aktionen Ihnen zeigen, wie Sie einzelne Service-Funktionen aufrufen, können Sie Aktionen im Kontext der zugehörigen Szenarien anzeigen.
Jedes Beispiel enthält einen Link zum vollständigen Quellcode, wo Sie Anweisungen zum Einrichten und Ausführen des Codes im Kodex finden.
**Topics**
+ [Aktionen](#actions)
## Aktionen
### `create-api-mapping`
Das folgende Codebeispiel zeigt die Verwendung`create-api-mapping`.
**AWS CLI**
**So erstellen Sie eine API-Zuweisung für eine API**
Im folgenden Beispiel für `create-api-mapping` wird die `test`-Stufe einer API dem `/myApi`-Pfad des benutzerdefinierten `regional.example.com`-Domainnamens zugeordnet.
```
aws apigatewayv2 create-api-mapping \
--domain-name regional.example.com \
--api-mapping-key myApi \
--api-id a1b2c3d4 \
--stage test
```
Ausgabe:
```
{
"ApiId": "a1b2c3d4",
"ApiMappingId": "0qzs2sy7bh",
"ApiMappingKey": "myApi"
"Stage": "test"
}
```
Weitere Informationen finden Sie unter [Einrichten eines regionalen benutzerdefinierten Domainnamens in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) im *Entwicklerhandbuch für Amazon API Gateway*.
+ Einzelheiten zur API finden Sie [CreateApiMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-api-mapping.html)in der *AWS CLI Befehlsreferenz*.
### `create-api`
Das folgende Codebeispiel zeigt die Verwendung`create-api`.
**AWS CLI**
**Um eine HTTP-API zu erstellen**
Im folgenden Beispiel für `create-api` wird eine HTTP-API mithilfe von Quick Create erstellt. Sie können Quick Create verwenden, um eine API mit einer AWS Lambda- oder HTTP-Integration, einer Standard-Catch-All-Route und einer Standardphase zu erstellen, die für die automatische Bereitstellung von Änderungen konfiguriert ist. Der folgende Befehl verwendet Quick Create, um eine HTTP-API zu erstellen, die in eine Lambda-Funktion integriert ist.
```
aws apigatewayv2 create-api \
--name my-http-api \
--protocol-type HTTP \
--target arn:aws:lambda:us-west-2:123456789012:function:my-lambda-function
```
Ausgabe:
```
{
"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"
}
```
Weitere Informationen finden Sie unter [Entwickeln einer HTTP-API in Amazon API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop.html) im *Entwicklerhandbuch für Amazon API Gateway*.
**Um eine API zu erstellen WebSocket **
Das folgende `create-api` Beispiel erstellt eine WebSocket API mit dem angegebenen Namen.
```
aws apigatewayv2 create-api \
--name "myWebSocketApi" \
--protocol-type WEBSOCKET \
--route-selection-expression '$request.body.action'
```
Ausgabe:
```
{
"ApiKeySelectionExpression": "$request.header.x-api-key",
"Name": "myWebSocketApi",
"CreatedDate": "2018-11-15T06:23:51Z",
"ProtocolType": "WEBSOCKET",
"RouteSelectionExpression": "'$request.body.action'",
"ApiId": "aabbccddee"
}
```
Weitere Informationen finden Sie unter [Create a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-create-empty-api.html) im *Amazon API Gateway Developer Guide*.
+ Einzelheiten zur API finden Sie [CreateApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-api.html)unter *AWS CLI Befehlsreferenz*.
### `create-authorizer`
Das folgende Codebeispiel zeigt die Verwendung`create-authorizer`.
**AWS CLI**
**So erstellen Sie einen JWT-Genehmiger für eine HTTP-API**
Mit dem folgenden Beispiel für `create-authorizer` wird ein JWT-Genehmiger erstellt, der Amazon Cognito als Identitätsanbieter verwendet.
```
aws apigatewayv2 create-authorizer \
--name my-jwt-authorizer \
--api-id a1b2c3d4 \
--authorizer-type JWT \
--identity-source '$request.header.Authorization' \
--jwt-configuration Audience=123456abc,Issuer=https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc123
```
Ausgabe:
```
{
"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"
}
```
Weitere Informationen finden Sie unter [Steuern des Zugriffs auf HTTP APIs mit JWT-Autorisierern](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.html) im *Amazon API Gateway* Developer Guide.
+ *Einzelheiten zur API finden Sie [CreateAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-authorizer.html)in AWS CLI der Befehlsreferenz.*
### `create-deployment`
Das folgende Codebeispiel zeigt die Verwendung`create-deployment`.
**AWS CLI**
**So erstellen Sie eine Bereitstellung für eine API**
Im folgenden Beispiel für `create-deployment` wird eine Bereitstellung für eine API erstellt und dann der `dev`-Stufe der API zugeordnet.
```
aws apigatewayv2 create-deployment \
--api-id a1b2c3d4 \
--stage-name dev
```
Ausgabe:
```
{
"AutoDeployed": false,
"CreatedDate": "2020-04-06T23:38:08Z",
"DeploymentId": "53lz9l",
"DeploymentStatus": "DEPLOYED"
}
```
Weitere Informationen finden Sie unter [API-Bereitstellung](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-basic-concept.html#apigateway-definition-api-deployment) im *Entwicklerhandbuch für Amazon API Gateway*.
+ Einzelheiten zur API finden Sie [CreateDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-deployment.html)in der *AWS CLI Befehlsreferenz*.
### `create-domain-name`
Das folgende Codebeispiel zeigt die Verwendung`create-domain-name`.
**AWS CLI**
**So erstellen Sie einen benutzerdefinierten Domainnamen**
Im folgenden Beispiel für `create-domain-name` wird ein benutzerdefinierter Domainnamen für eine API erstellt.
```
aws apigatewayv2 create-domain-name \
--domain-name regional.example.com \
--domain-name-configurations CertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678
```
Ausgabe:
```
{
"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"
}
]
}
```
Weitere Informationen finden Sie unter [Einrichten eines regionalen benutzerdefinierten Domainnamens in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) im *Entwicklerhandbuch für Amazon API Gateway*.
+ Einzelheiten zur API finden Sie [CreateDomainName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-domain-name.html)in der *AWS CLI Befehlsreferenz*.
### `create-integration`
Das folgende Codebeispiel zeigt die Verwendung`create-integration`.
**AWS CLI**
**Um eine WebSocket API-Integration zu erstellen**
Das folgende `create-integration` Beispiel erstellt eine Scheinintegration für eine WebSocket API.
```
aws apigatewayv2 create-integration \
--api-id aabbccddee \
--passthrough-behavior WHEN_NO_MATCH \
--timeout-in-millis 29000 \
--connection-type INTERNET \
--integration-type MOCK
```
Ausgabe:
```
{
"ConnectionType": "INTERNET",
"IntegrationId": "0abcdef",
"IntegrationResponseSelectionExpression": "${integration.response.statuscode}",
"IntegrationType": "MOCK",
"PassthroughBehavior": "WHEN_NO_MATCH",
"PayloadFormatVersion": "1.0",
"TimeoutInMillis": 29000
}
```
Weitere Informationen finden Sie unter [Einrichten einer WebSocket API-Integrationsanfrage in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-requests.html) im *Amazon API Gateway Developer Guide*.
**So erstellen Sie eine HTTP-API-Integration**
Das folgende `create-integration` Beispiel erstellt eine AWS Lambda-Integration für eine HTTP-API.
```
aws apigatewayv2 create-integration \
--api-id a1b2c3d4 \
--integration-type AWS_PROXY \
--integration-uri arn:aws:lambda:us-west-2:123456789012:function:my-function \
--payload-format-version 2.0
```
Ausgabe:
```
{
"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
}
```
Weitere Informationen finden Sie unter [Konfiguration von Integrationen für HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations.html) im *Amazon API Gateway Developer Guide*.
+ Einzelheiten zur API finden Sie unter [CreateIntegration AWS CLI](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-integration.html)*Befehlsreferenz.*
### `create-route`
Das folgende Codebeispiel zeigt die Verwendung`create-route`.
**AWS CLI**
**Um eine \$1default Route für eine WebSocket oder HTTP-API zu erstellen**
Das folgende `create-route` Beispiel erstellt eine `$default` Route für eine WebSocket oder HTTP-API.
```
aws apigatewayv2 create-route \
--api-id aabbccddee \
--route-key '$default'
```
Ausgabe:
```
{
"ApiKeyRequired": false,
"AuthorizationType": "NONE",
"RouteKey": "$default",
"RouteId": "1122334"
}
```
Weitere Informationen finden Sie unter [Arbeiten mit Routen für WebSocket APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-add-route.html) im *Amazon API Gateway Developer Guide*
**So erstellen Sie eine Route für eine HTTP-API**
Im folgenden Beispiel für `create-route` wird eine Route mit dem Namen `signup` erstellt, die POST-Anforderungen akzeptiert.
```
aws apigatewayv2 create-route \
--api-id aabbccddee \
--route-key 'POST /signup'
```
Ausgabe:
```
{
"ApiKeyRequired": false,
"AuthorizationType": "NONE",
"RouteKey": "POST /signup",
"RouteId": "1122334"
}
```
Weitere Informationen finden Sie unter [Working with routes for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-routes.html) im *Amazon API Gateway Developer Guide*
+ Einzelheiten zur API finden Sie [CreateRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-route.html)unter *AWS CLI Befehlsreferenz*.
### `create-routing-rule`
Das folgende Codebeispiel zeigt die Verwendung`create-routing-rule`.
**AWS CLI**
**So erstellen Sie eine Routing-Regel**
Im folgenden Beispiel für `create-routing-rule` wird eine Routing-Regel mit einer Priorität von `50` erstellt.
```
aws apigatewayv2 create-routing-rule \
--domain-name 'regional.example.com' \
--priority 50 \
--conditions '[ \
{ \
"MatchBasePaths": { \
"AnyOf": [ \
"PetStoreShopper" \
] \
} \
} \
]' \
--actions '[ \
{ \
"InvokeApi": { \
"ApiId": "abcd1234", \
"Stage": "prod" \
} \
} \
]'
```
Ausgabe:
```
{
"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"
}
```
Weitere Informationen finden Sie unter [Routing-Regeln zur Verbindung von API-Stufen mit einem benutzerdefinierten Domainnamen für REST APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-routing-rules.html) im *Amazon API Gateway Developer Guide*.
+ Einzelheiten zur API finden Sie [CreateRoutingRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-routing-rule.html)in der *AWS CLI Befehlsreferenz*.
### `create-stage`
Das folgende Codebeispiel zeigt die Verwendung`create-stage`.
**AWS CLI**
**So erstellen Sie eine Stufe**
Im folgenden Beispiel für `create-stage` wird eine Stufe mit dem Namen dev für eine API erstellt.
```
aws apigatewayv2 create-stage \
--api-id a1b2c3d4 \
--stage-name dev
```
Ausgabe:
```
{
"CreatedDate": "2020-04-06T23:23:46Z",
"DefaultRouteSettings": {
"DetailedMetricsEnabled": false
},
"LastUpdatedDate": "2020-04-06T23:23:46Z",
"RouteSettings": {},
"StageName": "dev",
"StageVariables": {},
"Tags": {}
}
```
Weitere Informationen finden Sie unter [Working with Stages for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-stages.html) im *Amazon API Gateway Developer Guide*.
+ Einzelheiten zur API finden Sie [CreateStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-stage.html)unter *AWS CLI Befehlsreferenz*.
### `create-vpc-link`
Das folgende Codebeispiel zeigt die Verwendung`create-vpc-link`.
**AWS CLI**
**So erstellen Sie einen VPC-Link für eine HTTP-API**
Im folgenden `create-vpc-link` Beispiel wird ein VPC-Link für HTTP APIs erstellt.
```
aws apigatewayv2 create-vpc-link \
--name MyVpcLink \
--subnet-ids subnet-aaaa subnet-bbbb \
--security-group-ids sg1234 sg5678
```
Ausgabe:
```
{
"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"
}
```
Weitere Informationen finden Sie unter [Arbeiten mit VPC-Links für HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html) im *Amazon API Gateway Developer Guide*.
+ Einzelheiten zur API finden Sie unter [CreateVpcLink AWS CLI](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-vpc-link.html)*Befehlsreferenz.*
### `delete-access-log-settings`
Das folgende Codebeispiel zeigt die Verwendung`delete-access-log-settings`.
**AWS CLI**
**So deaktivieren Sie Zugriffsprotokollierung für eine API**
Im folgenden Beispiel für `delete-access-log-settings` werden die Zugriffsprotokolleinstellungen für die `$default`-Stufe einer API gelöscht. Um die Zugriffsprotokollierung für eine Stufe zu deaktivieren, löschen Sie deren Zugriffsprotokolleinstellungen.
```
aws apigatewayv2 delete-access-log-settings \
--api-id a1b2c3d4 \
--stage-name '$default'
```
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter [Konfigurieren der Protokollierung für eine HTTP-API](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-logging.html) im *Entwicklerhandbuch für Amazon API Gateway*.
+ Einzelheiten zur API finden Sie [DeleteAccessLogSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-access-log-settings.html)in der *AWS CLI Befehlsreferenz*.
### `delete-api-mapping`
Das folgende Codebeispiel zeigt die Verwendung`delete-api-mapping`.
**AWS CLI**
**So löschen Sie eine API-Zuordnung**
Im folgenden Beispiel für `delete-api-mapping` wird eine API-Zuordnung für den benutzerdefinierten `api.example.com`-Domainnamen gelöscht.
```
aws apigatewayv2 delete-api-mapping \
--api-mapping-id a1b2c3 \
--domain-name api.example.com
```
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter [Einrichten eines regionalen benutzerdefinierten Domainnamens in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) im *Entwicklerhandbuch für Amazon API Gateway*.
+ Einzelheiten zur API finden Sie [DeleteApiMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-api-mapping.html)in der *AWS CLI Befehlsreferenz*.
### `delete-api`
Das folgende Codebeispiel zeigt die Verwendung`delete-api`.
**AWS CLI**
**So löschen Sie eine API**
Im folgenden Beispiel für `delete-api` wird eine API gelöscht.
```
aws apigatewayv2 delete-api \
--api-id a1b2c3d4
```
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter [Arbeiten mit HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html) und [Arbeiten mit WebSocket APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api.html) im *Amazon API Gateway Developer Guide*.
+ Einzelheiten zur API finden Sie [DeleteApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-api.html)unter *AWS CLI Befehlsreferenz*.
### `delete-authorizer`
Das folgende Codebeispiel zeigt die Verwendung`delete-authorizer`.
**AWS CLI**
**So löschen Sie einen Genehmiger**
Im folgenden Beispiel für `delete-authorizer` wird ein Genehmiger gelöscht.
```
aws apigatewayv2 delete-authorizer \
--api-id a1b2c3d4 \
--authorizer-id a1b2c3
```
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter [Steuern des Zugriffs auf HTTP APIs mit JWT-Autorisierern](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.html) im *Amazon API Gateway* Developer Guide.
+ *Einzelheiten zur API finden Sie [DeleteAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-authorizer.html)in AWS CLI der Befehlsreferenz.*
### `delete-cors-configuration`
Das folgende Codebeispiel zeigt die Verwendung`delete-cors-configuration`.
**AWS CLI**
**So löschen Sie die CORS-Konfiguration für eine HTTP-API**
Im folgenden Beispiel für `delete-cors-configuration` wird CORS für eine HTTP-API deaktiviert, indem die zugehörige CORS-Konfiguration gelöscht wird.
```
aws apigatewayv2 delete-cors-configuration \
--api-id a1b2c3d4
```
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter [Konfigurieren von CORS für eine HTTP-API](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) im *Entwicklerhandbuch für Amazon API Gateway*.
+ Einzelheiten zur API finden Sie [DeleteCorsConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-cors-configuration.html)in der *AWS CLI Befehlsreferenz*.
### `delete-deployment`
Das folgende Codebeispiel zeigt die Verwendung`delete-deployment`.
**AWS CLI**
**So löschen Sie eine Bereitstellung**
Im folgenden Beispiel für `delete-deployment` wird die Bereitstellung einer API gelöscht.
```
aws apigatewayv2 delete-deployment \
--api-id a1b2c3d4 \
--deployment-id a1b2c3
```
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter [API-Bereitstellung](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-basic-concept.html#apigateway-definition-api-deployment) im *Entwicklerhandbuch für Amazon API Gateway*.
+ Einzelheiten zur API finden Sie [DeleteDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-deployment.html)in der *AWS CLI Befehlsreferenz*.
### `delete-domain-name`
Das folgende Codebeispiel zeigt die Verwendung`delete-domain-name`.
**AWS CLI**
**So löschen Sie einen benutzerdefinierten Domainnamen**
Im folgenden Beispiel für `delete-domain-name` wird ein benutzerdefinierter Domainname gelöscht.
```
aws apigatewayv2 delete-domain-name \
--domain-name api.example.com
```
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter [Einrichten eines regionalen benutzerdefinierten Domainnamens in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) im *Entwicklerhandbuch für Amazon API Gateway*.
+ Einzelheiten zur API finden Sie [DeleteDomainName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-domain-name.html)in der *AWS CLI Befehlsreferenz*.
### `delete-integration`
Das folgende Codebeispiel zeigt die Verwendung`delete-integration`.
**AWS CLI**
**So löschen Sie eine Integration**
Im folgenden Beispiel für `delete-integration` wird eine API-Integration gelöscht.
```
aws apigatewayv2 delete-integration \
--api-id a1b2c3d4 \
--integration-id a1b2c3
```
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter [Konfiguration von Integrationen für HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations.html) und [Einrichten von WebSocket API-Integrationen](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integrations.html) im *Amazon API Gateway Developer Guide*.
+ Einzelheiten zur API finden Sie [DeleteIntegration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-integration.html)in der *AWS CLI Befehlsreferenz*.
### `delete-route-settings`
Das folgende Codebeispiel zeigt die Verwendung`delete-route-settings`.
**AWS CLI**
**So löschen Sie Routeneinstellungen**
Im folgenden Beispiel für `delete-route-settings` werden die Routeneinstellungen für die angegebene Route gelöscht.
```
aws apigatewayv2 delete-route-settings \
--api-id a1b2c3d4 \
--stage-name dev \
--route-key 'GET /pets'
```
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter [Working with routes for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-routes.html) im *Amazon API Gateway Developer Guide*.
+ Einzelheiten zur API finden Sie [DeleteRouteSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-route-settings.html)unter *AWS CLI Befehlsreferenz*.
### `delete-route`
Das folgende Codebeispiel zeigt die Verwendung`delete-route`.
**AWS CLI**
**So löschen Sie eine Route**
Im folgenden Beispiel für `delete-route` wird eine API-Route gelöscht.
```
aws apigatewayv2 delete-route \
--api-id a1b2c3d4 \
--route-id a1b2c3
```
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter [Working with routes for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-routes.html) im *Amazon API Gateway Developer Guide*.
+ Einzelheiten zur API finden Sie [DeleteRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-route.html)unter *AWS CLI Befehlsreferenz*.
### `delete-routing-rule`
Das folgende Codebeispiel zeigt die Verwendung`delete-routing-rule`.
**AWS CLI**
**So löschen Sie eine Routing-Regel**
Im folgenden Beispiel für `delete-routing-rule` wird eine Routing-Regel für einen benutzerdefinierten Domainnamen gelöscht.
```
aws apigatewayv2 delete-routing-rule \
--domain-name 'regional.example.com' \
--routing-rule-id aaa111
```
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter [Routing-Regeln zur Verbindung von API-Stufen mit einem benutzerdefinierten Domainnamen für REST APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-routing-rules.html) im *Amazon API Gateway Developer Guide*.
+ Einzelheiten zur API finden Sie [DeleteRoutingRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-routing-rule.html)in der *AWS CLI Befehlsreferenz*.
### `delete-stage`
Das folgende Codebeispiel zeigt die Verwendung`delete-stage`.
**AWS CLI**
**So löschen Sie eine Stufe**
Im folgenden Beispiel für `delete-stage` wird die `test`-Stufe einer API gelöscht.
```
aws apigatewayv2 delete-stage \
--api-id a1b2c3d4 \
--stage-name test
```
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter [Working with Stages for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-stages.html) im *Amazon API Gateway Developer Guide*.
+ Einzelheiten zur API finden Sie [DeleteStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-stage.html)unter *AWS CLI Befehlsreferenz*.
### `delete-vpc-link`
Das folgende Codebeispiel zeigt die Verwendung`delete-vpc-link`.
**AWS CLI**
**So löschen Sie einen VPC-Link für eine HTTP-API**
Im folgenden Beispiel für `delete-vpc-link` wird ein VPC-Link gelöscht.
```
aws apigatewayv2 delete-vpc-link \
--vpc-link-id abcd123
```
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter [Arbeiten mit VPC-Links für HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html) im *Amazon API Gateway Developer Guide*.
+ Einzelheiten zur API finden Sie unter [DeleteVpcLink AWS CLI](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-vpc-link.html)*Befehlsreferenz.*
### `export-api`
Das folgende Codebeispiel zeigt die Verwendung`export-api`.
**AWS CLI**
**So exportieren Sie eine OpenAPI-Definition einer HTTP-API**
Im folgenden Beispiel für `export-api` wird eine OpenAPI 3.0-Definition einer API-Stufe namens `prod` in eine YAML-Datei namens `stage-definition.yaml` exportiert. Die exportierte Definitionsdatei enthält standardmäßig API-Gateway-Erweiterungen.
```
aws apigatewayv2 export-api \
--api-id a1b2c3d4 \
--output-type YAML \
--specification OAS30 \
--stage-name prod \
stage-definition.yaml
```
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter [Exportieren einer HTTP-API aus API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-export.html) im *Entwicklerhandbuch für Amazon API Gateway*.
+ Einzelheiten zur API finden Sie [ExportApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/export-api.html)in der *AWS CLI Befehlsreferenz*.
### `get-api-mapping`
Das folgende Codebeispiel zeigt die Verwendung`get-api-mapping`.
**AWS CLI**
**So rufen Sie Informationen über eine API-Zuordnung für einen benutzerdefinierten Domainnamen ab**
Im folgenden `get-api-mapping` Beispiel werden Informationen zu einer API-Zuordnung für den `api.example.com` benutzerdefinierten Domainnamen angezeigt.
```
aws apigatewayv2 get-api-mapping \
--api-mapping-id a1b2c3 \
--domain-name api.example.com
```
Ausgabe:
```
{
"ApiId": "a1b2c3d4",
"ApiMappingId": "a1b2c3d5",
"ApiMappingKey": "myTestApi"
"Stage": "test"
}
```
Weitere Informationen finden Sie unter [Einrichten eines regionalen benutzerdefinierten Domainnamens in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) im *Entwicklerhandbuch für Amazon API Gateway*.
+ Einzelheiten zur API finden Sie [GetApiMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-api-mapping.html)unter *AWS CLI Befehlsreferenz*.
### `get-api-mappings`
Das folgende Codebeispiel zeigt die Verwendung`get-api-mappings`.
**AWS CLI**
**So rufen Sie die API-Zuordnungen für einen benutzerdefinierten Domainnamen ab**
Im folgenden Beispiel für `get-api-mappings` wird eine Liste aller API-Zuordnungen für den benutzerdefinierten `api.example.com`-Domainnamen angezeigt.
```
aws apigatewayv2 get-api-mappings \
--domain-name api.example.com
```
Ausgabe:
```
{
"Items": [
{
"ApiId": "a1b2c3d4",
"ApiMappingId": "a1b2c3d5",
"ApiMappingKey": "myTestApi"
"Stage": "test"
},
{
"ApiId": "a5b6c7d8",
"ApiMappingId": "a1b2c3d6",
"ApiMappingKey": "myDevApi"
"Stage": "dev"
},
]
}
```
Weitere Informationen finden Sie unter [Einrichten eines regionalen benutzerdefinierten Domainnamens in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) im *Entwicklerhandbuch für Amazon API Gateway*.
+ Einzelheiten zur API finden Sie [GetApiMappings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-api-mappings.html)in der *AWS CLI Befehlsreferenz*.
### `get-api`
Das folgende Codebeispiel zeigt die Verwendung`get-api`.
**AWS CLI**
**So rufen Sie Informationen über eine API ab**
Im folgenden Beispiel für `get-api` werden Informationen über eine API angezeigt.
```
aws apigatewayv2 get-api \
--api-id a1b2c3d4
```
Ausgabe:
```
{
"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"
}
}
```
+ Einzelheiten zur API finden Sie [GetApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-api.html)in der *AWS CLI Befehlsreferenz*.
### `get-apis`
Das folgende Codebeispiel zeigt die Verwendung`get-apis`.
**AWS CLI**
**Um eine Liste von abzurufen APIs**
Das folgende `get-apis` Beispiel listet alle APIs für den aktuellen Benutzer auf.
```
aws apigatewayv2 get-apis
```
Ausgabe:
```
{
"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": {}
}
]
}
```
Weitere Informationen finden Sie unter [Arbeiten mit HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html) und [Arbeiten mit WebSocket APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api.html) im *Amazon API Gateway Developer Guide*.
+ Einzelheiten zur API finden Sie [GetApis](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-apis.html)unter *AWS CLI Befehlsreferenz*.
### `get-authorizer`
Das folgende Codebeispiel zeigt die Verwendung`get-authorizer`.
**AWS CLI**
**So rufen Sie Informationen über einen Genehmiger ab**
Im folgenden Beispiel für `get-authorizer` werden Informationen über einen Genehmiger angezeigt.
```
aws apigatewayv2 get-authorizer \
--api-id a1b2c3d4 \
--authorizer-id a1b2c3
```
Ausgabe:
```
{
"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"
}
```
Weitere Informationen finden Sie unter [Steuern des Zugriffs auf HTTP APIs mit JWT-Autorisierern](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.html) im *Amazon API Gateway* Developer Guide.
+ *Einzelheiten zur API finden Sie [GetAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-authorizer.html)in AWS CLI der Befehlsreferenz.*
### `get-authorizers`
Das folgende Codebeispiel zeigt die Verwendung`get-authorizers`.
**AWS CLI**
**So rufen Sie eine Liste von Genehmigern für eine API ab**
Im folgenden Beispiel für `get-authorizers` wird eine Liste aller Genehmiger für eine API angezeigt.
```
aws apigatewayv2 get-authorizers \
--api-id a1b2c3d4
```
Ausgabe:
```
{
"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"
}
]
}
```
Weitere Informationen finden Sie unter [Steuern des Zugriffs auf HTTP APIs mit JWT-Autorisierern](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.html) im *Amazon API Gateway* Developer Guide.
+ *Einzelheiten zur API finden Sie [GetAuthorizers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-authorizers.html)in AWS CLI der Befehlsreferenz.*
### `get-deployment`
Das folgende Codebeispiel zeigt die Verwendung`get-deployment`.
**AWS CLI**
**So rufen Sie Informationen über eine Bereitstellung ab**
Im folgenden Beispiel für `get-deployment` werden Informationen über eine Bereitstellung angezeigt.
```
aws apigatewayv2 get-deployment \
--api-id a1b2c3d4 \
--deployment-id abcdef
```
Ausgabe:
```
{
"AutoDeployed": true,
"CreatedDate": "2020-04-07T23:58:40Z",
"DeploymentId": "abcdef",
"DeploymentStatus": "DEPLOYED",
"Description": "Automatic deployment triggered by changes to the Api configuration"
}
```
Weitere Informationen finden Sie unter [API-Bereitstellung](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-basic-concept.html#apigateway-definition-api-deployment) im *Entwicklerhandbuch für Amazon API Gateway*.
+ Einzelheiten zur API finden Sie [GetDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-deployment.html)in der *AWS CLI Befehlsreferenz*.
### `get-deployments`
Das folgende Codebeispiel zeigt die Verwendung`get-deployments`.
**AWS CLI**
**So rufen Sie eine Liste der Bereitstellungen ab**
Im folgenden Beispiel für `get-deployments` wird eine Liste aller Bereitstellungen einer API angezeigt.
```
aws apigatewayv2 get-deployments \
--api-id a1b2c3d4
```
Ausgabe:
```
{
"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"
}
]
}
```
Weitere Informationen finden Sie unter [API-Bereitstellung](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-basic-concept.html#apigateway-definition-api-deployment) im *Entwicklerhandbuch für Amazon API Gateway*.
+ Einzelheiten zur API finden Sie [GetDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-deployments.html)in der *AWS CLI Befehlsreferenz*.
### `get-domain-name`
Das folgende Codebeispiel zeigt die Verwendung`get-domain-name`.
**AWS CLI**
**So rufen Sie Informationen über einen benutzerdefinierten Domainnamen ab**
Im folgenden Beispiel für `get-domain-name` werden Informationen über einen benutzerdefinierten Domainnamen angezeigt.
```
aws apigatewayv2 get-domain-name \
--domain-name api.example.com
```
Ausgabe:
```
{
"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": {}
}
```
Weitere Informationen finden Sie unter [Einrichten eines regionalen benutzerdefinierten Domainnamens in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) im *Entwicklerhandbuch für Amazon API Gateway*.
+ Einzelheiten zur API finden Sie [GetDomainName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-domain-name.html)in der *AWS CLI Befehlsreferenz*.
### `get-domain-names`
Das folgende Codebeispiel zeigt die Verwendung`get-domain-names`.
**AWS CLI**
**So rufen Sie eine Liste der benutzerdefinierten Domainnamen ab**
Im folgenden Beispiel für `get-domain-names` wird eine Liste aller benutzerdefinierten Domainnamen für den aktuellen Benutzer angezeigt.
```
aws apigatewayv2 get-domain-names
```
Ausgabe:
```
{
"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"
}
]
}
]
}
```
Weitere Informationen finden Sie unter [Einrichten eines regionalen benutzerdefinierten Domainnamens in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) im *Entwicklerhandbuch für Amazon API Gateway*.
+ Einzelheiten zur API finden Sie [GetDomainNames](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-domain-names.html)in der *AWS CLI Befehlsreferenz*.
### `get-integration`
Das folgende Codebeispiel zeigt die Verwendung`get-integration`.
**AWS CLI**
**So rufen Sie Informationen über eine Integration ab**
Im folgenden Beispiel für `get-integration` werden Informationen über eine Integration angezeigt.
```
aws apigatewayv2 get-integration \
--api-id a1b2c3d4 \
--integration-id a1b2c3
```
Ausgabe:
```
{
"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
}
```
Weitere Informationen finden Sie unter [Konfiguration von Integrationen für HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations.html) und [Einrichten von WebSocket API-Integrationen](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integrations.html) im *Amazon API Gateway Developer Guide*.
+ Einzelheiten zur API finden Sie [GetIntegration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-integration.html)in der *AWS CLI Befehlsreferenz*.
### `get-integrations`
Das folgende Codebeispiel zeigt die Verwendung`get-integrations`.
**AWS CLI**
**So rufen Sie eine Liste der Integrationen ab**
Im folgenden Beispiel für `get-integrations` wird eine Liste aller Integrationen einer API angezeigt.
```
aws apigatewayv2 get-integrations \
--api-id a1b2c3d4
```
Ausgabe:
```
{
"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
}
]
}
```
Weitere Informationen finden Sie unter [Konfiguration von Integrationen für HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations.html) und [Einrichten von WebSocket API-Integrationen](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integrations.html) im *Amazon API Gateway Developer Guide*.
+ Einzelheiten zur API finden Sie [GetIntegrations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-integrations.html)in der *AWS CLI Befehlsreferenz*.
### `get-route`
Das folgende Codebeispiel zeigt die Verwendung`get-route`.
**AWS CLI**
**So rufen Sie Informationen über eine Route ab**
Im folgenden Beispiel für `get-route` werden Informationen über eine Route angezeigt.
```
aws apigatewayv2 get-route \
--api-id a1b2c3d4 \
--route-id 72jz1wk
```
Ausgabe:
```
{
"ApiKeyRequired": false,
"AuthorizationType": "NONE",
"RouteId": "72jz1wk",
"RouteKey": "ANY /pets",
"Target": "integrations/a1b2c3"
}
```
Weitere Informationen finden Sie unter [Working with routes for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-routes.html) im *Amazon API Gateway Developer Guide*
+ Einzelheiten zur API finden Sie [GetRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-route.html)unter *AWS CLI Befehlsreferenz*.
### `get-routes`
Das folgende Codebeispiel zeigt die Verwendung`get-routes`.
**AWS CLI**
**So rufen Sie eine Liste der Routen ab**
Im folgenden Beispiel für `get-routes` wird eine Liste aller Routen einer API angezeigt.
```
aws apigatewayv2 get-routes \
--api-id a1b2c3d4
```
Ausgabe:
```
{
"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"
}
]
}
```
Weitere Informationen finden Sie unter [Working with routes for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-routes.html) im *Amazon API Gateway Developer Guide*
+ Einzelheiten zur API finden Sie [GetRoutes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-routes.html)unter *AWS CLI Befehlsreferenz*.
### `get-routing-rule`
Das folgende Codebeispiel zeigt die Verwendung`get-routing-rule`.
**AWS CLI**
**So rufen Sie eine Routing-Regel ab**
Im folgenden Beispiel für `get-routing-rule` wird eine Routing-Regel für einen Domainnamen abgerufen.
```
aws apigatewayv2 get-routing-rule \
--domain-name 'regional.example.com' \
--routing-rule-id aaa111
```
Ausgabe:
```
{
"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"
}
```
Weitere Informationen finden Sie unter [Routing-Regeln zur Verbindung von API-Stufen mit einem benutzerdefinierten Domainnamen für REST APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-routing-rules.html) im *Amazon API Gateway Developer Guide*.
+ Einzelheiten zur API finden Sie [GetRoutingRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-routing-rule.html)in der *AWS CLI Befehlsreferenz*.
### `get-stage`
Das folgende Codebeispiel zeigt die Verwendung`get-stage`.
**AWS CLI**
**So rufen Sie Informationen zu einer Stufe ab**
Im folgenden Beispiel für `get-stage` werden Informationen über die `prod`-Stufe einer API angezeigt.
```
aws apigatewayv2 get-stage \
--api-id a1b2c3d4 \
--stage-name prod
```
Ausgabe:
```
{
"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": {}
}
```
Weitere Informationen finden Sie unter [Working with Stages for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-stages.html) im *Amazon API Gateway Developer Guide*.
+ Einzelheiten zur API finden Sie [GetStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-stage.html)unter *AWS CLI Befehlsreferenz*.
### `get-stages`
Das folgende Codebeispiel zeigt die Verwendung`get-stages`.
**AWS CLI**
**So rufen Sie eine Liste von Stufen ab**
Im folgenden Beispiel für `get-stages` werden alle Stufen einer API aufgelistet.
```
aws apigatewayv2 get-stages \
--api-id a1b2c3d4
```
Ausgabe:
```
{
"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": {}
}
]
}
```
Weitere Informationen finden Sie unter [Working with Stages for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-stages.html) im *Amazon API Gateway Developer Guide*.
+ Einzelheiten zur API finden Sie [GetStages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-stages.html)unter *AWS CLI Befehlsreferenz*.
### `get-tags`
Das folgende Codebeispiel zeigt die Verwendung`get-tags`.
**AWS CLI**
**So rufen Sie eine Liste der Tags für eine Ressource ab**
Im folgenden Beispiel für `get-tags` werden alle Tags einer API aufgelistet.
```
aws apigatewayv2 get-tags \
--resource-arn arn:aws:apigateway:us-west-2::/apis/a1b2c3d4
```
Ausgabe:
```
{
"Tags": {
"owner": "dev-team",
"environment": "prod"
}
}
```
Weitere Informationen finden Sie unter [Taggen Ihrer API-Gateway-Ressourcen](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-tagging.html) im *Entwicklerhandbuch für Amazon API Gateway*.
+ Einzelheiten zur API finden Sie [GetTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-tags.html)in der *AWS CLI Befehlsreferenz*.
### `get-vpc-link`
Das folgende Codebeispiel zeigt die Verwendung`get-vpc-link`.
**AWS CLI**
**So rufen Sie Informationen über einen VPC-Link ab**
Im folgenden Beispiel für `get-vpc-link` werden Informationen über einen VPC-Link angezeigt.
```
aws apigatewayv2 get-vpc-link \
--vpc-link-id abcd123
```
Ausgabe:
```
{
"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"
}
```
Weitere Informationen finden Sie unter [Arbeiten mit VPC-Links für HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html) im *Amazon API Gateway Developer Guide*.
+ Einzelheiten zur API finden Sie unter [GetVpcLink AWS CLI](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-vpc-link.html)*Befehlsreferenz.*
### `get-vpc-links`
Das folgende Codebeispiel zeigt die Verwendung`get-vpc-links`.
**AWS CLI**
**So rufen Sie eine Liste der VPC-Links ab**
Im folgenden Beispiel für `get-vpc-links` wird eine Liste aller VPC-Links für den aktuellen Benutzer angezeigt.
```
aws apigatewayv2 get-vpc-links
```
Ausgabe:
```
{
"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"
}
]
}
```
Weitere Informationen finden Sie unter [Arbeiten mit VPC-Links für HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html) im *Amazon API Gateway Developer Guide*.
+ Einzelheiten zur API finden Sie unter [GetVpcLinks AWS CLI](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-vpc-links.html)*Befehlsreferenz.*
### `import-api`
Das folgende Codebeispiel zeigt die Verwendung`import-api`.
**AWS CLI**
**So importieren Sie eine HTTP-API**
Im folgenden Beispiel für `import-api` wird eine HTTP-API aus einer OpenAPI 3.0-Definitionsdatei namens `api-definition.yaml` erstellt.
```
aws apigatewayv2 import-api \
--body file://api-definition.yaml
```
Inhalt von `api-definition.yaml`:
```
openapi: 3.0.1
info:
title: My Lambda API
version: v1.0
paths:
/hello:
x-amazon-apigateway-any-method:
x-amazon-apigateway-integration:
payloadFormatVersion: 2.0
type: aws_proxy
httpMethod: POST
uri: arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:hello/invocations
connectionType: INTERNET
```
Ausgabe:
```
{
"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"
}
```
Weitere Informationen finden Sie unter [Arbeiten mit OpenAPI-Definitionen für HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-open-api.html) im *Amazon API Gateway Developer Guide*.
+ Einzelheiten zur API finden Sie unter [ImportApi AWS CLI](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/import-api.html)*Befehlsreferenz.*
### `list-routing-rules`
Das folgende Codebeispiel zeigt die Verwendung`list-routing-rules`.
**AWS CLI**
**So listen Sie Routing-Regeln auf**
Im folgenden Beispiel für `list-routing-rules` werden die Routing-Regel für einen Domainnamen aufgelistet.
```
aws apigatewayv2 list-routing-rules \
--domain-name 'regional.example.com'
```
Ausgabe:
```
{
"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"
}
]
}
```
Weitere Informationen finden Sie unter [Routing-Regeln zur Verbindung von API-Stufen mit einem benutzerdefinierten Domainnamen für REST APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-routing-rules.html) im *Amazon API Gateway Developer Guide*.
+ Einzelheiten zur API finden Sie [ListRoutingRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/list-routing-rules.html)in der *AWS CLI Befehlsreferenz*.
### `put-routing-rule`
Das folgende Codebeispiel zeigt die Verwendung`put-routing-rule`.
**AWS CLI**
**So aktualisieren Sie eine Routing-Regel**
Im folgenden Beispiel für `put-routing-rule` wird die Priorität einer Routing-Regel aktualisiert.
```
aws apigatewayv2 put-routing-rule \
--domain-name 'regional.example.com' \
--priority 150 \
--conditions '[ \
{ \
"MatchBasePaths": { \
"AnyOf": [ \
"PetStoreShopper" \
] \
} \
} \
]' \
--actions '[ \
{ \
"InvokeApi": { \
"ApiId": "abcd1234", \
"Stage": "prod" \
} \
} \
]'
```
Ausgabe:
```
{
"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"
}
```
Weitere Informationen finden Sie unter [Routing-Regeln zur Verbindung von API-Stufen mit einem benutzerdefinierten Domainnamen für REST APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-routing-rules.html) im *Amazon API Gateway Developer Guide*.
+ Einzelheiten zur API finden Sie [PutRoutingRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/put-routing-rule.html)in der *AWS CLI Befehlsreferenz*.
### `reimport-api`
Das folgende Codebeispiel zeigt die Verwendung`reimport-api`.
**AWS CLI**
**So importieren Sie eine HTTP-API erneut**
Im folgenden Beispiel für `reimport-api` wird eine bestehende HTTP-API so aktualisiert, dass sie die in `api-definition.yaml` angegebene OpenAPI 3.0-Definition verwendet.
```
aws apigatewayv2 reimport-api \
--body file://api-definition.yaml \
--api-id a1b2c3d4
```
Inhalt von `api-definition.yaml`:
```
openapi: 3.0.1
info:
title: My Lambda API
version: v1.0
paths:
/hello:
x-amazon-apigateway-any-method:
x-amazon-apigateway-integration:
payloadFormatVersion: 2.0
type: aws_proxy
httpMethod: POST
uri: arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:12356789012:function:hello/invocations
connectionType: INTERNET
```
Ausgabe:
```
{
"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"
}
```
Weitere Informationen finden Sie unter [Arbeiten mit OpenAPI-Definitionen für HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-open-api.html) im *Amazon API Gateway Developer Guide*.
+ Einzelheiten zur API finden Sie unter [ReimportApi AWS CLI](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/reimport-api.html)*Befehlsreferenz.*
### `tag-resource`
Das folgende Codebeispiel zeigt die Verwendung`tag-resource`.
**AWS CLI**
**So taggen Sie eine Ressource**
Im folgenden Beispiel für `tag-resource` wird ein Tag mit dem Schlüsselnamen `Department` und einem Wert von `Accounting` zur angegebenen API hinzugefügt.
```
aws apigatewayv2 tag-resource \
--resource-arn arn:aws:apigateway:us-west-2::/apis/a1b2c3d4 \
--tags Department=Accounting
```
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter [Taggen Ihrer API-Gateway-Ressourcen](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-tagging.html) im *Entwicklerhandbuch für Amazon API Gateway*.
+ Einzelheiten zur API finden Sie [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/tag-resource.html)in der *AWS CLI Befehlsreferenz*.
### `untag-resource`
Das folgende Codebeispiel zeigt die Verwendung`untag-resource`.
**AWS CLI**
**So entfernen Sie Tags aus einer Ressource**
Im folgenden Beispiel für `untag-resource` werden Tags mit den Schlüsselnamen `Project` und `Owner` aus der angegebenen API entfernt.
```
aws apigatewayv2 untag-resource \
--resource-arn arn:aws:apigateway:us-west-2::/apis/a1b2c3d4 \
--tag-keys Project Owner
```
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter [Taggen Ihrer API-Gateway-Ressourcen](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-tagging.html) im *Entwicklerhandbuch für Amazon API Gateway*.
+ Einzelheiten zur API finden Sie [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/untag-resource.html)in der *AWS CLI Befehlsreferenz*.
### `update-api-mapping`
Das folgende Codebeispiel zeigt die Verwendung`update-api-mapping`.
**AWS CLI**
**So aktualisieren Sie eine API-Zuordnung**
Im folgenden Beispiel für `update-api-mapping` wird eine API-Zuordnung für einen benutzerdefinierten Domainnamen geändert. Dies hat zur Folge, dass die Basis-URL bei Verwendung des benutzerdefinierten Domainnamens für die angegebene API und Stufe zu `https://api.example.com/dev` wird.
```
aws apigatewayv2 update-api-mapping \
--api-id a1b2c3d4 \
--stage dev \
--domain-name api.example.com \
--api-mapping-id 0qzs2sy7bh \
--api-mapping-key dev
```
Ausgabe:
```
{
"ApiId": "a1b2c3d4",
"ApiMappingId": "0qzs2sy7bh",
"ApiMappingKey": "dev"
"Stage": "dev"
}
```
Weitere Informationen finden Sie unter [Einrichten eines regionalen benutzerdefinierten Domainnamens in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) im *Entwicklerhandbuch für Amazon API Gateway*.
+ Einzelheiten zur API finden Sie [UpdateApiMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-api-mapping.html)in der *AWS CLI Befehlsreferenz*.
### `update-api`
Das folgende Codebeispiel zeigt die Verwendung`update-api`.
**AWS CLI**
**So aktivieren Sie CORS für eine HTTP-API**
Im folgenden Beispiel für `update-api` wird die CORS-Konfiguration der angegebenen API aktualisiert, sodass Anforderungen von `https://www.example.com` zugelassen sind.
```
aws apigatewayv2 update-api \
--api-id a1b2c3d4 \
--cors-configuration AllowOrigins=https://www.example.com
```
Ausgabe:
```
{
"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"
}
```
Weitere Informationen finden Sie unter [Konfigurieren von CORS für eine HTTP-API](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) im *Entwicklerhandbuch für Amazon API Gateway*.
+ Einzelheiten zur API finden Sie [UpdateApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-api.html)in der *AWS CLI Befehlsreferenz*.
### `update-authorizer`
Das folgende Codebeispiel zeigt die Verwendung`update-authorizer`.
**AWS CLI**
**So aktualisieren Sie einen Genehmiger**
Im folgenden Beispiel für `update-authorizer` wird die Identitätsquelle eines JWT-Genehmigers in einen Header mit dem Namen `Authorization` geändert.
```
aws apigatewayv2 update-authorizer \
--api-id a1b2c3d4 \
--authorizer-id a1b2c3 \
--identity-source '$request.header.Authorization'
```
Ausgabe:
```
{
"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"
}
```
Weitere Informationen finden Sie unter [Steuern des Zugriffs auf HTTP APIs mit JWT-Autorisierern](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.html) im *Amazon API Gateway* Developer Guide.
+ *Einzelheiten zur API finden Sie [UpdateAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-authorizer.html)in AWS CLI der Befehlsreferenz.*
### `update-deployment`
Das folgende Codebeispiel zeigt die Verwendung`update-deployment`.
**AWS CLI**
**So ändern Sie die Beschreibung einer Bereitstellung**
Im folgenden Beispiel für `update-deployment` wird die Beschreibung einer Bereitstellung aktualisiert.
```
aws apigatewayv2 update-deployment \
--api-id a1b2c3d4 \
--deployment-id abcdef \
--description 'Manual deployment to fix integration test failures.'
```
Ausgabe:
```
{
"AutoDeployed": false,
"CreatedDate": "2020-02-05T16:21:48+00:00",
"DeploymentId": "abcdef",
"DeploymentStatus": "DEPLOYED",
"Description": "Manual deployment to fix integration test failures."
}
```
Weitere Informationen finden Sie unter [Entwickeln einer HTTP-API in Amazon API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop.html) im *Entwicklerhandbuch für Amazon API Gateway*.
+ Einzelheiten zur API finden Sie [UpdateDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-deployment.html)in der *AWS CLI Befehlsreferenz*.
### `update-domain-name`
Das folgende Codebeispiel zeigt die Verwendung`update-domain-name`.
**AWS CLI**
**So aktualisieren den Namen einer benutzerdefinierte Domain**
Im folgenden Beispiel für `update-domain-name` wird ein neues ACM-Zertifikat für den benutzerdefinierten `api.example.com`-Domainnamen angegeben.
```
aws apigatewayv2 update-domain-name \
--domain-name api.example.com \
--domain-name-configurations CertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678
```
Ausgabe:
```
{
"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"
}
]
}
```
Weitere Informationen finden Sie unter [Einrichten eines regionalen benutzerdefinierten Domainnamens in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) im *Entwicklerhandbuch für Amazon API Gateway*.
+ Einzelheiten zur API finden Sie [UpdateDomainName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-domain-name.html)in der *AWS CLI Befehlsreferenz*.
### `update-integration`
Das folgende Codebeispiel zeigt die Verwendung`update-integration`.
**AWS CLI**
**So aktualisieren Sie eine Lambda-Integration**
Im folgenden `update-integration` Beispiel wird eine bestehende AWS Lambda-Integration aktualisiert, sodass sie die angegebene Lambda-Funktion verwendet.
```
aws apigatewayv2 update-integration \
--api-id a1b2c3d4 \
--integration-id a1b2c3 \
--integration-uri arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:my-new-function/invocations
```
Ausgabe:
```
{
"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
}
```
Weitere Informationen finden Sie unter [Konfiguration von Integrationen für HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations.html) und [Einrichten von WebSocket API-Integrationen](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integrations.html) im *Amazon API Gateway Developer Guide*.
+ Einzelheiten zur API finden Sie [UpdateIntegration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-integration.html)in der *AWS CLI Befehlsreferenz*.
### `update-route`
Das folgende Codebeispiel zeigt die Verwendung`update-route`.
**AWS CLI**
**Beispiel 1: So aktualisieren Sie die Integration einer Route**
Im folgenden Beispiel für `update-route` wird die Integration einer angegebenen Route aktualisiert.
```
aws apigatewayv2 update-route \
--api-id a1b2c3d4 \
--route-id a1b2c3 \
--target integrations/a1b2c6
```
Ausgabe:
```
{
"ApiKeyRequired": false,
"AuthorizationType": "NONE",
"RouteId": "a1b2c3",
"RouteKey": "ANY /pets",
"Target": "integrations/a1b2c6"
}
```
**Beispiel 2: So fügen Sie einer Route einen Genehmiger hinzu**
Im folgenden Beispiel für `update-route` wird die angegebene Route so aktualisiert, dass sie einen JWT-Genehmiger verwendet.
```
aws apigatewayv2 update-route \
--api-id a1b2c3d4 \
--route-id a1b2c3 \
--authorization-type JWT \
--authorizer-id a1b2c5 \
--authorization-scopes user.id user.email
```
Ausgabe:
```
{
"ApiKeyRequired": false,
"AuthorizationScopes": [
"user.id",
"user.email"
],
"AuthorizationType": "JWT",
"AuthorizerId": "a1b2c5",
"OperationName": "GET HTTP",
"RequestParameters": {},
"RouteId": "a1b2c3",
"RouteKey": "GET /pets",
"Target": "integrations/a1b2c6"
}
```
Weitere Informationen finden Sie unter [Steuern des Zugriffs auf HTTP APIs mit JWT-Autorisierern](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.html) im *Amazon API Gateway* Developer Guide.
+ *Einzelheiten zur API finden Sie [UpdateRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-route.html)in AWS CLI der Befehlsreferenz.*
### `update-stage`
Das folgende Codebeispiel zeigt die Verwendung`update-stage`.
**AWS CLI**
**So konfigurieren Sie eine benutzerdefinierte Drosselung**
Im folgenden Beispiel für `update-stage` wird die benutzerdefinierte Drosselung für die angegebene Stufe und Route einer API konfiguriert.
```
aws apigatewayv2 update-stage \
--api-id a1b2c3d4 \
--stage-name dev \
--route-settings '{"GET /pets":{"ThrottlingBurstLimit":100,"ThrottlingRateLimit":2000}}'
```
Ausgabe:
```
{
"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": {}
}
```
Weitere Informationen finden Sie unter [Schützen Ihrer HTTP-API](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-protect.html) im *Entwicklerhandbuch für Amazon API Gateway*.
+ Einzelheiten zur API finden Sie [UpdateStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-stage.html)in der *AWS CLI Befehlsreferenz*.
### `update-vpc-link`
Das folgende Codebeispiel zeigt die Verwendung`update-vpc-link`.
**AWS CLI**
**So aktualisieren Sie einen VPC-Link**
Im folgenden Beispiel für `update-vpc-link` wird der Name eines VPC-Links aktualisiert. Nachdem Sie einen VPC-Link erstellt haben, können Sie seine Sicherheitsgruppen oder Subnetze nicht ändern.
```
aws apigatewayv2 update-vpc-link \
--vpc-link-id abcd123 \
--name MyUpdatedVpcLink
```
Ausgabe:
```
{
"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"
}
```
Weitere Informationen finden Sie unter [Arbeiten mit VPC-Links für HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html) im *Amazon API Gateway Developer Guide*.
+ Einzelheiten zur API finden Sie unter [UpdateVpcLink AWS CLI](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-vpc-link.html)*Befehlsreferenz.*