AWS CLI で SubscriptionRequiredException が発生するときの対処方法

AWSテクニカルサポートノート

#AWS

#AWS CLI

#AWS Health API

hato

2023.07.27

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

困っていた内容

Health Dashboard の情報を AWS CLI で取得したいです。
AWS CLI のリファレンスを参考にコマンドを実行しましたがSubscriptionRequiredExceptionというエラーが表示されます。なぜでしょうか。

$ aws health describe-events

An error occurred (SubscriptionRequiredException) when calling the DescribeEvents operation:

どう対応すればいいの?

AWS サポートのプランを確認してください。

AWS Support Console

Health API を使用するには、Amazon Web Services サポート（AWS サポート）で次のいずれかのプランに加入している必要があります。

Business
Enterprise On-Ramp
Enterprise

上記画像のように Basic プランや、Developer プランに加入している状態で、Health API にアクセスすると SubscriptionRequiredExceptionとなります。

そのため、Health API が使用できるプランに加入しているか確認頂き、必要に応じてプラン変更もご検討ください。
また、ログインしているアカウントに間違いがないか、ご確認ください。

なお、同様に Support API も対象のプランに加入していない場合は、SubscriptionRequiredExceptionとなります。

参考資料

health — AWS CLI 2.13.4 Command Reference

You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from Amazon Web Services Support to use the Health API. If you call the Health API from an Amazon Web Services account that doesn’t have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a SubscriptionRequiredException error.

support — AWS CLI 2.13.4 Command Reference

If you call the Amazon Web Services Support API from an account that doesn’t have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears.