ListRegions - AWS アカウント管理
リクエストの構文URI リクエストパラメータリクエストボディレスポンスの構文レスポンス要素エラー以下の資料も参照してください。

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

ListRegions

特定のアカウントのすべてのリージョンと、それぞれのオプトインステータスをリストします。オプションで、このリストを region-opt-status-contains パラメータでフィルタリングできます。

リクエストの構文

POST /listRegions HTTP/1.1
Content-type: application/json

{
   "AccountId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "RegionOptStatusContains": [ "string" ]
}

URI リクエストパラメータ

リクエストでは URI パラメータを使用しません。

リクエストボディ

リクエストは以下の JSON 形式のデータを受け入れます。

AccountId

このオペレーションでアクセスまたは変更する AWS アカウントの 12 桁のアカウント ID 番号を指定します。このパラメータを指定しない場合、デフォルトで、オペレーションの呼び出しに使用された ID の Amazon Web Services アカウントになります。このパラメータを使用するには、呼び出し元が組織の管理アカウントまたは委任管理者アカウントの ID である必要があります。指定されたアカウント ID は、同じ組織のメンバーアカウントである必要があります。組織はすべての機能を有効にして、アカウント管理サービス用の有効な信頼されたアクセスを持つ必要があり、オプションとして委任管理者アカウントが割り当てられます。

注記

管理アカウントは、自身の AccountId を指定することはできません。AccountId パラメータを含めずに、スタンドアロンコンテキストでオペレーションを呼び出す必要があります。

組織のメンバーではないアカウントに対してこのオペレーションを呼び出す場合は、このパラメータを指定しないでください。代わりに、連絡先を取得または変更するアカウントに属する ID を使用してオペレーションを呼び出します。

型: 文字列

パターン: ^\d{12}$

必須: いいえ

MaxResults

コマンドの出力で返される項目の総数。使用可能な項目の総数が指定された値を上回る場合、コマンドの出力で NextToken が提供されます。ページ分割を再開するには、後続コマンドの starting-token 引数で NextToken 値を指定します。AWS CLI の範囲外で NextToken レスポンス要素を直接使用しないでください。使用例については、「 AWS コマンドラインインターフェイスユーザーガイド」の「ページ分割」を参照してください。

型: 整数

有効範囲: 最小値 は 1 です。最大値は 50 です。

必須：いいえ

NextToken

ページ分割の開始場所を指定するために使用されるトークン。これは、以前に切り捨てられた応答からの NextToken です。使用例については、「 AWS コマンドラインインターフェイスユーザーガイド」の「ページ分割」を参照してください。

型: 文字列

長さの制限: 最小長は 0 です。最大長は 1,000 です。

必須：いいえ

RegionOptStatusContains

特定のアカウントのリージョンのリストをフィルタリングするために使用するリージョンステータス (有効化中、有効、無効化中、無効、デフォルトで有効) のリスト。例えば、値 ENABLING を渡すと、リージョンステータスが ENABLING であるリージョンのリストのみが返されます。

型: 文字列の配列

有効な値: ENABLED | ENABLING | DISABLING | DISABLED | ENABLED_BY_DEFAULT

必須：いいえ

レスポンスの構文

HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Regions": [ 
      { 
         "RegionName": "string",
         "RegionOptStatus": "string"
      }
   ]
}

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

NextToken

返されるデータがさらにある場合、これが設定されます。list-regions の next-token リクエストパラメータに渡す必要があります。

型: 文字列

Regions

これは、特定のアカウントのリージョンのリストです。あるいは、フィルタリングされたパラメータが使用された場合は、filter パラメータで設定されたフィルタ条件に一致するリージョンのリストです。

型: Region オブジェクトの配列

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

AccessDeniedException

呼び出し元の ID に必要な最小アクセス許可がないため、操作が失敗しました。

HTTP ステータスコード: 403

InternalServerException

AWS への内部エラーのため、操作が失敗しました。後でもう一度操作をお試しください。

HTTP ステータスコード：500

TooManyRequestsException

操作が頻繁に呼び出され、スロットルの制限を超えているため、操作が失敗しました。

HTTP ステータスコード: 429

ValidationException

入力パラメータのいずれかが無効であるため、操作が失敗しました。

HTTP ステータスコード：400

以下の資料も参照してください。

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。