# AWS CLI を使用した API Gateway HTTP と WebSocket API の例
<a name="cli_apigatewayv2_code_examples"></a>

次のコード例は、API Gateway と WebSocket API で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。

*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。

各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。

**Topics**
+ [アクション](#actions)

## アクション
<a name="actions"></a>

### `create-api-mapping`
<a name="apigatewayv2_CreateApiMapping_cli_topic"></a>

次のコード例は、`create-api-mapping` を使用する方法を示しています。

**AWS CLI**  
**API 用に API マッピングを作成するには**  
次の `create-api-mapping` の例では、API の `test` のステージをカスタムドメイン名「`regional.example.com`」のパス「`/myApi`」にマッピングします。  

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

```
{
    "ApiId": "a1b2c3d4",
    "ApiMappingId": "0qzs2sy7bh",
    "ApiMappingKey": "myApi"
    "Stage": "test"
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway でリージョナルカスタムドメイン名を設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドレットリファレンス*」の「[CreateApiMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-api-mapping.html)」を参照してください。

### `create-api`
<a name="apigatewayv2_CreateApi_cli_topic"></a>

次のコード例は、`create-api` を使用する方法を示しています。

**AWS CLI**  
**HTTP API を作成する方法**  
次の `create-api` の例では、クイック作成を使用して HTTP API を作成します。クイック作成を使用して、AWS Lambda または HTTP 統合、デフォルトのキャッチオールルート、変更を自動的にデプロイするように設定されたデフォルトステージを持つ API を作成できます。次のコマンドは、クイック作成を使用して、Lambda 関数と統合する HTTP API を作成します。  

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

```
{
    "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"
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway での HTTP API の開発](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop.html)」を参照してください。  
**WebSocket API を作成する方法**  
次の `create-api` の例では、指定された名前の WebSocket API を作成します。  

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

```
{
    "ApiKeySelectionExpression": "$request.header.x-api-key",
    "Name": "myWebSocketApi",
    "CreatedDate": "2018-11-15T06:23:51Z",
    "ProtocolType": "WEBSOCKET",
    "RouteSelectionExpression": "'$request.body.action'",
    "ApiId": "aabbccddee"
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway での WebSocket API の作成](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-create-empty-api.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-api.html)」を参照してください。

### `create-authorizer`
<a name="apigatewayv2_CreateAuthorizer_cli_topic"></a>

次のコード例は、`create-authorizer` を使用する方法を示しています。

**AWS CLI**  
**HTTP API の JWT オーソライザーを作成する方法**  
次の `create-authorizer` の例では、Amazon Cognito を ID プロバイダーとして使用する JWT オーソライザーを作成します。  

```
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
```
出力:  

```
{
    "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"
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[JWT オーソライザーを使用した HTTP API へのアクセスの制御](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-authorizer.html)」を参照してください。

### `create-deployment`
<a name="apigatewayv2_CreateDeployment_cli_topic"></a>

次のコード例は、`create-deployment` を使用する方法を示しています。

**AWS CLI**  
**API のデプロイを作成する方法**  
次の `create-deployment` の例では、API にデプロイを作成し、API の `dev` ステージにデプロイを関連付けます。  

```
aws apigatewayv2 create-deployment \
    --api-id a1b2c3d4 \
    --stage-name dev
```
出力:  

```
{
    "AutoDeployed": false,
    "CreatedDate": "2020-04-06T23:38:08Z",
    "DeploymentId": "53lz9l",
    "DeploymentStatus": "DEPLOYED"
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API デプロイ](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-basic-concept.html#apigateway-definition-api-deployment)」を参照してください。  
+  API の詳細については、AWS CLI コマンドリファレンスの「[CreateDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-deployment.html)」を参照してください。**

### `create-domain-name`
<a name="apigatewayv2_CreateDomainName_cli_topic"></a>

次のコード例は、`create-domain-name` を使用する方法を示しています。

**AWS CLI**  
**カスタムドメイン名を作成する方法**  
次の `create-domain-name` の例では、API にリージョナルカスタムドメイン名を作成します。  

```
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
```
出力:  

```
{
    "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"
        }
    ]
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway でリージョナルカスタムドメイン名を設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDomainName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-domain-name.html)」を参照してください。

### `create-integration`
<a name="apigatewayv2_CreateIntegration_cli_topic"></a>

次のコード例は、`create-integration` を使用する方法を示しています。

**AWS CLI**  
**WebSocket API 統合を作成する方法**  
次の `create-integration` の例では、WebSocket API 用のモック統合を作成します。  

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

```
{
    "ConnectionType": "INTERNET",
    "IntegrationId": "0abcdef",
    "IntegrationResponseSelectionExpression": "${integration.response.statuscode}",
    "IntegrationType": "MOCK",
    "PassthroughBehavior": "WHEN_NO_MATCH",
    "PayloadFormatVersion": "1.0",
    "TimeoutInMillis": 29000
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway での WebSocket API 統合リクエストのセットアップ](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-requests.html)」を参照してください。  
**HTTP API カスタム統合を作成する方法**  
次の `create-integration` の例では、HTTP API の AWS Lambda 統合を作成します。  

```
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
```
出力:  

```
{
    "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
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API 統合の設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateIntegration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-integration.html)」を参照してください。

### `create-route`
<a name="apigatewayv2_CreateRoute_cli_topic"></a>

次のコード例は、`create-route` を使用する方法を示しています。

**AWS CLI**  
**WebSocket または HTTP API の \$1default ルートを作成する方法**  
次の `create-route` の例では、WebSocket または HTTP API の `$default` ルートを作成します。  

```
aws apigatewayv2 create-route \
    --api-id aabbccddee \
    --route-key '$default'
```
出力:  

```
{
    "ApiKeyRequired": false,
    "AuthorizationType": "NONE",
    "RouteKey": "$default",
    "RouteId": "1122334"
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[WebSocket API のルートの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-add-route.html)」を参照してください。  
**HTTP API のルートを作成する方法**  
次の `create-route` の例では、POST リクエストを受け入れる「`signup`」という名前のルートを作成します。  

```
aws apigatewayv2 create-route \
    --api-id aabbccddee \
    --route-key 'POST /signup'
```
出力:  

```
{
    "ApiKeyRequired": false,
    "AuthorizationType": "NONE",
    "RouteKey": "POST /signup",
    "RouteId": "1122334"
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API のルートの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-routes.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-route.html)」を参照してください。

### `create-routing-rule`
<a name="apigatewayv2_CreateRoutingRule_cli_topic"></a>

次のコード例は、`create-routing-rule` を使用する方法を示しています。

**AWS CLI**  
**ルーティングルールを作成するには**  
次の `create-routing-rule` の例では、優先度が `50` のルーティングルールを作成します。  

```
aws apigatewayv2 create-routing-rule \
    --domain-name 'regional.example.com' \
    --priority 50 \
    --conditions '[ \
        { \
            "MatchBasePaths": { \
                "AnyOf": [ \
                    "PetStoreShopper" \
                ] \
            } \
        } \
    ]' \
    --actions '[ \
        { \
            "InvokeApi": { \
                "ApiId": "abcd1234", \
                "Stage": "prod" \
            } \
        } \
    ]'
```
出力:  

```
{
    "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"
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API ステージを REST API のカスタムドメイン名に接続するためのルーティングルール](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-routing-rules.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateRoutingRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-routing-rule.html)」を参照してください。

### `create-stage`
<a name="apigatewayv2_CreateStage_cli_topic"></a>

次のコード例は、`create-stage` を使用する方法を示しています。

**AWS CLI**  
**ステージを作成する方法**  
次の `create-stage` の例では、 API に「dev」という名前のステージを作成します。  

```
aws apigatewayv2 create-stage \
    --api-id a1b2c3d4 \
    --stage-name dev
```
出力:  

```
{
    "CreatedDate": "2020-04-06T23:23:46Z",
    "DefaultRouteSettings": {
        "DetailedMetricsEnabled": false
    },
    "LastUpdatedDate": "2020-04-06T23:23:46Z",
    "RouteSettings": {},
    "StageName": "dev",
    "StageVariables": {},
    "Tags": {}
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API のルートの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-stages.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-stage.html)」を参照してください。

### `create-vpc-link`
<a name="apigatewayv2_CreateVpcLink_cli_topic"></a>

次のコード例は、`create-vpc-link` を使用する方法を示しています。

**AWS CLI**  
**HTTP API の VPC リンクを作成する方法**  
次の `create-vpc-link` の例では、HTTP API の VPC リンクを作成します。  

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

```
{
    "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"
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API の VPC リンクの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateVpcLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-vpc-link.html)」を参照してください。

### `delete-access-log-settings`
<a name="apigatewayv2_DeleteAccessLogSettings_cli_topic"></a>

次のコード例は、`delete-access-log-settings` を使用する方法を示しています。

**AWS CLI**  
**API のアクセスログ記録を無効にする方法**  
次の `delete-access-log-settings` の例では、API の `$default` ステージのアクセスログ設定を削除します。ステージのアクセスログ記録を無効にするには、そのアクセスログ設定を削除します。  

```
aws apigatewayv2 delete-access-log-settings \
    --api-id a1b2c3d4 \
    --stage-name '$default'
```
このコマンドでは何も出力されません。  
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API 記録の設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-logging.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAccessLogSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-access-log-settings.html)」を参照してください。

### `delete-api-mapping`
<a name="apigatewayv2_DeleteApiMapping_cli_topic"></a>

次のコード例は、`delete-api-mapping` を使用する方法を示しています。

**AWS CLI**  
**API マッピングを削除する方法**  
次の `delete-api-mapping` の例は、カスタムドメイン名「`api.example.com`」の API マッピングを削除します。  

```
aws apigatewayv2 delete-api-mapping \
    --api-mapping-id a1b2c3 \
    --domain-name api.example.com
```
このコマンドでは何も出力されません。  
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway でリージョナルカスタムドメイン名を設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteApiMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-api-mapping.html)」を参照してください。

### `delete-api`
<a name="apigatewayv2_DeleteApi_cli_topic"></a>

次のコード例は、`delete-api` を使用する方法を示しています。

**AWS CLI**  
**API を削除する方法**  
次の `delete-api` の例は、API を削除します。  

```
aws apigatewayv2 delete-api \
    --api-id a1b2c3d4
```
このコマンドでは何も出力されません。  
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API の使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html)」と「[WebSocket API の使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-api.html)」を参照してください。

### `delete-authorizer`
<a name="apigatewayv2_DeleteAuthorizer_cli_topic"></a>

次のコード例は、`delete-authorizer` を使用する方法を示しています。

**AWS CLI**  
**オーソライザーを削除する方法**  
次の `delete-authorizer` の例では、オーソライザーを削除します。  

```
aws apigatewayv2 delete-authorizer \
    --api-id a1b2c3d4 \
    --authorizer-id a1b2c3
```
このコマンドでは何も出力されません。  
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[JWT オーソライザーを使用した HTTP API へのアクセスの制御](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-authorizer.html)」を参照してください。

### `delete-cors-configuration`
<a name="apigatewayv2_DeleteCorsConfiguration_cli_topic"></a>

次のコード例は、`delete-cors-configuration` を使用する方法を示しています。

**AWS CLI**  
**HTTP API の CORS 構成を削除する方法**  
次の `delete-cors-configuration` の例では、CORS 構成を削除することで HTTP API の CORS を無効にします。  

```
aws apigatewayv2 delete-cors-configuration \
    --api-id a1b2c3d4
```
このコマンドでは何も出力されません。  
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API CORS の設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteCorsConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-cors-configuration.html)」を参照してください。

### `delete-deployment`
<a name="apigatewayv2_DeleteDeployment_cli_topic"></a>

次のコード例は、`delete-deployment` を使用する方法を示しています。

**AWS CLI**  
**デプロイを削除する方法**  
次の `delete-deployment` の例では、API のデプロイを削除します。  

```
aws apigatewayv2 delete-deployment \
    --api-id a1b2c3d4 \
    --deployment-id a1b2c3
```
このコマンドでは何も出力されません。  
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API デプロイ](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-basic-concept.html#apigateway-definition-api-deployment)」を参照してください。  
+  API の詳細については、 コマンドリファレンスAWS CLIの「[DeleteDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-deployment.html)」を参照してください。**

### `delete-domain-name`
<a name="apigatewayv2_DeleteDomainName_cli_topic"></a>

次のコード例では、`delete-domain-name` を使用する方法を示しています。

**AWS CLI**  
**カスタムドメイン名を削除する方法**  
次の `delete-domain-name` の例では、カスタムドメイン名を削除します。  

```
aws apigatewayv2 delete-domain-name \
    --domain-name api.example.com
```
このコマンドでは何も出力されません。  
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway でリージョナルカスタムドメイン名を設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDomainName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-domain-name.html)」を参照してください。

### `delete-integration`
<a name="apigatewayv2_DeleteIntegration_cli_topic"></a>

次のコード例は、`delete-integration` を使用する方法を示しています。

**AWS CLI**  
**統合を削除する方法**  
次の `delete-integration` の例では、API 統合を削除します。  

```
aws apigatewayv2 delete-integration \
    --api-id a1b2c3d4 \
    --integration-id a1b2c3
```
このコマンドでは何も出力されません。  
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API 統合の設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations.html)」と「[WebSocket API 統合の設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integrations.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteIntegration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-integration.html)」を参照してください。

### `delete-route-settings`
<a name="apigatewayv2_DeleteRouteSettings_cli_topic"></a>

次のコード例は、`delete-route-settings` を使用する方法を示しています。

**AWS CLI**  
**ルート設定を削除する方法**  
次の `delete-route-settings` の例では、指定されたルートのルート設定を削除します。  

```
aws apigatewayv2 delete-route-settings \
    --api-id a1b2c3d4 \
    --stage-name dev \
    --route-key 'GET /pets'
```
このコマンドでは何も出力されません。  
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API のルートの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-routes.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteRouteSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-route-settings.html)」を参照してください。

### `delete-route`
<a name="apigatewayv2_DeleteRoute_cli_topic"></a>

次のコード例は、`delete-route` を使用する方法を示しています。

**AWS CLI**  
**ルートを削除する方法**  
次の `delete-route` の例では、API ルートを削除します。  

```
aws apigatewayv2 delete-route \
    --api-id a1b2c3d4 \
    --route-id a1b2c3
```
このコマンドでは何も出力されません。  
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API のルートの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-routes.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-route.html)」を参照してください。

### `delete-routing-rule`
<a name="apigatewayv2_DeleteRoutingRule_cli_topic"></a>

次のコード例は、`delete-routing-rule` を使用する方法を示しています。

**AWS CLI**  
**ルーティングルールを削除するには**  
次の `delete-routing-rule` の例では、カスタムドメイン名のルーティングルールを削除します。  

```
aws apigatewayv2 delete-routing-rule \
    --domain-name 'regional.example.com' \
    --routing-rule-id aaa111
```
このコマンドでは何も出力されません。  
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API ステージを REST API のカスタムドメイン名に接続するためのルーティングルール](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-routing-rules.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteRoutingRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-routing-rule.html)」を参照してください。

### `delete-stage`
<a name="apigatewayv2_DeleteStage_cli_topic"></a>

次のコード例は、`delete-stage` を使用する方法を示しています。

**AWS CLI**  
**ステージを削除する方法**  
次の `delete-stage` の例では、API の `test` ステージを削除します。  

```
aws apigatewayv2 delete-stage \
    --api-id a1b2c3d4 \
    --stage-name test
```
このコマンドでは何も出力されません。  
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API のルートの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-stages.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-stage.html)」を参照してください。

### `delete-vpc-link`
<a name="apigatewayv2_DeleteVpcLink_cli_topic"></a>

次のコード例は、`delete-vpc-link` を使用する方法を示しています。

**AWS CLI**  
**HTTP API の VPC リンクを削除する方法**  
次の `delete-vpc-link` の例は、VPC リンクを削除します。  

```
aws apigatewayv2 delete-vpc-link \
    --vpc-link-id abcd123
```
このコマンドでは何も出力されません。  
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API の VPC リンクの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteVpcLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-vpc-link.html)」を参照してください。

### `export-api`
<a name="apigatewayv2_ExportApi_cli_topic"></a>

次のコード例は、`export-api` を使用する方法を示しています。

**AWS CLI**  
**HTTP API の OpenAPI 定義をエクスポートする方法**  
次の `export-api` の例は、「`prod`」という名前の API ステージの OpenAPI 3.0 定義を、 「`stage-definition.yaml`」という名前の YAML ファイルにエクスポートします。エクスポートされた定義ファイルには、デフォルトで API Gateway 拡張が含まれます。  

```
aws apigatewayv2 export-api \
    --api-id a1b2c3d4 \
    --output-type YAML \
    --specification OAS30 \
    --stage-name prod \
    stage-definition.yaml
```
このコマンドでは何も出力されません。  
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway から HTTP API のエクスポート](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-export.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ExportApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/export-api.html)」を参照してください。

### `get-api-mapping`
<a name="apigatewayv2_GetApiMapping_cli_topic"></a>

次のコード例は、`get-api-mapping` を使用する方法を示しています。

**AWS CLI**  
**カスタムドメイン名の API マッピングに関する情報を取得するには**  
次の `get-api-mapping` の例では、カスタムドメイン名「`api.example.com`」の API マッピングに関する情報を表示します。  

```
aws apigatewayv2 get-api-mapping \
    --api-mapping-id a1b2c3 \
    --domain-name api.example.com
```
出力:  

```
{
    "ApiId": "a1b2c3d4",
    "ApiMappingId": "a1b2c3d5",
    "ApiMappingKey": "myTestApi"
    "Stage": "test"
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway でリージョナルカスタムドメイン名を設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetApiMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-api-mapping.html)」を参照してください。

### `get-api-mappings`
<a name="apigatewayv2_GetApiMappings_cli_topic"></a>

次のコード例は、`get-api-mappings` を使用する方法を示しています。

**AWS CLI**  
**カスタムドメイン名の API マッピングを取得する方法**  
次の `get-api-mappings` の例では、カスタムドメイン名「`api.example.com`」の API マッピングのすべてを一覧表示します。  

```
aws apigatewayv2 get-api-mappings \
    --domain-name api.example.com
```
出力:  

```
{
    "Items": [
        {
            "ApiId": "a1b2c3d4",
            "ApiMappingId": "a1b2c3d5",
            "ApiMappingKey": "myTestApi"
            "Stage": "test"
        },
        {
            "ApiId": "a5b6c7d8",
            "ApiMappingId": "a1b2c3d6",
            "ApiMappingKey": "myDevApi"
            "Stage": "dev"
        },
    ]
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway でリージョナルカスタムドメイン名を設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetApiMappings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-api-mappings.html)」を参照してください。

### `get-api`
<a name="apigatewayv2_GetApi_cli_topic"></a>

次のコード例は、`get-api` を使用する方法を示しています。

**AWS CLI**  
**API に関する情報を取得する方法**  
以下の `get-api` の例では、API に関する情報を表示します。  

```
aws apigatewayv2 get-api \
    --api-id a1b2c3d4
```
出力:  

```
{
    "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"
    }
}
```
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-api.html)」を参照してください。

### `get-apis`
<a name="apigatewayv2_GetApis_cli_topic"></a>

次のコード例は、`get-apis` を使用する方法を示しています。

**AWS CLI**  
**API の一覧を取得する方法**  
次の `get-apis` の例では、現在のユーザーのすべての API を一覧表示します。  

```
aws apigatewayv2 get-apis
```
出力:  

```
{
    "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": {}
        }
    ]
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API の使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html)」と「[WebSocket API の使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetApis](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-apis.html)」を参照してください。

### `get-authorizer`
<a name="apigatewayv2_GetAuthorizer_cli_topic"></a>

次のコード例は、`get-authorizer` を使用する方法を示しています。

**AWS CLI**  
**オーソライザーに関する情報を取得する方法**  
以下の `get-authorizer` の例では、オーソライザーに関する情報を表示します。  

```
aws apigatewayv2 get-authorizer \
    --api-id a1b2c3d4 \
    --authorizer-id a1b2c3
```
出力:  

```
{
    "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"
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[JWT オーソライザーを使用した HTTP API へのアクセスの制御](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-authorizer.html)」を参照してください。

### `get-authorizers`
<a name="apigatewayv2_GetAuthorizers_cli_topic"></a>

次のコード例は、`get-authorizers` を使用する方法を示しています。

**AWS CLI**  
**API のオーソライザーの一覧を取得する方法**  
次の `get-authorizers` の例では、API のすべてのオーソライザーを一覧表示します。  

```
aws apigatewayv2 get-authorizers \
    --api-id a1b2c3d4
```
出力:  

```
{
    "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"
        }
    ]
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[JWT オーソライザーを使用した HTTP API へのアクセスの制御](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAuthorizers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-authorizers.html)」を参照してください。

### `get-deployment`
<a name="apigatewayv2_GetDeployment_cli_topic"></a>

次のコード例は、`get-deployment` を使用する方法を示しています。

**AWS CLI**  
**デプロイの情報を取得する方法**  
以下の `get-deployment` の例では、デプロイに関する情報を表示します。  

```
aws apigatewayv2 get-deployment \
    --api-id a1b2c3d4 \
    --deployment-id abcdef
```
出力:  

```
{
    "AutoDeployed": true,
    "CreatedDate": "2020-04-07T23:58:40Z",
    "DeploymentId": "abcdef",
    "DeploymentStatus": "DEPLOYED",
    "Description": "Automatic deployment triggered by changes to the Api configuration"
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API デプロイ](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-basic-concept.html#apigateway-definition-api-deployment)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-deployment.html)」を参照してください。

### `get-deployments`
<a name="apigatewayv2_GetDeployments_cli_topic"></a>

次のコード例は、`get-deployments` を使用する方法を示しています。

**AWS CLI**  
**デプロイの一覧を取得する方法**  
次の `get-deployments` の例では、すべての API のデプロイの一覧を表示します。  

```
aws apigatewayv2 get-deployments \
    --api-id a1b2c3d4
```
出力:  

```
{
    "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"
        }
    ]
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API デプロイ](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-basic-concept.html#apigateway-definition-api-deployment)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-deployments.html)」を参照してください。

### `get-domain-name`
<a name="apigatewayv2_GetDomainName_cli_topic"></a>

次のコード例は、`get-domain-name` を使用する方法を示しています。

**AWS CLI**  
**カスタムドメイン名に関する情報を取得する方法**  
次の `get-domain-name` の例では、カスタムドメイン名に関する情報を表示します。  

```
aws apigatewayv2 get-domain-name \
    --domain-name api.example.com
```
出力:  

```
{
    "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": {}
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway でリージョナルカスタムドメイン名を設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDomainName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-domain-name.html)」を参照してください。

### `get-domain-names`
<a name="apigatewayv2_GetDomainNames_cli_topic"></a>

次のコード例は、`get-domain-names` を使用する方法を示しています。

**AWS CLI**  
**カスタムドメイン名の一覧を取得する方法**  
次の `get-domain-names` の例では、現在のユーザーのすべてのカスタムドメイン名を一覧表示します。  

```
aws apigatewayv2 get-domain-names
```
出力:  

```
{
    "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"
                }
            ]
        }
    ]
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway でリージョナルカスタムドメイン名を設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDomainNames](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-domain-names.html)」を参照してください。

### `get-integration`
<a name="apigatewayv2_GetIntegration_cli_topic"></a>

次のコード例は、`get-integration` を使用する方法を示しています。

**AWS CLI**  
**統合に関する情報を取得する方法**  
以下の `get-integration` の例では、統合に関する情報を表示します。  

```
aws apigatewayv2 get-integration \
    --api-id a1b2c3d4 \
    --integration-id a1b2c3
```
出力:  

```
{
    "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
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API 統合の設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations.html)」と「[WebSocket API 統合の設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integrations.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetIntegration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-integration.html)」を参照してください。

### `get-integrations`
<a name="apigatewayv2_GetIntegrations_cli_topic"></a>

次のコード例は、`get-integrations` を使用する方法を示しています。

**AWS CLI**  
**統合の一覧を取得する方法**  
次の `get-integrations` の例では、すべての API の統合の一覧を表示します。  

```
aws apigatewayv2 get-integrations \
    --api-id a1b2c3d4
```
出力:  

```
{
    "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
        }
    ]
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API 統合の設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations.html)」と「[WebSocket API 統合の設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integrations.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetIntegrations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-integrations.html)」を参照してください。

### `get-route`
<a name="apigatewayv2_GetRoute_cli_topic"></a>

次のコード例は、`get-route` を使用する方法を示しています。

**AWS CLI**  
**ルートに関する情報を取得するには**  
以下の `get-route` の例では、ルートに関する情報を表示します。  

```
aws apigatewayv2 get-route \
    --api-id a1b2c3d4 \
    --route-id 72jz1wk
```
出力:  

```
{
    "ApiKeyRequired": false,
    "AuthorizationType": "NONE",
    "RouteId": "72jz1wk",
    "RouteKey": "ANY /pets",
    "Target": "integrations/a1b2c3"
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API のルートの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-routes.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-route.html)」を参照してください。

### `get-routes`
<a name="apigatewayv2_GetRoutes_cli_topic"></a>

次のコード例は、`get-routes` を使用する方法を示しています。

**AWS CLI**  
**ルートの一覧を取得する方法**  
次の `get-routes` の例では、API のすべてのルートの一覧を表示します。  

```
aws apigatewayv2 get-routes \
    --api-id a1b2c3d4
```
出力:  

```
{
    "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"
        }
    ]
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API のルートの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-routes.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRoutes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-routes.html)」を参照してください。

### `get-routing-rule`
<a name="apigatewayv2_GetRoutingRule_cli_topic"></a>

次のコード例は、`get-routing-rule` を使用する方法を示しています。

**AWS CLI**  
**ルーティングルールを取得するには**  
次の `get-routing-rule` の例では、ドメイン名のルーティングルールを取得します。  

```
aws apigatewayv2 get-routing-rule \
    --domain-name 'regional.example.com' \
    --routing-rule-id aaa111
```
出力:  

```
{
    "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"
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API ステージを REST API のカスタムドメイン名に接続するためのルーティングルール](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-routing-rules.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRoutingRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-routing-rule.html)」を参照してください。

### `get-stage`
<a name="apigatewayv2_GetStage_cli_topic"></a>

次のコード例は、`get-stage` を使用する方法を示しています。

**AWS CLI**  
**ステージに関する情報を取得するには**  
以下の `get-stage` の例では、API の `prod` ステージに関する情報を表示します。  

```
aws apigatewayv2 get-stage \
    --api-id a1b2c3d4 \
    --stage-name prod
```
出力:  

```
{
    "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": {}
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API のルートの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-stages.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-stage.html)」を参照してください。

### `get-stages`
<a name="apigatewayv2_GetStages_cli_topic"></a>

次のコード例は、`get-stages` を使用する方法を示しています。

**AWS CLI**  
**ステージの一覧を取得する方法**  
次の `get-stages` の例では、API のすべてのステージを一覧表示します。  

```
aws apigatewayv2 get-stages \
    --api-id a1b2c3d4
```
出力:  

```
{
    "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": {}
        }
    ]
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API のルートの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-stages.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetStages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-stages.html)」を参照してください。

### `get-tags`
<a name="apigatewayv2_GetTags_cli_topic"></a>

次のコード例は、`get-tags` を使用する方法を示しています。

**AWS CLI**  
**リソースのタグの一覧を取得する方法**  
次の `get-tags` の例では、API のすべてのタグを一覧表示します。  

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

```
{
    "Tags": {
        "owner": "dev-team",
        "environment": "prod"
    }
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway リソースのタグ付け](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-tagging.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-tags.html)」を参照してください。

### `get-vpc-link`
<a name="apigatewayv2_GetVpcLink_cli_topic"></a>

次のコード例は、`get-vpc-link` を使用する方法を示しています。

**AWS CLI**  
**VPC リンクに関する情報を取得する方法**  
以下の `get-vpc-link` の例では、VPC リンクに関する情報を表示します。  

```
aws apigatewayv2 get-vpc-link \
    --vpc-link-id abcd123
```
出力:  

```
{
    "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"
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API の VPC リンクの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetVpcLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-vpc-link.html)」を参照してください。

### `get-vpc-links`
<a name="apigatewayv2_GetVpcLinks_cli_topic"></a>

次のコード例は、`get-vpc-links` を使用する方法を示しています。

**AWS CLI**  
**VPC リンクの一覧を取得する方法**  
次の例 `get-vpc-links` では、現在のユーザーのすべての VPC リンクを一覧表示します。  

```
aws apigatewayv2 get-vpc-links
```
出力:  

```
{
    "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"
        }
    ]
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API の VPC リンクの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetVpcLinks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-vpc-links.html)」を参照してください。

### `import-api`
<a name="apigatewayv2_ImportApi_cli_topic"></a>

次のコード例は、`import-api` を使用する方法を示しています。

**AWS CLI**  
**HTTP API をインポートする方法**  
次の `import-api` の例では、「`api-definition.yaml`」という名前の OpenAPI 3.0 定義ファイルから HTTP API を作成します。  

```
aws apigatewayv2 import-api \
    --body file://api-definition.yaml
```
`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
```
出力:  

```
{
    "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"
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API の OpenAPI 定義の使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-open-api.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ImportApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/import-api.html)」を参照してください。

### `list-routing-rules`
<a name="apigatewayv2_ListRoutingRules_cli_topic"></a>

次のコード例は、`list-routing-rules` を使用する方法を示しています。

**AWS CLI**  
**ルーティングルールを一覧表示するには**  
次の `list-routing-rules` の例では、ドメイン名のルーティングルールを一覧表示します。  

```
aws apigatewayv2 list-routing-rules \
    --domain-name 'regional.example.com'
```
出力:  

```
{
    "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"
        }
    ]
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API ステージを REST API のカスタムドメイン名に接続するためのルーティングルール](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-routing-rules.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListRoutingRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/list-routing-rules.html)」を参照してください。

### `put-routing-rule`
<a name="apigatewayv2_PutRoutingRule_cli_topic"></a>

次のコード例は、`put-routing-rule` を使用する方法を示しています。

**AWS CLI**  
**ルーティングルールを更新するには**  
次の `put-routing-rule` の例では、ルーティングルールの優先度を更新します。  

```
aws apigatewayv2 put-routing-rule \
    --domain-name 'regional.example.com' \
    --priority 150 \
    --conditions '[ \
        { \
            "MatchBasePaths": { \
                "AnyOf": [ \
                    "PetStoreShopper" \
                ] \
            } \
        } \
    ]' \
    --actions '[ \
        { \
            "InvokeApi": { \
                "ApiId": "abcd1234", \
                "Stage": "prod" \
            } \
        } \
    ]'
```
出力:  

```
{
    "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"
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API ステージを REST API のカスタムドメイン名に接続するためのルーティングルール](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-routing-rules.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutRoutingRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/put-routing-rule.html)」を参照してください。

### `reimport-api`
<a name="apigatewayv2_ReimportApi_cli_topic"></a>

次のコード例は、`reimport-api` を使用する方法を示しています。

**AWS CLI**  
**HTTP API を再インポートする方法**  
次の `reimport-api` の例では、`api-definition.yaml` で指定された OpenAPI 3.0 定義を使用するように既存の HTTP API を更新します。  

```
aws apigatewayv2 reimport-api \
    --body file://api-definition.yaml \
    --api-id a1b2c3d4
```
`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
```
出力:  

```
{
    "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"
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API の OpenAPI 定義の使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-open-api.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ReimportApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/reimport-api.html)」を参照してください。

### `tag-resource`
<a name="apigatewayv2_TagResource_cli_topic"></a>

次のコード例は、`tag-resource` を使用する方法を示しています。

**AWS CLI**  
**リソースにタグ付けする方法**  
次の `tag-resource` の例では、指定された API に「`Department`」のキー名と「`Accounting`」の値を持つタグを追加します。  

```
aws apigatewayv2 tag-resource \
    --resource-arn arn:aws:apigateway:us-west-2::/apis/a1b2c3d4 \
    --tags Department=Accounting
```
このコマンドでは何も出力されません。  
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway リソースのタグ付け](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-tagging.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/tag-resource.html)」を参照してください。

### `untag-resource`
<a name="apigatewayv2_UntagResource_cli_topic"></a>

次のコード例は、`untag-resource` を使用する方法を示しています。

**AWS CLI**  
**リソースからタグを削除する**  
次の `untag-resource` の例では、キー名「`Project`」と「`Owner`」の含まれるタグを指定された API から削除します。  

```
aws apigatewayv2 untag-resource \
    --resource-arn arn:aws:apigateway:us-west-2::/apis/a1b2c3d4 \
    --tag-keys Project Owner
```
このコマンドでは何も出力されません。  
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway リソースのタグ付け](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-tagging.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/untag-resource.html)」を参照してください。

### `update-api-mapping`
<a name="apigatewayv2_UpdateApiMapping_cli_topic"></a>

次のコード例は、`update-api-mapping` を使用する方法を示しています。

**AWS CLI**  
**API マッピングを作成する方法**  
次の `update-api-mapping` の例では、カスタムドメイン名の API マッピングを変更します。その結果、指定された API とステージにカスタムドメイン名を使用するベース URL は `https://api.example.com/dev` になります。  

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

```
{
    "ApiId": "a1b2c3d4",
    "ApiMappingId": "0qzs2sy7bh",
    "ApiMappingKey": "dev"
    "Stage": "dev"
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway でリージョナルカスタムドメイン名を設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateApiMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-api-mapping.html)」を参照してください。

### `update-api`
<a name="apigatewayv2_UpdateApi_cli_topic"></a>

次のコード例は、`update-api` を使用する方法を示しています。

**AWS CLI**  
**HTTP API の CORS を有効にする方法**  
次の `update-api` の例では、指定された API の CORS 構成を更新して、`https://www.example.com` からのリクエストを許可します。  

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

```
{
    "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"
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API CORS の設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-api.html)」を参照してください。

### `update-authorizer`
<a name="apigatewayv2_UpdateAuthorizer_cli_topic"></a>

次のコード例は、`update-authorizer` を使用する方法を示しています。

**AWS CLI**  
**オーソライザーを更新する方法**  
次の `update-authorizer` の例では、JWT オーソライザーの ID ソースを「`Authorization`」という名前のヘッダーに変更します。  

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

```
{
    "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"
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[JWT オーソライザーを使用した HTTP API へのアクセスの制御](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-authorizer.html)」を参照してください。

### `update-deployment`
<a name="apigatewayv2_UpdateDeployment_cli_topic"></a>

次のコード例は、`update-deployment` を使用する方法を示しています。

**AWS CLI**  
**デプロイの説明を変更する方法**  
次の `update-deployment` の例では、デプロイの説明を更新します。  

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

```
{
    "AutoDeployed": false,
    "CreatedDate": "2020-02-05T16:21:48+00:00",
    "DeploymentId": "abcdef",
    "DeploymentStatus": "DEPLOYED",
    "Description": "Manual deployment to fix integration test failures."
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway での HTTP API の開発](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-deployment.html)」を参照してください。

### `update-domain-name`
<a name="apigatewayv2_UpdateDomainName_cli_topic"></a>

次のコード例は、`update-domain-name` を使用する方法を示しています。

**AWS CLI**  
**カスタムドメイン名を更新する方法**  
次の `update-domain-name` の例では、`api.example.com` カスタムドメイン名の新しい ACM 証明書を指定します。  

```
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
```
出力:  

```
{
    "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"
        }
    ]
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway でリージョナルカスタムドメイン名を設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateDomainName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-domain-name.html)」を参照してください。

### `update-integration`
<a name="apigatewayv2_UpdateIntegration_cli_topic"></a>

次のコード例は、`update-integration` を使用する方法を示しています。

**AWS CLI**  
**Lambda 統合を更新する方法**  
次の `update-integration` の例では、既存の AWS Lambda 統合を更新して、指定された Lambda 関数を使用します。  

```
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
```
出力:  

```
{
    "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
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API 統合の設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations.html)」と「[WebSocket API 統合の設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integrations.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateIntegration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-integration.html)」を参照してください。

### `update-route`
<a name="apigatewayv2_UpdateRoute_cli_topic"></a>

次のコード例は、`update-route` を使用する方法を示しています。

**AWS CLI**  
**例 1: ルートの統合を更新する方法**  
次の `update-route` の例では、指定されたルートの統合を更新します。  

```
aws apigatewayv2 update-route \
    --api-id a1b2c3d4 \
    --route-id a1b2c3 \
    --target integrations/a1b2c6
```
出力:  

```
{
    "ApiKeyRequired": false,
    "AuthorizationType": "NONE",
    "RouteId": "a1b2c3",
    "RouteKey": "ANY /pets",
    "Target": "integrations/a1b2c6"
}
```
**例 2: ルートにオーソライザーを追加する方法**  
次の `update-route` の例では、指定されたルートを更新して、JWT オーソライザーを使用します。  

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

```
{
    "ApiKeyRequired": false,
    "AuthorizationScopes": [
        "user.id",
        "user.email"
    ],
    "AuthorizationType": "JWT",
    "AuthorizerId": "a1b2c5",
    "OperationName": "GET HTTP",
    "RequestParameters": {},
    "RouteId": "a1b2c3",
    "RouteKey": "GET /pets",
    "Target": "integrations/a1b2c6"
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[JWT オーソライザーを使用した HTTP API へのアクセスの制御](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-route.html)」を参照してください。

### `update-stage`
<a name="apigatewayv2_UpdateStage_cli_topic"></a>

次のコード例は、`update-stage` を使用する方法を示しています。

**AWS CLI**  
**カスタムスロットリングを設定する方法**  
次の `update-stage` の例は、API の指定されたステージとルートのカスタムスロットリングを設定します。  

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

```
{
    "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": {}
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API の保護](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-protect.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-stage.html)」を参照してください。

### `update-vpc-link`
<a name="apigatewayv2_UpdateVpcLink_cli_topic"></a>

次のコード例は、`update-vpc-link` を使用する方法を示しています。

**AWS CLI**  
**VPC リンクを更新する方法**  
次の `update-vpc-link` 例では、VPC リンクの名前を更新します。VPC リンクを作成した後は、そのセキュリティグループまたはサブネットを変更することはできません。  

```
aws apigatewayv2 update-vpc-link \
    --vpc-link-id abcd123 \
    --name MyUpdatedVpcLink
```
出力:  

```
{
    "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"
}
```
詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API の VPC リンクの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateVpcLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-vpc-link.html)」を参照してください。