API を使用したゲートウェイの例 AWS CLI - AWS SDK コード例
アクション

AWS Doc SDK Examples GitHub リポジトリには他にも AWS SDK例があります。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

API を使用したゲートウェイの例 AWS CLI

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

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

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

トピック

アクション

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

AWS CLI

既存の APIと Stage で有効になっているAPIキーを作成するには

コマンド:

aws apigateway create-api-key --name 'Dev API Key' --description 'Used for development' --enabled --stage-keys restApiId='a1b2c3d4e5',stageName='dev'

  • API 詳細については、AWS CLI 「 コマンドリファレンスCreateApiKey」の「」を参照してください。

次の例は、create-authorizer を使用する方法を説明しています。

AWS CLI

例 1: のトークンベースの API Gateway Custom Authorizer を作成するには API

次のcreate-authorizer例では、トークンベースのオーソライザーを作成します。

aws apigateway create-authorizer \
    --rest-api-id 1234123412 \
    --name 'First_Token_Custom_Authorizer' \
    --type TOKEN \
    --authorizer-uri 'arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:customAuthFunction/invocations' \
    --identity-source 'method.request.header.Authorization' \
    --authorizer-result-ttl-in-seconds 300

出力:

{
    "authType": "custom",
    "name": "First_Token_Custom_Authorizer",
    "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:customAuthFunction/invocations",
    "authorizerResultTtlInSeconds": 300,
    "identitySource": "method.request.header.Authorization",
    "type": "TOKEN",
    "id": "z40xj0"
}

例 2: の Cognito ユーザープールベースのAPIゲートウェイカスタムオーソライザーを作成するには API

次のcreate-authorizer例では、Cognito ユーザープールベースのAPIゲートウェイカスタムオーソライザーを作成します。

aws apigateway create-authorizer \
    --rest-api-id 1234123412 \
    --name 'First_Cognito_Custom_Authorizer' \
    --type COGNITO_USER_POOLS \
    --provider-arns 'arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_aWcZeQbuD' \
    --identity-source 'method.request.header.Authorization'

出力:

{
    "authType": "cognito_user_pools",
    "identitySource": "method.request.header.Authorization",
    "name": "First_Cognito_Custom_Authorizer",
    "providerARNs": [
        "arn:aws:cognito-idp:us-east-1:342398297714:userpool/us-east-1_qWbZzQhzE"
    ],
    "type": "COGNITO_USER_POOLS",
    "id": "5yid1t"
}

例 3: のリクエストベースの API Gateway Custom Authorizer を作成するには API

次のcreate-authorizer例では、リクエストベースのオーソライザーを作成します。

aws apigateway create-authorizer \
    --rest-api-id 1234123412 \
    --name 'First_Request_Custom_Authorizer' \
    --type REQUEST \
    --authorizer-uri 'arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:customAuthFunction/invocations' \
    --identity-source 'method.request.header.Authorization,context.accountId' \
    --authorizer-result-ttl-in-seconds 300

出力:

{
    "id": "z40xj0",
    "name": "First_Request_Custom_Authorizer",
    "type": "REQUEST",
    "authType": "custom",
    "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:customAuthFunction/invocations",
    "identitySource": "method.request.header.Authorization,context.accountId",
    "authorizerResultTtlInSeconds": 300
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスCreateAuthorizer」の「」を参照してください。

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

AWS CLI

カスタムドメイン名のベースパスマッピングを作成するには

コマンド:

aws apigateway create-base-path-mapping --domain-name subdomain.domain.tld --rest-api-id 1234123412 --stage prod --base-path v1

  • API 詳細については、AWS CLI 「 コマンドリファレンスCreateBasePathMapping」の「」を参照してください。

次の例は、create-deployment を使用する方法を説明しています。

AWS CLI

の設定済みリソースを新しいステージAPIにデプロイするには

コマンド:

aws apigateway create-deployment --rest-api-id 1234123412 --stage-name dev --stage-description 'Development Stage' --description 'First deployment to the dev stage'

の設定済みリソースを既存のステージAPIにデプロイするには

コマンド:

aws apigateway create-deployment --rest-api-id 1234123412 --stage-name dev --description 'Second deployment to the dev stage'

に設定されたリソースをステージ変数を使用して既存のステージAPIにデプロイするには

aws apigateway create-deployment --rest-api-id 1234123412 --stage-name dev --description '開発ステージへの 3 回目のデプロイ' --variables key='value',otherKey='otherValue'

  • API 詳細については、AWS CLI 「 コマンドリファレンスCreateDeployment」の「」を参照してください。

次の例は、create-domain-name を使用する方法を説明しています。

AWS CLI

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

コマンド:

aws apigateway create-domain-name --domain-name 'my.domain.tld' --certificate-name 'my.domain.tld cert' --certificate-arn 'arn:aws:acm:us-east-1:012345678910:certificate/fb1b9770-a305-495d-aefb-27e5e101ff3'

  • API 詳細については、AWS CLI 「 コマンドリファレンスCreateDomainName」の「」を参照してください。

次の例は、create-model を使用する方法を説明しています。

AWS CLI

のモデルを作成するには API

コマンド:

aws apigateway create-model --rest-api-id 1234123412 --name 'firstModel' --description 'The First Model' --content-type 'application/json'  --schema '{ "$schema": "http://json-schema.org/draft-04/schema#", "title": "firstModel", "type": "object", "properties": { "firstProperty" : { "type": "object", "properties": { "key": { "type": "string" } } } } }'

出力:

{
    "contentType": "application/json",
    "description": "The First Model",
    "name": "firstModel",
    "id": "2rzg0l",
    "schema": "{ \"$schema\": \"http://json-schema.org/draft-04/schema#\", \"title\": \"firstModel\", \"type\": \"object\", \"properties\": { \"firstProperty\" : { \"type\": \"object\", \"properties\": { \"key\": { \"type\": \"string\" } } } } }"
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスCreateModel」の「」を参照してください。

次の例は、create-resource を使用する方法を説明しています。

AWS CLI

でリソースを作成するには API

コマンド:

aws apigateway create-resource --rest-api-id 1234123412 --parent-id a1b2c3 --path-part 'new-resource'

  • API 詳細については、AWS CLI 「 コマンドリファレンスCreateResource」の「」を参照してください。

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

AWS CLI

を作成するには API

コマンド:

aws apigateway create-rest-api --name 'My First API' --description 'This is my first API'

既存の APIから重複を作成するには API

コマンド:

aws apigateway create-rest-api --name 'Copy of My First API' --description 'This is a copy of my first API' --clone-from 1234123412

  • API 詳細については、AWS CLI 「 コマンドリファレンスCreateRestApi」の「」を参照してください。

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

AWS CLI

に既存のデプロイAPIを含むステージを作成するには

コマンド:

aws apigateway create-stage --rest-api-id 1234123412 --stage-name 'dev' --description 'Development stage' --deployment-id a1b2c3

に既存のデプロイとカスタムステージ変数APIを含むステージを作成するには

コマンド:

aws apigateway create-stage --rest-api-id 1234123412 --stage-name 'dev' --description 'Development stage' --deployment-id a1b2c3 --variables key='value',otherKey='otherValue'

  • API 詳細については、AWS CLI 「 コマンドリファレンスCreateStage」の「」を参照してください。

次の例は、create-usage-plan-key を使用する方法を説明しています。

AWS CLI

既存のAPIキーを使用状況プランに関連付ける

コマンド:

aws apigateway create-usage-plan-key --usage-plan-id a1b2c3 --key-type "API_KEY" --key-id 4vq3yryqm5

  • API 詳細については、AWS CLI 「 コマンドリファレンスCreateUsagePlanKey」の「」を参照してください。

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

AWS CLI

月の初めにリセットされるスロットルとクォータの制限を使用して使用プランを作成するには

コマンド:

aws apigateway create-usage-plan --name "New Usage Plan" --description "A new usage plan" --throttle burstLimit=10,rateLimit=5 --quota limit=500,offset=0,period=MONTH

  • API 詳細については、AWS CLI 「 コマンドリファレンスCreateUsagePlan」の「」を参照してください。

次の例は、delete-api-key を使用する方法を説明しています。

AWS CLI

APIキーを削除するには

コマンド:

aws apigateway delete-api-key --api-key 8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeleteApiKey」の「」を参照してください。

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

AWS CLI

でカスタムオーソライザーを削除するには API

コマンド:

aws apigateway delete-authorizer --rest-api-id 1234123412 --authorizer-id 7gkfbo

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeleteAuthorizer」の「」を参照してください。

次の例は、delete-base-path-mapping を使用する方法を説明しています。

AWS CLI

カスタムドメイン名のベースパスマッピングを削除するには

コマンド:

aws apigateway delete-base-path-mapping --domain-name 'api.domain.tld' --base-path 'dev'

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeleteBasePathMapping」の「」を参照してください。

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

AWS CLI

クライアント証明書を削除するには

コマンド:

aws apigateway delete-client-certificate --client-certificate-id a1b2c3

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeleteClientCertificate」の「」を参照してください。

次の例は、delete-deployment を使用する方法を説明しています。

AWS CLI

でデプロイを削除するには API

コマンド:

aws apigateway delete-deployment --rest-api-id 1234123412 --deployment-id a1b2c3

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeleteDeployment」の「」を参照してください。

次の例は、delete-domain-name を使用する方法を説明しています。

AWS CLI

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

コマンド:

aws apigateway delete-domain-name --domain-name 'api.domain.tld'

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeleteDomainName」の「」を参照してください。

次の例は、delete-integration-response を使用する方法を説明しています。

AWS CLI

で特定のリソース、メソッド、ステータスコードの統合レスポンスを削除するには API

コマンド:

aws apigateway delete-integration-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeleteIntegrationResponse」の「」を参照してください。

次の例は、delete-integration を使用する方法を説明しています。

AWS CLI

で特定のリソースとメソッドの統合を削除するには API

コマンド:

aws apigateway delete-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeleteIntegration」の「」を参照してください。

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

AWS CLI

で特定のリソース、メソッド、ステータスコードのメソッドレスポンスを削除するには API

コマンド:

aws apigateway delete-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeleteMethodResponse」の「」を参照してください。

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

AWS CLI

で特定のリソースのメソッドを削除するには API

コマンド:

aws apigateway delete-method --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeleteMethod」の「」を参照してください。

次の例は、delete-model を使用する方法を説明しています。

AWS CLI

特定の でモデルを削除するには API

コマンド:

aws apigateway delete-model --rest-api-id 1234123412 --model-name 'customModel'

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeleteModel」の「」を参照してください。

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

AWS CLI

でリソースを削除するには API

コマンド:

aws apigateway delete-resource --rest-api-id 1234123412 --resource-id a1b2c3

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeleteResource」の「」を参照してください。

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

AWS CLI

を削除するには API

コマンド:

aws apigateway delete-rest-api --rest-api-id 1234123412

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeleteRestApi」の「」を参照してください。

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

AWS CLI

でステージを削除するには API

コマンド:

aws apigateway delete-stage --rest-api-id 1234123412 --stage-name 'dev'

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeleteStage」の「」を参照してください。

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

AWS CLI

使用プランからAPIキーを削除するには

コマンド:

aws apigateway delete-usage-plan-key --usage-plan-id a1b2c3 --key-id 1NbjQzMReAkeEQPNAW8r3dXsU2rDD7fc7f2Sipnu

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeleteUsagePlanKey」の「」を参照してください。

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

AWS CLI

使用状況プランを削除するには

コマンド:

aws apigateway delete-usage-plan --usage-plan-id a1b2c3

  • API 詳細については、AWS CLI 「 コマンドリファレンスDeleteUsagePlan」の「」を参照してください。

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

AWS CLI

ステージのすべてのオーソライザーキャッシュエントリをフラッシュするには

コマンド:

aws apigateway flush-stage-authorizers-cache --rest-api-id 1234123412 --stage-name dev

  • API 詳細については、AWS CLI 「 コマンドリファレンスFlushStageAuthorizersCache」の「」を参照してください。

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

AWS CLI

APIのステージのキャッシュをフラッシュするには

コマンド:

aws apigateway flush-stage-cache --rest-api-id 1234123412 --stage-name dev

  • API 詳細については、AWS CLI 「 コマンドリファレンスFlushStageCache」の「」を参照してください。

次のコード例は、generate-client-certificate を使用する方法を示しています。

AWS CLI

クライアント側のSSL証明書を作成するには

コマンド:

aws apigateway generate-client-certificate --description 'My First Client Certificate'

  • API 詳細については、AWS CLI 「 コマンドリファレンスGenerateClientCertificate」の「」を参照してください。

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

AWS CLI

API Gateway アカウント設定を取得するには

コマンド:

aws apigateway get-account

出力:

{
    "cloudwatchRoleArn": "arn:aws:iam::123412341234:role/APIGatewayToCloudWatchLogsRole",
    "throttleSettings": {
        "rateLimit": 500.0,
        "burstLimit": 1000
    }
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetAccount」の「」を参照してください。

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

AWS CLI

特定のAPIキーに関する情報を取得するには

コマンド:

aws apigateway get-api-key --api-key 8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk

出力:

{
    "description": "My first key",
    "enabled": true,
    "stageKeys": [
        "a1b2c3d4e5/dev",
        "e5d4c3b2a1/dev"
    ],
    "lastUpdatedDate": 1456184515,
    "createdDate": 1456184452,
    "id": "8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk",
    "name": "My key"
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetApiKey」の「」を参照してください。

次の例は、get-api-keys を使用する方法を説明しています。

AWS CLI

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

コマンド:

aws apigateway get-api-keys

出力:

{
    "items": [
        {
            "description": "My first key",
            "enabled": true,
            "stageKeys": [
                "a1b2c3d4e5/dev",
                "e5d4c3b2a1/dev"
            ],
            "lastUpdatedDate": 1456184515,
            "createdDate": 1456184452,
            "id": "8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk",
            "name": "My key"
        }
    ]
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetApiKeys」の「」を参照してください。

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

AWS CLI

オーソライザーごとのAPIAPIゲートウェイ設定を取得するには

コマンド:

aws apigateway get-authorizer --rest-api-id 1234123412 --authorizer-id gfi4n3

出力:

{
    "authorizerResultTtlInSeconds": 300,
    "name": "MyAuthorizer",
    "type": "TOKEN",
    "identitySource": "method.request.header.Authorization",
    "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:authorizer_function/invocations",
    "id": "gfi4n3"
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetAuthorizer」の「」を参照してください。

次の例は、get-authorizers を使用する方法を説明しています。

AWS CLI

のオーソライザーのリストを取得するには REST API

コマンド:

aws apigateway get-authorizers --rest-api-id 1234123412

出力:

{
    "items": [
        {
            "name": "MyAuthorizer",
            "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:My_Authorizer_Function/invocations",
            "authorizerResultTtlInSeconds": 300,
            "identitySource": "method.request.header.Authorization",
            "type": "TOKEN",
            "id": "gfi4n3"
        }
    ]
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetAuthorizers」の「」を参照してください。

次の例は、get-base-path-mapping を使用する方法を説明しています。

AWS CLI

カスタムドメイン名のベースパスマッピングを取得するには

コマンド:

aws apigateway get-base-path-mapping --domain-name subdomain.domain.tld --base-path v1

出力:

{
    "basePath": "v1",
    "restApiId": "1234w4321e",
    "stage": "api"
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetBasePathMapping」の「」を参照してください。

次の例は、get-base-path-mappings を使用する方法を説明しています。

AWS CLI

カスタムドメイン名の基本パスマッピングを取得するには

コマンド:

aws apigateway get-base-path-mappings --domain-name subdomain.domain.tld

出力:

{
    "items": [
        {
            "basePath": "(none)",
            "restApiId": "1234w4321e",
            "stage": "dev"
        },
        {
            "basePath": "v1",
            "restApiId": "1234w4321e",
            "stage": "api"
        }
    ]
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetBasePathMappings」の「」を参照してください。

次の例は、get-client-certificate を使用する方法を説明しています。

AWS CLI

クライアント証明書を取得するには

コマンド:

aws apigateway get-client-certificate --client-certificate-id a1b2c3

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetClientCertificate」の「」を参照してください。

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

AWS CLI

クライアント証明書のリストを取得するには

コマンド:

aws apigateway get-client-certificates

出力:

{
    "items": [
        {
            "pemEncodedCertificate": "-----BEGIN CERTIFICATE----- <certificate content> -----END CERTIFICATE-----",
            "clientCertificateId": "a1b2c3",
            "expirationDate": 1483556561,
            "description": "My Client Certificate",
            "createdDate": 1452020561
        }
    ]
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetClientCertificates」の「」を参照してください。

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

AWS CLI

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

コマンド:

aws apigateway get-deployment --rest-api-id 1234123412 --deployment-id ztt4m2

出力:

{
    "description": "myDeployment",
    "id": "ztt4m2",
    "createdDate": 1455218022
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetDeployment」の「」を参照してください。

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

AWS CLI

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

コマンド:

aws apigateway get-deployments --rest-api-id 1234123412

出力:

{
    "items": [
        {
            "createdDate": 1453797217,
            "id": "0a2b4c",
            "description": "Deployed my API for the first time"
        }
    ]
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetDeployments」の「」を参照してください。

次の例は、get-domain-name を使用する方法を説明しています。

AWS CLI

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

コマンド:

aws apigateway get-domain-name --domain-name api.domain.tld

出力:

{
    "domainName": "api.domain.tld",
    "distributionDomainName": "d1a2f3a4c5o6d.cloudfront.net",
    "certificateName": "uploadedCertificate",
    "certificateUploadDate": 1462565487
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetDomainName」の「」を参照してください。

次の例は、get-domain-names を使用する方法を説明しています。

AWS CLI

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

コマンド:

aws apigateway get-domain-names

出力:

{
    "items": [
        {
            "distributionDomainName": "d9511k3l09bkd.cloudfront.net",
            "certificateUploadDate": 1452812505,
            "certificateName": "my_custom_domain-certificate",
            "domainName": "subdomain.domain.tld"
        }
    ]
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetDomainNames」の「」を参照してください。

次の例は、get-export を使用する方法を説明しています。

AWS CLI

ステージの JSON Swagger テンプレートを取得するには

コマンド:

aws apigateway get-export --rest-api-id a1b2c3d4e5 --stage-name dev --export-type swagger /path/to/filename.json

ステージの JSON Swagger テンプレート + API Gateway 拡張を取得するには

コマンド:

aws apigateway get-export --parameters extensions='integrations' --rest-api-id a1b2c3d4e5 --stage-name dev --export-type swagger /path/to/filename.json

ステージの JSON Swagger テンプレート + Postman Extensions を取得するには

コマンド:

aws apigateway get-export --parameters extensions='postman' --rest-api-id a1b2c3d4e5 --stage-name dev --export-type swagger /path/to/filename.json

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetExport」の「」を参照してください。

次の例は、get-integration-response を使用する方法を説明しています。

AWS CLI

RESTAPIのリソースで定義されたHTTPメソッドの統合レスポンス設定を取得するには

コマンド:

aws apigateway get-integration-response --rest-api-id 1234123412 --resource-id y9h6rt --http-method GET --status-code 200

出力:

{
    "statusCode": "200",
    "responseTemplates": {
        "application/json": null
    }
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetIntegrationResponse」の「」を参照してください。

次の例は、get-integration を使用する方法を説明しています。

AWS CLI

RESTAPIのリソースで定義されたHTTPメソッドの統合設定を取得するには

コマンド:

aws apigateway get-integration --rest-api-id 1234123412 --resource-id y9h6rt --http-method GET

出力:

{
    "httpMethod": "POST",
    "integrationResponses": {
        "200": {
            "responseTemplates": {
                "application/json": null
            },
            "statusCode": "200"
        }
    },
    "cacheKeyParameters": [],
    "type": "AWS",
    "uri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:My_Function/invocations",
    "cacheNamespace": "y9h6rt"
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetIntegration」の「」を参照してください。

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

AWS CLI

のリソースで定義されたメソッドのHTTPメソッドレスポンスRESTAPIリソース設定を取得するには

コマンド:

aws apigateway get-method-response --rest-api-id 1234123412 --resource-id y9h6rt --http-method GET --status-code 200

出力:

{
    "responseModels": {
        "application/json": "Empty"
    },
    "statusCode": "200"
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetMethodResponse」の「」を参照してください。

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

AWS CLI

のリソースで定義されたメソッドのHTTPメソッドRESTAPIリソース設定を取得するには

コマンド:

aws apigateway get-method --rest-api-id 1234123412 --resource-id y9h6rt --http-method GET

出力:

{
    "apiKeyRequired": false,
    "httpMethod": "GET",
    "methodIntegration": {
        "integrationResponses": {
            "200": {
                "responseTemplates": {
                    "application/json": null
                },
                "statusCode": "200"
            }
        },
        "cacheKeyParameters": [],
        "uri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:My_Function/invocations",
        "httpMethod": "POST",
        "cacheNamespace": "y9h6rt",
        "type": "AWS"
    },
    "requestParameters": {},
    "methodResponses": {
        "200": {
            "responseModels": {
                "application/json": "Empty"
            },
            "statusCode": "200"
        }
    },
    "authorizationType": "NONE"
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetMethod」の「」を参照してください。

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

AWS CLI

で定義されたモデルのマッピングテンプレートを取得するには REST API

コマンド:

aws apigateway get-model-template --rest-api-id 1234123412 --model-name Empty

出力:

{
    "value": "#set($inputRoot = $input.path('$'))\n{ }"
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetModelTemplate」の「」を参照してください。

次の例は、get-model を使用する方法を説明しています。

AWS CLI

で定義されたモデルの設定を取得するには REST API

コマンド:

aws apigateway get-model --rest-api-id 1234123412 --model-name Empty

出力:

{
    "contentType": "application/json",
    "description": "This is a default empty schema model",
    "name": "Empty",
    "id": "etd5w5",
    "schema": "{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"title\" : \"Empty Schema\",\n  \"type\" : \"object\"\n}"
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetModel」の「」を参照してください。

次の例は、get-models を使用する方法を説明しています。

AWS CLI

のモデルのリストを取得するには REST API

コマンド:

aws apigateway get-models --rest-api-id 1234123412

出力:

{
    "items": [
        {
            "description": "This is a default error schema model",
            "schema": "{\n  \"$schema\" : \"http://json-schema.org/draft-04/schema#\",\n  \"title\" : \"Error Schema\",\n  \"type\" : \"object\",\n  \"properties\" : {\n    \"message\" : { \"type\" : \"string\" }\n  }\n}",
            "contentType": "application/json",
            "id": "7tpbze",
            "name": "Error"
        },
        {
            "description": "This is a default empty schema model",
            "schema": "{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"title\" : \"Empty Schema\",\n  \"type\" : \"object\"\n}",
            "contentType": "application/json",
            "id": "etd5w5",
            "name": "Empty"
        }
    ]
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetModels」の「」を参照してください。

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

AWS CLI

リソースに関する情報を取得するには

コマンド:

aws apigateway get-resource --rest-api-id 1234123412 --resource-id zwo0y3

出力:

{
    "path": "/path",
    "pathPart": "path",
    "id": "zwo0y3",
    "parentId": "uyokt6ij2g"
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetResource」の「」を参照してください。

次の例は、get-resources を使用する方法を説明しています。

AWS CLI

のリソースのリストを取得するには REST API

コマンド:

aws apigateway get-resources --rest-api-id 1234123412

出力:

{
    "items": [
        {
            "path": "/resource/subresource",
            "resourceMethods": {
                "POST": {}
            },
            "id": "024ace",
            "pathPart": "subresource",
            "parentId": "ai5b02"
        }
    ]
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetResources」の「」を参照してください。

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

AWS CLI

に関する情報を取得するには API

コマンド:

aws apigateway get-rest-api --rest-api-id 1234123412

出力:

{
    "name": "myAPI",
    "id": "o1y243m4f5",
    "createdDate": 1453416433
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetRestApi」の「」を参照してください。

次の例は、get-rest-apis を使用する方法を説明しています。

AWS CLI

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

コマンド:

aws apigateway get-rest-apis

出力:

{
    "items": [
        {
            "createdDate": 1438884790,
            "id": "12s44z21rb",
            "name": "My First API"
        }
    ]
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetRestApis」の「」を参照してください。

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

AWS CLI

RESTAPIステージの Android SDK を取得するには

コマンド:

aws apigateway get-sdk --rest-api-id 1234123412 --stage-name dev --sdk-type android --parameters groupId='com.mycompany',invokerPackage='com.mycompany.clientsdk',artifactId='Mycompany-client',artifactVersion='1.0.0' /path/to/android_sdk.zip

出力:

{
    "contentType": "application/octet-stream",
    "contentDisposition": "attachment; filename=\"android_2016-02-22_23-52Z.zip\""
}

RESTAPIステージIOSSDKの を取得するには

コマンド:

aws apigateway get-sdk --rest-api-id 1234123412 --stage-name dev --sdk-type objectivec --parameters classPrefix='myprefix' /path/to/iOS_sdk.zip

出力:

{
    "contentType": "application/octet-stream",
    "contentDisposition": "attachment; filename=\"objectivec_2016-02-22_23-52Z.zip\""
}

SDKRESTAPIステージの Javascript を取得するには

コマンド:

aws apigateway get-sdk --rest-api-id 1234123412 --stage-name dev --sdk-type javascript /path/to/javascript_sdk.zip

出力:

{
    "contentType": "application/octet-stream",
    "contentDisposition": "attachment; filename=\"javascript_2016-02-22_23-52Z.zip\""
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetSdk」の「」を参照してください。

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

AWS CLI

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

コマンド:

aws apigateway get-stage --rest-api-id 1234123412 --stage-name dev

出力:

{
    "stageName": "dev",
    "cacheClusterSize": "0.5",
    "cacheClusterEnabled": false,
    "cacheClusterStatus": "NOT_AVAILABLE",
    "deploymentId": "rbh1fj",
    "lastUpdatedDate": 1466802961,
    "createdDate": 1460682074,
    "methodSettings": {
        "*/*": {
            "cacheTtlInSeconds": 300,
            "loggingLevel": "INFO",
            "dataTraceEnabled": false,
            "metricsEnabled": true,
            "unauthorizedCacheControlHeaderStrategy": "SUCCEED_WITH_RESPONSE_HEADER",
            "throttlingRateLimit": 500.0,
            "cacheDataEncrypted": false,
            "cachingEnabled": false,
            "throttlingBurstLimit": 1000,
            "requireAuthorizationForCacheControl": true
        },
        "~1resource/GET": {
            "cacheTtlInSeconds": 300,
            "loggingLevel": "INFO",
            "dataTraceEnabled": false,
            "metricsEnabled": true,
            "unauthorizedCacheControlHeaderStrategy": "SUCCEED_WITH_RESPONSE_HEADER",
            "throttlingRateLimit": 500.0,
            "cacheDataEncrypted": false,
            "cachingEnabled": false,
            "throttlingBurstLimit": 1000,
            "requireAuthorizationForCacheControl": true
        }
    }
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetStage」の「」を参照してください。

次の例は、get-stages を使用する方法を説明しています。

AWS CLI

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

コマンド:

aws apigateway get-stages --rest-api-id 1234123412

出力:

{
    "item": [
        {
            "stageName": "dev",
            "cacheClusterSize": "0.5",
            "cacheClusterEnabled": true,
            "cacheClusterStatus": "AVAILABLE",
            "deploymentId": "123h64",
            "lastUpdatedDate": 1456185138,
            "createdDate": 1453589092,
            "methodSettings": {
                "~1resource~1subresource/POST": {
                    "cacheTtlInSeconds": 300,
                    "loggingLevel": "INFO",
                    "dataTraceEnabled": true,
                    "metricsEnabled": true,
                    "throttlingRateLimit": 500.0,
                    "cacheDataEncrypted": false,
                    "cachingEnabled": false,
                    "throttlingBurstLimit": 1000
                }
            }
        }
    ]
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetStages」の「」を参照してください。

次の例は、get-usage-plan-key を使用する方法を説明しています。

AWS CLI

使用状況プランに関連付けられたAPIキーの詳細を取得するには

コマンド:

aws apigateway get-usage-plan-key --usage-plan-id a1b2c3 --key-id 1NbjQzMReAkeEQPNAW8r3dXsU2rDD7fc7f2Sipnu

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetUsagePlanKey」の「」を参照してください。

次の例は、get-usage-plan-keys を使用する方法を説明しています。

AWS CLI

使用状況プランに関連付けられたAPIキーのリストを取得するには

コマンド:

aws apigateway get-usage-plan-keys --usage-plan-id a1b2c3

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetUsagePlanKeys」の「」を参照してください。

次の例は、get-usage-plan を使用する方法を説明しています。

AWS CLI

使用状況プランの詳細を取得するには

コマンド:

aws apigateway get-usage-plan --usage-plan-id a1b2c3

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetUsagePlan」の「」を参照してください。

次の例は、get-usage-plans を使用する方法を説明しています。

AWS CLI

すべての使用状況プランの詳細を取得するには

コマンド:

aws apigateway get-usage-plans

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetUsagePlans」の「」を参照してください。

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

AWS CLI

Usage Plan の使用状況の詳細を取得するには

コマンド:

aws apigateway get-usage --usage-plan-id a1b2c3 --start-date "2016-08-16" --end-date "2016-08-17"

  • API 詳細については、AWS CLI 「 コマンドリファレンスGetUsage」の「」を参照してください。

次の例は、import-rest-api を使用する方法を説明しています。

AWS CLI

Swagger テンプレートをインポートして を作成するには API

コマンド:

aws apigateway import-rest-api --body 'file:///path/to/API_Swagger_template.json'

  • API 詳細については、AWS CLI 「 コマンドリファレンスImportRestApi」の「」を参照してください。

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

AWS CLI

マッピングテンプレートを定義して、統合レスポンスをデフォルトレスポンスとして作成するには

コマンド:

aws apigateway put-integration-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 --selection-pattern "" --response-templates '{"application/json": "{\"json\": \"template\"}"}'

regex が 400 でヘッダー値が静的に定義された統合レスポンスを作成するには

コマンド:

aws apigateway put-integration-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 400 --selection-pattern 400 --response-parameters '{"method.response.header.custom-header": "'"'"'custom-value'"'"'"}'

  • API 詳細については、AWS CLI 「 コマンドリファレンスPutIntegrationResponse」の「」を参照してください。

次の例は、put-integration を使用する方法を説明しています。

AWS CLI

MOCK統合リクエストを作成するには

コマンド:

aws apigateway put-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --type MOCK --request-templates '{ "application/json": "{\"statusCode\": 200}" }'

HTTP統合リクエストを作成するには

コマンド:

aws apigateway put-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --type HTTP --integration-http-method GET --uri 'https://domain.tld/path'

Lambda Function エンドポイントと AWS の統合リクエストを作成するには

コマンド:

aws apigateway put-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --type AWS --integration-http-method POST --uri 'arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:function_name/invocations'

  • API 詳細については、AWS CLI 「 コマンドリファレンスPutIntegration」の「」を参照してください。

次の例は、put-method-response を使用する方法を説明しています。

AWS CLI

カスタムメソッドレスポンスヘッダーを使用して、指定したステータスコードでメソッドレスポンスを作成するには

コマンド:

aws apigateway put-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 400 --response-parameters "method.response.header.custom-header=false"

  • API 詳細については、AWS CLI 「 コマンドリファレンスPutMethodResponse」の「」を参照してください。

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

AWS CLI

認証なし、APIキーなし、カスタムメソッドリクエストヘッダーAPIを持つ でリソースのメソッドを作成するには

コマンド:

aws apigateway put-method --rest-api-id 1234123412 --resource-id a1b2c3 --http-method PUT --authorization-type "NONE" --no-api-key-required --request-parameters "method.request.header.custom-header=false"

  • API 詳細については、AWS CLI 「 コマンドリファレンスPutMethod」の「」を参照してください。

次の例は、put-rest-api を使用する方法を説明しています。

AWS CLI

Swagger テンプレートAPIを使用して既存の を上書きするには

コマンド:

aws apigateway put-rest-api --rest-api-id 1234123412 --mode overwrite --body 'fileb:///path/to/API_Swagger_template.json'

Swagger テンプレートを既存の にマージするには API

コマンド:

aws apigateway put-rest-api --rest-api-id 1234123412 --mode merge --body 'fileb:///path/to/API_Swagger_template.json'

  • API 詳細については、AWS CLI 「 コマンドリファレンスPutRestApi」の「」を参照してください。

次の例は、test-invoke-authorizer を使用する方法を説明しています。

AWS CLI

必要なヘッダーと値を含むカスタムオーソライザーへのリクエストをテストするには

コマンド:

aws apigateway test-invoke-authorizer --rest-api-id 1234123412 --authorizer-id 5yid1t --headers Authorization='Value'

  • API 詳細については、AWS CLI 「 コマンドリファレンスTestInvokeAuthorizer」の「」を参照してください。

次の例は、test-invoke-method を使用する方法を説明しています。

AWS CLI

GETリクエストAPIを実行して でルートリソースをテストするには

コマンド:

aws apigateway test-invoke-method --rest-api-id 1234123412 --resource-id avl5sg8fw8 --http-method GET --path-with-query-string '/'

パスパラメータ値を指定APIしてGETリクエストを実行して、 でサブリソースをテストするには

コマンド:

aws apigateway test-invoke-method --rest-api-id 1234123412 --resource-id 3gapai --http-method GET --path-with-query-string '/pets/1'

  • API 詳細については、AWS CLI 「 コマンドリファレンスTestInvokeMethod」の「」を参照してください。

次の例は、update-account を使用する方法を説明しています。

AWS CLI

CloudWatch Logs へのログ記録ARNのIAMロールを変更するには

コマンド:

aws apigateway update-account --patch-operations op='replace',path='/cloudwatchRoleArn',value='arn:aws:iam::123412341234:role/APIGatewayToCloudWatchLogs'

出力:

{
    "cloudwatchRoleArn": "arn:aws:iam::123412341234:role/APIGatewayToCloudWatchLogs",
    "throttleSettings": {
        "rateLimit": 1000.0,
        "burstLimit": 2000
    }
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスUpdateAccount」の「」を参照してください。

次の例は、update-api-key を使用する方法を説明しています。

AWS CLI

APIキーの名前を変更するには

コマンド:

aws apigateway update-api-key --api-key sNvjQDMReA1eEQPNAW8r37XsU2rDD7fc7m2SiMnu --patch-operations op='replace',path='/name',value='newName'

出力:

{
    "description": "currentDescription",
    "enabled": true,
    "stageKeys": [
        "41t2j324r5/dev"
    ],
    "lastUpdatedDate": 1470086052,
    "createdDate": 1445460347,
    "id": "sNvjQDMReA1vEQPNzW8r3dXsU2rrD7fcjm2SiMnu",
    "name": "newName"
}

APIキーを無効にするには

コマンド:

aws apigateway update-api-key --api-key sNvjQDMReA1eEQPNAW8r37XsU2rDD7fc7m2SiMnu --patch-operations op='replace',path='/enabled',value='false'

出力:

{
    "description": "currentDescription",
    "enabled": false,
    "stageKeys": [
        "41t2j324r5/dev"
    ],
    "lastUpdatedDate": 1470086052,
    "createdDate": 1445460347,
    "id": "sNvjQDMReA1vEQPNzW8r3dXsU2rrD7fcjm2SiMnu",
    "name": "newName"
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスUpdateApiKey」の「」を参照してください。

次の例は、update-authorizer を使用する方法を説明しています。

AWS CLI

Custom Authorizer の名前を変更するには

コマンド:

aws apigateway update-authorizer --rest-api-id 1234123412 --authorizer-id gfi4n3 --patch-operations op='replace',path='/name',value='testAuthorizer'

出力:

{
    "authType": "custom",
    "name": "testAuthorizer",
    "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:customAuthorizer/invocations",
    "authorizerResultTtlInSeconds": 300,
    "identitySource": "method.request.header.Authorization",
    "type": "TOKEN",
    "id": "gfi4n3"
}

カスタムオーソライザーによって呼び出される Lambda 関数を変更するには

コマンド:

aws apigateway update-authorizer --rest-api-id 1234123412 --authorizer-id gfi4n3 --patch-operations op='replace',path='/authorizerUri',value='arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:newAuthorizer/invocations'

出力:

{
    "authType": "custom",
    "name": "testAuthorizer",
    "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:newAuthorizer/invocations",
    "authorizerResultTtlInSeconds": 300,
    "identitySource": "method.request.header.Authorization",
    "type": "TOKEN",
    "id": "gfi4n3"
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスUpdateAuthorizer」の「」を参照してください。

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

AWS CLI

カスタムドメイン名のベースパスマッピングを変更するには

コマンド:

aws apigateway update-base-path-mapping --domain-name api.domain.tld --base-path prod --patch-operations op='replace',path='/basePath',value='v1'

出力:

{
    "basePath": "v1",
    "restApiId": "1234123412",
    "stage": "api"
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスUpdateBasePathMapping」の「」を参照してください。

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

AWS CLI

クライアント証明書の説明を更新するには

コマンド:

aws apigateway update-client-certificate --client-certificate-id a1b2c3 --patch-operations op='replace',path='/description',value='My new description'

  • API 詳細については、AWS CLI 「 コマンドリファレンスUpdateClientCertificate」の「」を参照してください。

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

AWS CLI

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

コマンド:

aws apigateway update-deployment --rest-api-id 1234123412 --deployment-id ztt4m2 --patch-operations op='replace',path='/description',value='newDescription'

出力:

{
    "description": "newDescription",
    "id": "ztt4m2",
    "createdDate": 1455218022
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスUpdateDeployment」の「」を参照してください。

次の例は、update-domain-name を使用する方法を説明しています。

AWS CLI

カスタムドメイン名の証明書名を変更するには

次のupdate-domain-name例では、カスタムドメインの証明書名を変更します。

aws apigateway update-domain-name \
    --domain-name api.domain.tld \
    --patch-operations op='replace',path='/certificateArn',value='arn:aws:acm:us-west-2:111122223333:certificate/CERTEXAMPLE123EXAMPLE'

出力:

{
    "domainName": "api.domain.tld",
    "distributionDomainName": "d123456789012.cloudfront.net",
    "certificateArn": "arn:aws:acm:us-west-2:111122223333:certificate/CERTEXAMPLE123EXAMPLE",
    "certificateUploadDate": 1462565487
}

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

  • API 詳細については、AWS CLI 「 コマンドリファレンスUpdateDomainName」の「」を参照してください。

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

AWS CLI

統合レスポンスヘッダーを '*' の静的マッピングに変更するには

コマンド:

aws apigateway update-integration-response --rest-api-id 1234123412 --resource-id 3gapai --http-method GET --status-code 200 --patch-operations op='replace',path='/responseParameters/method.response.header.Access-Control-Allow-Origin',value='"'"'*'"'"'

出力:

{
    "statusCode": "200",
    "responseParameters": {
        "method.response.header.Access-Control-Allow-Origin": "'*'"
    }
}

統合レスポンスヘッダーを削除するには

コマンド:

aws apigateway update-integration-response --rest-api-id 1234123412 --resource-id 3gapai --http-method GET --status-code 200 --patch-operations op='remove',path='/responseParameters/method.response.header.Access-Control-Allow-Origin'

  • API 詳細については、AWS CLI 「 コマンドリファレンスUpdateIntegrationResponse」の「」を参照してください。

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

AWS CLI

Input Passthrough で設定された「コンテンツタイプ: application/json」マッピングテンプレートを追加するには

コマンド:

aws apigateway update-integration \
    --rest-api-id a1b2c3d4e5 \
    --resource-id a1b2c3 \
    --http-method POST \
    --patch-operations "op='add',path='/requestTemplates/application~1json'"

カスタムテンプレートで設定された「コンテンツタイプ: application/json」マッピングテンプレートを更新 (置き換え) するには

コマンド:

aws apigateway update-integration \
    --rest-api-id a1b2c3d4e5 \
    --resource-id a1b2c3 \
    --http-method POST \
    --patch-operations "op='replace',path='/requestTemplates/application~1json',value='{"example": "json"}'"

Input Passthrough で「Content-Type: application/json」に関連付けられたカスタムテンプレートを更新 (置き換え) するには

コマンド:

aws apigateway update-integration \
    --rest-api-id a1b2c3d4e5 \
    --resource-id a1b2c3 \
    --http-method POST \
    --patch-operations "op='replace',path='requestTemplates/application~1json'"

「コンテンツタイプ: application/json」マッピングテンプレートを削除するには

コマンド:

aws apigateway update-integration \
    --rest-api-id a1b2c3d4e5 \
    --resource-id a1b2c3 \
    --http-method POST \
    --patch-operations "op='remove',path='/requestTemplates/application~1json'"

  • API 詳細については、AWS CLI 「 コマンドリファレンスUpdateIntegration」の「」を参照してください。

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

AWS CLI

メソッドで 200 レスポンスの新しいメソッドレスポンスヘッダーを作成し、不要として定義するには (デフォルト）

コマンド:

aws apigateway update-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 --patch-operations op="add",path="/responseParameters/method.response.header.custom-header",value="false"

メソッドで 200 レスポンスのレスポンスモデルを削除するには

コマンド:

aws apigateway update-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 --patch-operations op="remove",path="/responseModels/application~1json"

  • API 詳細については、AWS CLI 「 コマンドリファレンスUpdateMethodResponse」の「」を参照してください。

次の例は、update-method を使用する方法を説明しています。

AWS CLI

例 1: APIキーを要求するようにメソッドを変更するには

次のupdate-method例では、 メソッドを変更してAPIキーを要求します。

aws apigateway update-method \
    --rest-api-id 1234123412 \
    --resource-id a1b2c3 \
    --http-method GET \
    --patch-operations op="replace",path="/apiKeyRequired",value="true"

出力:

{
    "httpMethod": "GET",
    "authorizationType": "NONE",
    "apiKeyRequired": true,
    "methodResponses": {
        "200": {
            "statusCode": "200",
            "responseModels": {}
        }
    },
    "methodIntegration": {
        "type": "AWS",
        "httpMethod": "POST",
        "uri": "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:123456789111:function:hello-world/invocations",
        "passthroughBehavior": "WHEN_NO_MATCH",
        "contentHandling": "CONVERT_TO_TEXT",
        "timeoutInMillis": 29000,
        "cacheNamespace": "h7i8j9",
        "cacheKeyParameters": [],
        "integrationResponses": {
            "200": {
                "statusCode": "200",
                "responseTemplates": {}
            }
        }
    }
}

例 2: IAM認証を要求するようにメソッドを変更するには

次のupdate-method例では、IAM認証を要求するように メソッドを変更します。

aws apigateway update-method \
    --rest-api-id 1234123412 \
    --resource-id a1b2c3 \
    --http-method GET \
    --patch-operations op="replace",path="/authorizationType",value="AWS_IAM"

出力:

 {
    "httpMethod": "GET",
    "authorizationType": "AWS_IAM",
    "apiKeyRequired": false,
    "methodResponses": {
        "200": {
            "statusCode": "200",
            "responseModels": {}
        }
    },
    "methodIntegration": {
        "type": "AWS",
        "httpMethod": "POST",
        "uri": "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:123456789111:function:hello-world/invocations",
        "passthroughBehavior": "WHEN_NO_MATCH",
        "contentHandling": "CONVERT_TO_TEXT",
        "timeoutInMillis": 29000,
        "cacheNamespace": "h7i8j9",
        "cacheKeyParameters": [],
        "integrationResponses": {
            "200": {
                "statusCode": "200",
                "responseTemplates": {}
            }
        }
    }
}

例 3: Lambda 認証を要求するようにメソッドを変更するには

次のupdate-method例では、 メソッドを必要な Lambda 認証に変更します。

aws apigateway update-method --rest-api-id 1234123412 \
    --resource-id a1b2c3 \
    --http-method GET \
    --patch-operations op="replace",path="/authorizationType",value="CUSTOM" op="replace",path="/authorizerId",value="e4f5g6"

出力:

 {
    "httpMethod": "GET",
    "authorizationType": "CUSTOM",
    "authorizerId" : "e4f5g6",
    "apiKeyRequired": false,
    "methodResponses": {
        "200": {
            "statusCode": "200",
            "responseModels": {}
        }
    },
    "methodIntegration": {
        "type": "AWS",
        "httpMethod": "POST",
        "uri": "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:123456789111:function:hello-world/invocations",
        "passthroughBehavior": "WHEN_NO_MATCH",
        "contentHandling": "CONVERT_TO_TEXT",
        "timeoutInMillis": 29000,
        "cacheNamespace": "h7i8j9",
        "cacheKeyParameters": [],
        "integrationResponses": {
            "200": {
                "statusCode": "200",
                "responseTemplates": {}
            }
        }
    }
}

詳細については、「Amazon API Gateway デベロッパーガイド」のAPI「Gateway を使用した使用プランの作成、設定、テストCLIRESTAPI」と「APIGateway RESTAPIでの へのアクセスの制御と管理」を参照してください。

  • API 詳細については、AWS CLI 「 コマンドリファレンスUpdateMethod」の「」を参照してください。

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

AWS CLI

でモデルの説明を変更するには API

コマンド:

aws apigateway update-model --rest-api-id 1234123412 --model-name 'Empty' --patch-operations op=replace,path=/description,value='New Description'

でモデルのスキーマを変更するには API

コマンド:

aws apigateway update-model --rest-api-id 1234123412 --model-name 'Empty' --patch-operations op=replace,path=/schema,value='"{ \"$schema\": \"http://json-schema.org/draft-04/schema#\", \"title\" : \"Empty Schema\", \"type\" : \"object\" }"'

  • API 詳細については、AWS CLI 「 コマンドリファレンスUpdateModel」の「」を参照してください。

次の例は、update-resource を使用する方法を説明しています。

AWS CLI

リソースを移動し、 内の別の親リソースに配置するには API

コマンド:

aws apigateway update-resource --rest-api-id 1234123412 --resource-id 1a2b3c --patch-operations op=replace,path=/parentId,value='3c2b1a'

出力:

{
    "path": "/resource",
    "pathPart": "resource",
    "id": "1a2b3c",
    "parentId": "3c2b1a"
}

でリソース (pathPart) の名前を変更するには API

コマンド:

aws apigateway update-resource --rest-api-id 1234123412 --resource-id 1a2b3c --patch-operations op=replace,path=/pathPart,value=newresourcename

出力:

{
    "path": "/newresourcename",
    "pathPart": "newresourcename",
    "id": "1a2b3c",
    "parentId": "3c2b1a"
}

  • API 詳細については、AWS CLI 「 コマンドリファレンスUpdateResource」の「」を参照してください。

次の例は、update-rest-api を使用する方法を説明しています。

AWS CLI

の名前を変更するには API

コマンド:

aws apigateway update-rest-api --rest-api-id 1234123412 --patch-operations op=replace,path=/name,value='New Name'

の説明を変更するには API

コマンド:

aws apigateway update-rest-api --rest-api-id 1234123412 --patch-operations op=replace,path=/description,value='New Description'

  • API 詳細については、AWS CLI 「 コマンドリファレンスUpdateRestApi」の「」を参照してください。

次の例は、update-stage を使用する方法を説明しています。

AWS CLI

例 1: リソースとメソッドのステージ設定を上書きするには

次のupdate-stage例では、ステージ設定を上書きし、特定のリソースとメソッドの完全なリクエスト/レスポンスログ記録をオフにします。

aws apigateway update-stage \
    --rest-api-id 1234123412 \
    --stage-name 'dev' \
    --patch-operations op=replace,path=/~1resourceName/GET/logging/dataTrace,value=false

出力:

{
    "deploymentId": "5ubd17",
    "stageName": "dev",
    "cacheClusterEnabled": false,
    "cacheClusterStatus": "NOT_AVAILABLE",
    "methodSettings": {
        "~1resourceName/GET": {
            "metricsEnabled": false,
            "dataTraceEnabled": false,
            "throttlingBurstLimit": 5000,
            "throttlingRateLimit": 10000.0,
            "cachingEnabled": false,
            "cacheTtlInSeconds": 300,
            "cacheDataEncrypted": false,
            "requireAuthorizationForCacheControl": true,
            "unauthorizedCacheControlHeaderStrategy": "SUCCEED_WITH_RESPONSE_HEADER"
        }
    },
    "tracingEnabled": false,
    "createdDate": "2022-07-18T10:11:18-07:00",
    "lastUpdatedDate": "2022-07-18T10:19:04-07:00"
}

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

例 2: ステージのすべてのリソースとメソッドのAPIステージ設定を更新するには

次のupdate-stage例では、APIステージのすべてのリソースとメソッドの完全なリクエスト/レスポンスログ記録をオンにします。

aws apigateway update-stage \
    --rest-api-id 1234123412 \
    --stage-name 'dev' \
    --patch-operations 'op=replace,path=/*/*/logging/dataTrace,value=true'

出力:

{
    "deploymentId": "5ubd17",
    "stageName": "dev",
    "cacheClusterEnabled": false,
    "cacheClusterStatus": "NOT_AVAILABLE",
    "methodSettings": {
        "*/*": {
            "metricsEnabled": false,
            "dataTraceEnabled": true,
            "throttlingBurstLimit": 5000,
            "throttlingRateLimit": 10000.0,
            "cachingEnabled": false,
            "cacheTtlInSeconds": 300,
            "cacheDataEncrypted": false,
            "requireAuthorizationForCacheControl": true,
            "unauthorizedCacheControlHeaderStrategy": "SUCCEED_WITH_RESPONSE_HEADER"
        }
    },
    "tracingEnabled": false,
    "createdDate": "2022-07-18T10:11:18-07:00",
    "lastUpdatedDate": "2022-07-18T10:31:04-07:00"
}

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

  • API 詳細については、AWS CLI 「 コマンドリファレンスUpdateStage」の「」を参照してください。

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

AWS CLI

使用状況プランで定義された期間を変更するには

コマンド:

aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/quota/period",value="MONTH"

Usage Plan で定義されているクォータ制限を変更するには

コマンド:

aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/quota/limit",value="500"

使用プランで定義されているスロットルレート制限を変更するには

コマンド:

aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/throttle/rateLimit",value="10"

使用プランで定義されているスロットルバースト制限を変更するには

コマンド:

aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/throttle/burstLimit",value="20"

  • API 詳細については、AWS CLI 「 コマンドリファレンスUpdateUsagePlan」の「」を参照してください。

次の例は、update-usage を使用する方法を説明しています。

AWS CLI

使用状況プランで定義されている現在の期間のAPIキーのクォータを一時的に変更するには

コマンド:

aws apigateway update-usage --usage-plan-id a1b2c3 --key-id 1NbjQzMReAkeEQPNAW8r3dXsU2rDD7fc7f2Sipnu --patch-operations op="replace",path="/remaining",value="50"

  • API 詳細については、AWS CLI 「 コマンドリファレンスUpdateUsage」の「」を参照してください。