API リファレンス - AWS アカウント管理

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

API リファレンス

アカウント管理の API 操作 (account) 名前空間を使用すると、AWS アカウント を変更できるようになります。

すべての AWS アカウント は、アカウントに関連付けられた最大 3 つの代替連絡先に関する情報を含む、アカウントに関する情報を含むメタデータをサポートします。これらは、に関連付けられている電子メールアドレスに追加されますルートユーザアカウントの。アカウントに関連付けられている次の各連絡先タイプのいずれか 1 つのみを指定できます。

  • 請求に関するお問い合わせ先

  • 操作問い合わせ先

  • セキュリティ問い合わせ先

デフォルトでは、このガイドで説明する API 操作は、操作を呼び出すアカウントに直接適用されます。操作を呼び出しているアカウントのアイデンティティは、通常 IAM ロールまたは IAM ユーザーがあり、API 操作を呼び出すには IAM ポリシーによって適用されるアクセス権限が必要です。または、AWS Organizations 管理アカウントの ID からこれらの API 操作を呼び出し、組織のメンバーである AWS アカウント の任意のアカウント ID 番号を指定します。

API バージョン

このバージョンの「アカウント API リファレンス」には、「アカウント管理 API バージョン 2021-02-01」と記載されています。

注記

API を直接使用する代わりに、さまざまなプログラム言語およびプラットフォームのライブラリやサンプルコード (Java、Ruby、.NET、iOS、Android など)から成るAWSSDK のひとつを使用できます。SDK は、プログラムによる AWS 組織へのアクセス権を作成するのに便利な方法を提供します。例えば、SDK では暗号を使用して要求に署名したり、エラーを管理したり、要求を自動的に再試行したりすることができます。AWS SDK のダウンロードおよびインストール方法の詳細については、「Amazon Web Services 用ツール」を参照してください。

AWS SDK を使用してアカウント管理サービスへプログラマティックな API 呼び出しを行うことをお勧めします。ただし、アカウント管理クエリ API を使用して、アカウント管理 Web サービスを直接呼び出すこともできます。アカウント管理クエリ API の詳細については、以下を参照してください。HTTP クエリリクエストを作成して API を呼び出すアカウント管理ユーザーガイドにあります。組織はすべてのアクションの GET リクエストと POST リクエストをサポートしています。つまり、API は、あるアクションに対しては GET を、他のアクションに対しては POST をといった使い分けを必要としません。しかしながら、GET リクエストは URL のサイズに制限があります。したがって、より大きなサイズを必要とする操作の場合は、POST リクエストを使用します。

リクエストへの署名

AWS に HTTP リクエストを送る際、AWS が送信元を特定できるよう、リクエストに署名なければなりません。リクエストには、AWS アクセスキーを使用して署名します。このアクセスキーは、アクセスキー ID とシークレットアクセスキーで構成されています。ルートアカウントのアクセスキーを作成しないことを強くお勧めします。ルートアカウントのアクセスキーを持っていれば誰でも、アカウントのすべてのリソースに無制限にアクセスできます。代わりに、管理者権限を持つ IAM ユーザー用のアクセスキーを作成してください。別のオプションとして、AWS セキュリティトークンサービスを使用して、一時的なセキュリティ認証情報を生成し、それらの認証情報を使用してリクエストに署名します。

リクエストをサインアップする際には、署名バージョン 4 の使用が推奨されます。Signature バージョン 2 を使用する既存のアプリケーションがある場合は、Signature バージョン 4 を使用するために更新する必要はありません。ただし、一部の操作では、Signature バージョン 4 が必要です。バージョン 4 を必要とする操作のドキュメントには、この要件が示されています。詳細については、「IAM ユーザーガイド」の「AWS API リクエストの署名」を参照してください。

AWS コマンドラインインターフェイス (AWS CLI) または AWS SDK のいずれかを使用して AWS へのリクエストを作成する場合、これらのツールにより、ツールの設定時に指定したアクセスキーを使用して自動的にリクエストが署名されます。

アカウント管理のサポートとフィードバック

ご意見をお待ちしております。コメントを feedback-awsaccounts@amazon.com] 宛てに送信するか、アカウント管理サポートフォーラムにフィードバックと質問を掲載してください。AWS サポートフォーラムの詳細については、フォーラムヘルプを参照してください。

例が提示される方法

リクエストに対する応答としてアカウント管理によって返される JSON は、改行や書式空白を含まない単一の長い文字列として返されます。読みやすさを向上させるために、このガイドの例には改行と空白の両方を示します。入力パラメータの例で画面を超えて長い文字列が生成される場合は、読みやすさを向上させるために改行を挿入します。入力は常に 1 つの JSON テキスト文字列として送信する必要があります。

API リクエストの記録

アカウント管理サポートCloudTrail、記録するサービスAWSあなたの API コールAWS アカウントログファイルを Amazon S3 バケットに配信します。によって収集された情報を使用してCloudTrail、Account Management へのどのリクエストが正常に行われたか、誰がリクエストを行ったか、いつ実行されたかなどを判断できます。アカウント管理とそのサポートについての詳細CloudTrail、を参照してくださいログ記録AWSを使用したアカウント管理 API 呼び出しAWS CloudTrail。詳しく知るにはCloudTrail有効にする方法やログファイルを見つける方法については、を参照してください。AWS CloudTrailユーザーガイド