翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
GetGovCloudAccountInformation
GovCloud アカウント ID と状態など、指定された標準アカウント (存在する場合) にリンクされた GovCloud アカウントに関する情報を取得します。この API を使用するには、IAM ユーザーまたはロールに account:GetGovCloudAccountInformation IAM アクセス許可が必要です。
リクエストの構文
POST /getGovCloudAccountInformation HTTP/1.1
Content-type: application/json
{
"StandardAccountId": "string"
}
URI リクエストパラメータ
リクエストでは URI パラメータを使用しません。
リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
- StandardAccountId
-
このオペレーションでアクセスまたは変更するアカウントの 12 桁の AWS アカウント ID 番号を指定します。
このパラメータを指定しない場合、デフォルトで オペレーションの呼び出しに使用される ID の AWS アカウントになります。
このパラメータを使用するには、呼び出し元が組織の管理アカウントまたは委任管理者アカウント、および指定されたアカウント ID は、同じ組織内のメンバーアカウントである必要があります。組織はすべての機能を有効化して、アカウント管理サービス用の有効な信頼されたアクセスを持つ必要があり、オプションとして委任管理者アカウントが割り当てられます。
注記
管理アカウントは独自の
AccountIdアカウントを指定できません; これは、AccountIdパラメータを含めないことにより、スタンドアロンコンテキストでの操作を呼び出さなければなりません。組織のメンバーではないアカウントでこの操作を呼び出すには、このパラメータを指定せず、取得または変更する取引先責任者のアカウントに属する ID を使用して操作を呼び出します。
タイプ: 文字列
パターン:
\d{12}必須: いいえ
レスポンスの構文
HTTP/1.1 200
Content-type: application/json
{
"AccountState": "string",
"GovCloudAccountId": "string"
}
レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- AccountState
-
リンクされた GovCloud アカウントのアカウント状態。
型: 文字列
有効な値:
PENDING_ACTIVATION | ACTIVE | SUSPENDED | CLOSED - GovCloudAccountId
-
リンクされた GovCloud アカウントの 12 桁のアカウント ID 番号。
タイプ: 文字列
パターン:
\d{12}
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- AccessDeniedException
-
呼び出し元の ID に必要な最小アクセス許可がないため、操作が失敗しました。
- errorType
-
API Gateway によって
x-amzn-ErrorTypeレスポンスヘッダーに入力された値。
HTTP ステータスコード: 403
- InternalServerException
-
内部エラーのため、オペレーションが失敗しました AWS。後でもう一度操作をお試しください。
- errorType
-
API Gateway によって
x-amzn-ErrorTypeレスポンスヘッダーに入力された値。
HTTP ステータスコード: 500
- ResourceNotFoundException
-
見つからないリソースが指定されているため、操作が失敗しました。
- errorType
-
API Gateway によって
x-amzn-ErrorTypeレスポンスヘッダーに入力された値。
HTTP ステータスコード: 404
- ResourceUnavailableException
-
現在利用できないリソースが指定されているため、オペレーションは失敗しました。
- errorType
-
API Gateway によって
x-amzn-ErrorTypeレスポンスヘッダーに入力された値。
HTTP ステータスコード: 424
- TooManyRequestsException
-
操作が頻繁に呼び出され、スロットルの制限を超えているため、操作が失敗しました。
- errorType
-
API Gateway によって
x-amzn-ErrorTypeレスポンスヘッダーに入力された値。
HTTP ステータスコード: 429
- ValidationException
-
入力パラメータのいずれかが無効であるため、操作が失敗しました。
- fieldList
-
無効なエントリが検出されたフィールド。
- message
-
リクエストのどの部分が無効だったかを知らせるメッセージ。
- reason
-
検証が失敗した理由。
HTTP ステータスコード: 400
例
例 1
次の の例では、 オペレーションの呼び出しに認証情報が使用されるアカウントのリンクされた GovCloud アカウント情報を取得します。
リクエスト例
POST / HTTP/1.1
X-Amz-Target: AWSAccountV20210201.GetGovCloudAccountInformation
{}
レスポンス例
HTTP/1.1 200 OK
Content-Type: application/json
{
"GovCloudAccountId": "123456789012",
"AccountState": "ACTIVE"
}
例 2
次の の例では、組織内の指定されたメンバーアカウントのリンクされた GovCloud アカウント情報を取得します。組織の管理アカウントまたはアカウント管理サービスの委任管理者アカウントの認証情報を使用する必要があります。
リクエスト例
POST / HTTP/1.1
X-Amz-Target: AWSAccountV20210201.GetGovCloudAccountInformation
{
"StandardAccountId": "111111111111"
}
レスポンス例
HTTP/1.1 200 OK
Content-Type: application/json
{
"GovCloudAccountId": "123456789012",
"AccountState": "ACTIVE"
}
例 3
次の例では、GovCloud アカウントにリンクされていない標準アカウントのリンクされた GovCloud アカウント情報を取得しようとします。
リクエスト例
POST / HTTP/1.1
X-Amz-Target: AWSAccountV20210201.GetGovCloudAccountInformation
{
"StandardAccountId": "222222222222"
}
レスポンス例
HTTP/1.1 404
Content-Type: application/json
{
"message":"GovCloud Account ID not found for Standard Account - 222222222222."
}
以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。