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

特定のアカウントのリージョンのリストをフィルタリングするために使用するリージョンステータス (有効化、有効化、無効化、無効化、有効化_by_default) のリスト。例えば、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

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

型: 文字列

Regions

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

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

エラー

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

AccessDeniedException

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

HTTP ステータスコード: 403

InternalServerException

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

HTTP ステータスコード：500

TooManyRequestsException

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

HTTP ステータスコード: 429

ValidationException

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

HTTP ステータスコード：400

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

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