API を使用したゲートウェイHTTPと WebSocket API例 AWS CLI

のAPIマッピングを作成するには API

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

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 でのリージョンカスタムドメイン名の設定」を参照してください。

を作成するには HTTP API

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

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 デベロッパーガイド」の「APIGateway HTTPAPIでの の開発」を参照してください。

を作成するには 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 Gateway デベロッパーガイド」の WebSocket APIAPI「ゲートウェイで を作成する」を参照してください。 API

のオーJWTソライザーを作成するには HTTP API

次の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「オーソライザーHTTPAPIsによる へのアクセスの制御」を参照してください。

のデプロイを作成するには API

次のcreate-deployment例では、 のデプロイを作成しAPI、そのデプロイを のdevステージに関連付けますAPI。

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「デプロイ」を参照してください。

カスタムドメイン名を作成するには

次の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 でのリージョンカスタムドメイン名の設定」を参照してください。

統合を作成するには 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
}

詳細については、 WebSocket API「Amazon Gateway デベロッパーガイド」のAPI「ゲートウェイで統合リクエストを設定する」を参照してください。 API

HTTPAPI統合を作成するには

次のcreate-integration例では、 の AWS Lambda 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

出力:

{
    "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「 の統合の設定APIs」を参照してください。

WebSocket または の $default ルートを作成するには HTTP API

次のcreate-route例では、 WebSocket または HTTP の$defaultルートを作成しますAPI。

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

出力:

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

詳細については、Amazon API Gateway デベロッパーガイドの「 のルートの使用 WebSocket APIs」を参照してください。

のルートを作成するには 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」の「 のルートの使用APIs」を参照してください。

ステージを作成するには

次のcreate-stage例では、 の dev という名前のステージを作成しますAPI。

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」の「 のステージの操作APIs」を参照してください。

のVPCリンクを作成するには HTTP API

次のcreate-vpc-link例では、 HTTP のVPCリンクを作成しますAPIs。

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」の「 のVPCリンクの使用APIs」を参照してください。

のアクセスログ記録を無効にするには API

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

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

このコマンドでは何も出力されません。

詳細については、「Amazon API Gateway デベロッパーガイドHTTP」の「 のログ記録の設定API」を参照してください。

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 でのリージョンカスタムドメイン名の設定」を参照してください。

を削除するには API

次のdelete-api例では、 を削除しますAPI。

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

このコマンドでは何も出力されません。

詳細については、「Amazon API Gateway デベロッパーガイド」の「 の使用HTTPAPIs」と「 の使用 WebSocket APIs」を参照してください。

オーソライザーを削除するには

次のdelete-authorizer例では、オーソライザーを削除します。

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

このコマンドでは何も出力されません。

詳細については、「Amazon API Gateway デベロッパーガイド」のJWT「オーソライザーHTTPAPIsによる へのアクセスの制御」を参照してください。

CORSの設定を削除するには HTTP API

次のdelete-cors-configuration例では、 CORS の設定を削除HTTPAPIして CORSを無効にします。

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

このコマンドでは何も出力されません。

詳細については、「Amazon API Gateway デベロッパーガイドHTTP」の「 CORSの の設定API」を参照してください。

デプロイを削除するには

次のdelete-deployment例では、 のデプロイを削除しますAPI。

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

このコマンドでは何も出力されません。

詳細については、「Amazon API Gateway デベロッパーガイド」のAPI「デプロイ」を参照してください。

カスタムドメイン名を削除するには

次のdelete-domain-name例では、カスタムドメイン名を削除します。

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

このコマンドでは何も出力されません。

詳細については、「Amazon API Gateway デベロッパーガイド」のAPI「Gateway でのリージョンカスタムドメイン名の設定」を参照してください。

統合を削除するには

次のdelete-integration例では、API統合を削除します。

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

このコマンドでは何も出力されません。

詳細については、「Amazon Gateway デベロッパーガイド」の「 の統合の設定HTTPAPIs」および「 の統合の設定 WebSocket API」を参照してください。 API

ルート設定を削除するには

次のdelete-route-settings例では、指定されたルートのルート設定を削除します。

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

このコマンドでは何も出力されません。

詳細については、「Amazon API Gateway デベロッパーガイドHTTP」の「 のルートの使用APIs」を参照してください。

ルートを削除するには

次のdelete-route例では、APIルートを削除します。

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

このコマンドでは何も出力されません。

詳細については、「Amazon API Gateway デベロッパーガイドHTTP」の「 のルートの使用APIs」を参照してください。

ステージを削除するには

次のdelete-stage例では、 のtestステージを削除しますAPI。

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

このコマンドでは何も出力されません。

詳細については、「Amazon API Gateway デベロッパーガイドHTTP」の「 のステージの操作APIs」を参照してください。

のVPCリンクを削除するには HTTP API

次のdelete-vpc-link例では、VPCリンクを削除します。

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

このコマンドでは何も出力されません。

詳細については、「Amazon API Gateway デベロッパーガイドHTTP」の「 のVPCリンクの使用APIs」を参照してください。

の OpenAPI 定義をエクスポートするには HTTP API

次のexport-api例では、 という名前のAPIステージの OpenAPI 3.0 定義prodを という名前のYAMLファイルにエクスポートしますstage-definition.yaml。エクスポートされた定義ファイルには、デフォルトでAPIゲートウェイ拡張子が含まれています。

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

このコマンドでは何も出力されません。

詳細については、「Amazon API Gateway デベロッパーガイド」の「ゲートウェイHTTPAPIからの のエクスポート」を参照してください。 API

カスタムドメイン名の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 デベロッパーガイド」の「APIGateway でのリージョンカスタムドメイン名の設定」を参照してください。

カスタムドメイン名の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 デベロッパーガイド」の「APIGateway でのリージョンカスタムドメイン名の設定」を参照してください。

に関する情報を取得するには 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"
    }
}

のリストを取得するには APIs

次のget-apis例では、現在のユーザーの をすべて一覧表示APIsします。

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 デベロッパーガイド」の「 の使用HTTPAPIsと の使用 WebSocket APIs」を参照してください。

オーソライザーに関する情報を取得するには

次の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「オーソライザーHTTPAPIsによる へのアクセスの制御」を参照してください。

のオーソライザーのリストを取得するには 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「オーソライザーHTTPAPIsによる へのアクセスの制御」を参照してください。

デプロイに関する情報を取得するには

次の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「デプロイ」を参照してください。

デプロイのリストを取得するには

次の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「デプロイ」を参照してください。

カスタムドメイン名に関する情報を取得するには

次の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 でのリージョンカスタムドメイン名の設定」を参照してください。

カスタムドメイン名のリストを取得するには

次の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 でのリージョンカスタムドメイン名の設定」を参照してください。

統合に関する情報を取得するには

次の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 Gateway デベロッパーガイド」の「 の統合の設定HTTPAPIs」および「 の統合の設定 WebSocket API」を参照してください。 API

統合のリストを取得するには

次の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 Gateway デベロッパーガイド」の「 の統合の設定HTTPAPIs」および「 の統合の設定 WebSocket API」を参照してください。 API

ルートに関する情報を取得するには

次の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」の「 のルートの使用APIs」を参照してください。

ルートのリストを取得するには

次の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」の「 のルートの使用APIs」を参照してください。

ステージに関する情報を取得するには

次のget-stage例では、 のprodステージに関する情報を表示しますAPI。

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」の「 のステージの操作APIs」を参照してください。

ステージのリストを取得するには

次の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」の「 のステージの操作APIs」を参照してください。

リソースのタグのリストを取得するには

次の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

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」の「 のVPCリンクの使用APIs」を参照してください。

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」の「 のVPCリンクの使用APIs」を参照してください。

をインポートするには HTTP API

次のimport-api例では、 という名前の OpenAPI 3.0 定義ファイルHTTPAPIから を作成しますapi-definition.yaml。

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定義の使用APIs」を参照してください。

を再インポートするには HTTP API

次のreimport-api例では、 で指定された OpenAPI 3.0 定義を使用するHTTPAPIように既存の を更新しますapi-definition.yaml。

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定義の使用APIs」を参照してください。

リソースにタグを付けるには

次のtag-resource例では、キー名Departmentと の値を持つタグAccountingを指定された に追加しますAPI。

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

このコマンドでは何も出力されません。

詳細については、「Amazon API Gateway デベロッパーガイド」の「Gateway リソースのタグ付け」を参照してください。 API

リソースからタグを削除する

次の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 デベロッパーガイド」の「Gateway リソースのタグ付け」を参照してください。 API

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 でのリージョンカスタムドメイン名の設定」を参照してください。

CORSで を有効にするには HTTP API

次のupdate-api例では、指定された APICORSの設定を更新して、 からのリクエストを許可します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」の「 CORSの の設定API」を参照してください。

オーソライザーを更新するには

次の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「オーソライザーHTTPAPIsによる へのアクセスの制御」を参照してください。

デプロイの説明を変更するには

次の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 デベロッパーガイド」の「APIGateway HTTPAPIでの の開発」を参照してください。

カスタムドメイン名を更新するには

次の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 でのリージョンカスタムドメイン名の設定」を参照してください。

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 Gateway デベロッパーガイド」の「 の統合の設定HTTPAPIs」および「 の統合の設定 WebSocket API」を参照してください。 API

例 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「オーソライザーHTTPAPIsによる へのアクセスの制御」を参照してください。

カスタムスロットリングを設定するには

次の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」を参照してください。

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」の「 のVPCリンクの使用APIs」を参照してください。