DescribeOrderableDBInstanceOptions - Amazon DocumentDB

DescribeOrderableDBInstanceOptions

指定されたエンジンの指示可能なインスタンスオプションのリストを返します。

リクエストパラメータ

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

Engine

インスタンスオプションを取得するエンジン名。

型: 文字列

必須: はい

DBInstanceClass

The instance class filter value。このパラメータを指定すると、指定したインスタンスクラスに一致する利用可能なオファリングみが表示されます。

型: 文字列

必須: いいえ

EngineVersion

エンジンバージョンフィルターの値。このパラメータを指定すると、指定したエンジンのバージョンに一致する利用可能なオファリングみが表示されます。

型: 文字列

必須: いいえ

Filters.Filter.N

このパラメータは、現在サポートされていません。

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

必須:いいえ

LicenseModel

ライセンスモデルフィルター値。このパラメータを指定すると、指定したエンジンのバージョンに一致する利用可能なライセンスモデルのみが表示されます。

型: 文字列

必須: いいえ

Marker

以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには MaxRecords で指定された値まで、マーカーを超えるレコードのみが含まれます。

型: 文字列

必須: いいえ

MaxRecords

レスポンスに含めるレコードの最大数。指定された MaxRecords の値よりも多くのレコードが存在する場合、ページ割りトークン (マーカー) がレスポンスに含まれるため、残りの結果を取得できます。

デフォルト: 100

制約: 最小 20、最大 100。

型: 整数

必須:いいえ

Vpc

仮想プライベートクラウド (VPC) フィルター値。このパラメータを指定すると、 VPC 環境または非 VPC 環境のみが表示されます。

型: ブール値

必須:いいえ

レスポンス要素

以下の要素がサービスによって返されます。

Marker

以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには MaxRecords で指定された値まで、マーカーを超えるレコードのみが含まれます。

型: 文字列

OrderableDBInstanceOptions.OrderableDBInstanceOption.N

特定の指示可能なインスタンスで使用できるオプション。

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

エラー

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

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

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