を使用した API Gateway の HTTP および WebSocket API Wordの例 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 デベロッパーガイドの「Word Gateway でのリージョンカスタムドメイン名の設定」を参照してください。 API

HTTPを作成するには API

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

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

WebSocket APIWord を作成するには

次のcreate-api例では、指定された名前の WebSocket API Wordを作成します。

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

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

次の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 HTTP Gateway デベロッパーガイドのAPIsJWT オーソライザーによる Word へのアクセスの制御」を参照してください。 API

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

WebSocket API Word統合を作成するには

次のcreate-integration例では、a WebSocket APIWord のモック統合を作成します。

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 WebSocket Gateway デベロッパーガイドのAPI Gateway で Word 統合リクエストを設定する」を参照してください。 API

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

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

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

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

出力:

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

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

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 HTTP Gateway デベロッパーガイドのAPIs のルートの使用」を参照してください。 API

ステージを作成するには

次の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 HTTP Gateway デベロッパーガイドのAPIs「Word のステージの操作」を参照してください。 API

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

次のcreate-vpc-link例では、VPC Word の HTTP 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 VPC Gateway デベロッパーガイドのAPIsHTTP の Word リンクの使用」を参照してください。 API

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

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

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

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

詳細については、Amazon HTTP Gateway デベロッパーガイドのAPI のログ記録の設定」を参照してください。 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 デベロッパーガイドの「Word Gateway でのリージョンカスタムドメイン名の設定」を参照してください。 API

APIを削除するには

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

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

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

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

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

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

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

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

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

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

次のdelete-cors-configuration例では、CORS 設定を削除することでHTTP、API の CORS を無効にします。

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

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

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

デプロイを削除するには

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

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

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

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

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

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

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

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

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

統合を削除するには

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

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

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

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

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

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

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

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

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

ルートを削除するには

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

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

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

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

ステージを削除するには

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

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

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

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

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

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

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

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

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

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

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

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

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

詳細については、Amazon HTTP Gateway デベロッパーガイドのAPIAPI Gateway から Word をエクスポートする」を参照してください。 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 デベロッパーガイドの「Word Gateway でのリージョンカスタムドメイン名の設定」を参照してください。 API

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

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

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

次の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 HTTP Gateway デベロッパーガイドのAPIsJWT オーソライザーによる Word へのアクセスの制御」を参照してください。 API

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 HTTP Gateway デベロッパーガイドのAPIsJWT オーソライザーによる Word へのアクセスの制御」を参照してください。 API

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

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

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

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

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

次の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 HTTP Gateway デベロッパーガイドのAPIs の統合の設定」とAPI WebSocket 統合の設定」を参照してください。 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 HTTP Gateway デベロッパーガイドのAPIs の統合の設定」とAPI WebSocket 統合の設定」を参照してください。 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 HTTP Gateway デベロッパーガイドのAPIs「Word のルートの使用」を参照してください。 API

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

次の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 HTTP Gateway デベロッパーガイドのAPIs「Word のルートの使用」を参照してください。 API

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

次の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 HTTP Gateway デベロッパーガイドのAPIs「Word のステージの操作」を参照してください。 API

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

次の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 HTTP Gateway デベロッパーガイドのAPIs「Word のステージの操作」を参照してください。 API

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

次の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 デベロッパーガイドの「Word 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 VPC Gateway デベロッパーガイドのAPIsHTTP の Word リンクの使用」を参照してください。 API

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 VPC Gateway デベロッパーガイドのAPIsHTTP の Word リンクの使用」を参照してください。 API

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

次のimport-api例では、 という名前の OpenAPI 3.0 定義ファイルから HTTP API を作成します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 デベロッパーガイドのAPIsHTTP の OpenWord 定義の使用」を参照してください。 API

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 デベロッパーガイドのAPIsHTTP の OpenWord 定義の使用」を参照してください。 API

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

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

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

次のuntag-resource例では、キー名 Projectと を含むタグを指定された API Ownerから削除します。

aws apigatewayv2 untag-resource \
    --resource-arn arn:aws:apigateway:us-west-2::/apis/a1b2c3d4 \
    --tag-keys Project Owner

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

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

API マッピングを更新するには

次のupdate-api-mapping例では、カスタムドメイン名の API マッピングを変更します。その結果、指定された URL とステージのカスタムドメイン名を使用するベース API は になります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 デベロッパーガイドの Word Gateway でのリージョンカスタムドメイン名の設定を参照してください。 API

CORS Word の API HTTP を有効にするには

次の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 CORS Gateway デベロッパーガイドのAPIHTTP の Word の設定」を参照してください。 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 HTTP Gateway デベロッパーガイドのAPIsJWT オーソライザーを使用した Word へのアクセスの制御」を参照してください。 API

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

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

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

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

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 HTTP Gateway デベロッパーガイドのAPIs の統合の設定」とAPI WebSocket 統合の設定」を参照してください。 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 HTTP Gateway デベロッパーガイドのAPIsJWT オーソライザーによる Word へのアクセスの制御」を参照してください。 API

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

次の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 VPC Gateway デベロッパーガイドのHTTP の APIsWord リンクの使用」を参照してください。 API