AWS Support API について
AWS Support API を使用すると、AWS サポートセンター
API は、オペレーションの 2 つのグループを提供します。
-
作成から解決までの AWS サポートケースのライフサイクル全体を管理する サポートケース管理 オペレーション
-
AWS Trusted Advisor チェックにアクセスする Trusted Advisor オペレーション
AWS Support API を使用するには、Business、Enterprise On-Ramp、または Enterprise Support プランが必要です。(=AWS Support) 詳細については、「
AWS Support が提供するオペレーションとデータ型の詳細については、AWS SupportAPI リファレンスを参照してください。
サポートケース管理
API を使用して、次のタスクを実行できます。
-
サポートケースを開く
-
最近のサポートケースに関する詳細情報と一覧を取得する
-
日付やケース ID でサポートケースをフィルターする (解決積みのケースを含む)。
-
ケースに通信文やファイル添付を追加し、ケースの通信にメール受信者を追加する
-
ケースを解決する
AWS Support API は、CloudTrail でのサポートケース管理オペレーションのログ記録がサポートされています。詳細については、「AWS Support による AWS CloudTrail API 呼び出しのログ記録」を参照してください。
サポートケースのライフサイクル全体を管理する方法を示す Java コードの例については、「AWS Support ケースのプログラミング」を参照してください。
Trusted Advisor
Trusted Advisor オペレーションを使用して、次のタスクを実行できます。
-
Trusted Advisor チェックの名前と ID を取得する
-
Trusted Advisor チェックを自分の AWS アカウントとリソースに対して実行することを要求する
-
Trusted Advisor チェック結果のサマリーと詳細情報を取得する
-
Trusted Advisor チェックを更新する
-
各 Trusted Advisor チェックのステータスを取得する
AWS Support API は、CloudTrail での Trusted Advisor オペレーションのログ記録がサポートされています。詳細については、「AWS Trusted AdvisorCloudTrail ログの 情報」を参照してください。
Amazon CloudWatch Events を使用して、Trusted Advisor のチェック結果に対する変更をモニタリングできます。詳細については、「Amazon EventBridge を使用した AWS Trusted Advisor チェック結果のモニタリング」を参照してください。
Trusted Advisor オペレーションの使用方法を示す Java コードの例については、「ウェブサービスとしての Trusted Advisor の使用」を参照してください。
Endpoint
以下のエンドポイントを使用して AWS Support APIにアクセスできます。
-
https://support.us-east-1.amazonaws.com
AWS Supportエンドポイントは、運用環境のデータベースにケースを作成します。テストサポートケースを作成する場合は、CreateCase オペレーションを呼び出すときに「テストケース - 無視してください」などの件名行を含めることをお勧めします。テストが完了したら、ResolveCase オペレーションを呼び出してケースを解決します。
AWS エンドポイントの使用に関する詳細情報については、Amazon Web Services 全般のリファレンスの「リージョンエンドポイント」を参照してください。
AWS SDK でのサポート
AWS Command Line Interface (AWS CLI) および AWS ソフトウェア開発キット (SDK) には AWS Support API のサポートが含まれています。
AWS Support API をサポートする言語のリストについては、オペレーション名 (CreateCase など) を選択し、「See Also」(参照) セクションで目的の言語を選択します。