API Gateway で API ドキュメントへのアクセスを制御する

API ドキュメントの執筆と編集を行う専用ドキュメントチームを持っている場合、デベロッパー (API 開発用) と執筆者および編集者 (コンテンツ開発用) に別個のアクセス権限を設定することができます。これは特に、サードパーティベンダーがドキュメントの作成に関与している場合に適しています。

API ドキュメントを作成、更新、発行するアクセス許可をドキュメントチームに付与するには、次の IAM ポリシーを持つ IAM ロールをドキュメントチームに割り当てることができます。ここで、account_id はドキュメントチームの AWS アカウント ID です。

{
  "Version": "2012-10-17",
  "Statement": [

    {
      "Sid": "StmtDocPartsAddEditViewDelete",
      "Effect": "Allow",
      "Action": [
        "apigateway:GET",
        "apigateway:PUT",
        "apigateway:POST",
        "apigateway:PATCH",
        "apigateway:DELETE"
      ],
      "Resource": [
        "arn:aws:apigateway::account_id:/restapis/*/documentation/*"
      ]
    }
  ]
}

API Gateway リソースにアクセスするためのアクセス許可の設定については、「Amazon API Gateway と IAM の連携方法」を参照してください。