Trusted Advisor API の使用を開始する
AWS Trusted Advisor API リファレンスは、Trusted Advisor API 操作とデータ型に関する詳細な情報を必要とするプログラマーを対象としています。この API を使用すると、ご自分のアカウントまたは AWS 組織内のすべてのアカウントに関する Trusted Advisor 推奨事項にアクセスできます。この Trusted Advisor API は、JSON 形式で結果を返す HTTP メソッドを使用します。
注記
-
Trusted Advisor API を使用するには、Business、Enterprise On-Ramp、または Enterprise Support プランが必要
-
Business、Enterprise On-Ramp、または Enterprise Support プランのないアカウントから AWS Trusted Advisor APIを呼び出した場合は、アクセスが拒否の例外が発生します。Support プランの変更について詳しくは、「AWS サポート」を参照してください。
AWS Trusted Advisor API を使用して、チェックとその説明、推奨事項、および推奨事項に関するリソースのリストを取得できます。また、推奨事項のライフサイクルを更新することもできます。推奨事項を管理するには、以下の API オペレーションを使用します。
-
ListChecks、LestRecommendations、GetRecommendation、ListRecommendationResources API オペレーションを使用して、推奨事項とそれに対応するアカウントやリソースを表示します。
-
UpdateRecommendationLifecycle API オペレーションを使用すると、Trusted Advisor Priority によって管理されている推奨事項のライフサイクルを更新できます。
-
BatchUpdateRecommendationResourceExclusion API オペレーションを使用して、Trusted Advisor の結果に 1 つ以上のリソースを含めるか除外します。
-
ListOrganizationRecommendations、GetOrganizationRecommendation、ListOrganizationRecommendationResources、ListOrganizationRecommendationAccounts および UpdateOrganizationRecommendationLifecycle API コールは、Trusted Advisor Priority によって管理されている推奨事項のみをサポートします。これらの推奨事項は優先推奨事項とも呼ばれます。Trusted Advisor Priority を有効にしている場合は、管理者アカウントまたは委任管理者アカウントから、優先順位を付けた推奨事項を表示および管理できます。Priority が有効になっていない場合、リクエストを行うとアクセス拒否の例外が表示されます。
詳細については、AWS サポートユーザーガイドの AWS Trusted Advisorを参照してください。
リクエストの認証については、「署名バージョン 4 の署名プロセス」を参照してください。