その他の Neptune API

アクション:

• AddTagsToResource (アクション)

• ListTagsForResource (アクション)

• RemoveTagsFromResource (アクション)

• ApplyPendingMaintenanceAction (アクション)

• DescribePendingMaintenanceActions (アクション)

• DescribeDBEngineVersions (アクション)

構造:

• DBEngineVersion (構造)

• EngineDefaults (構造)

• PendingMaintenanceAction (構造)

• ResourcePendingMaintenanceActions (構造)

• UpgradeTarget (構造)

• タグ (構造)

AddTagsToResource (アクション)

        この API の AWS CLI 名は add-tags-to-resource です。

Amazon Neptune リソースにメタデータタグを追加します。これらのタグは、Amazon Neptune リソースに関連するコストを追跡するためのコスト割り当てレポートで使用することも、Amazon Neptune の IAM ポリシーの Condition ステートメントで使用することもできます。

リクエスト

• ResourceName (CLI では: --resource-name) — 必須: タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

  タグが追加された Amazon Neptune リソース。この値は Amazon リソースネーム (ARN) です。ARN 作成の詳細については、「Amazon リソースネーム (ARN) の構築」を参照してください。

• Tags (CLI では: --tags) - 必須: Tag オブジェクトの配列。

  Amazon Neptune リソースに割り当てられるタグ。

レスポンス

• 応答パラメータはありません。

エラー

• DBInstanceNotFoundFault

• DBSnapshotNotFoundFault

• DBClusterNotFoundFault

ListTagsForResource (アクション)

        この API の AWS CLI 名は list-tags-for-resource です。

Amazon Neptune リソースのすべてのタグを一覧表示します。

リクエスト

• Filters (CLI では: --filters) - フィルター オブジェクトの配列。

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

• ResourceName (CLI では: --resource-name) — 必須: タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

  一覧されるタグを持つ Amazon Neptune リソース。この値は Amazon リソースネーム (ARN) です。ARN 作成の詳細については、「Amazon リソースネーム (ARN) の構築」を参照してください。

レスポンス

• TagList – Tag オブジェクトの配列。

  ListTagsForResource オペレーションによって返されるタグのリスト。

エラー

• DBInstanceNotFoundFault

• DBSnapshotNotFoundFault

• DBClusterNotFoundFault

RemoveTagsFromResource (アクション)

        この API の AWS CLI 名は remove-tags-from-resource です。

Amazon Neptune リソースからメタデータタグを削除します。

リクエスト

• ResourceName (CLI では: --resource-name) — 必須: タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

  タグが削除された Amazon Neptune リソース。この値は Amazon リソースネーム (ARN) です。ARN 作成の詳細については、「Amazon リソースネーム (ARN) の構築」を参照してください。

• TagKeys (CLI では: --tag-keys) — 必須: タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

  削除するタグのタグキー (名前)。

レスポンス

• 応答パラメータはありません。

エラー

• DBInstanceNotFoundFault

• DBSnapshotNotFoundFault

• DBClusterNotFoundFault

ApplyPendingMaintenanceAction (アクション)

        この API の AWS CLI 名は apply-pending-maintenance-action です。

保留中のメンテナンスアクションをリソース (たとえば DB インスタンス) に適用します。

リクエスト

• ApplyAction (CLI では: --apply-action) — 必須: タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

  このリソースに適用する保留中のメンテナンスアクション。

  有効な値: system-update、db-upgrade

• OptInType (CLI では: --opt-in-type) — 必須: タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

  オプトインリクエストのタイプを指定するか、オプトインクエストを元に戻す値。タイプが immediate のオプトインリクエストは元に戻すことができません。

  有効な値:

  • immediate - メンテナンスアクションをすぐに適用します。

  • next-maintenance - リソースの次のメンテナンスウィンドウ中にメンテナンスアクションを適用します。

  • undo-opt-in - 既存の next-maintenance オプトインリクエストをキャンセルします。

• ResourceIdentifier (CLI では: --resource-identifier) — 必須: タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

  保留中のアクションが適用されるリソースの Amazon リソースネーム (ARN)。ARN 作成の詳細については、「Amazon リソースネーム (ARN) の構築」を参照してください。

レスポンス

リソースに対する保留中のメンテナンスアクションについて説明します。

• PendingMaintenanceActionDetails – PendingMaintenanceAction オブジェクトの配列。

  リソースの保留中のメンテナンスアクションに関する詳細を提供するリスト。

• ResourceIdentifier — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

  保留中のメンテナンスアクションがあるリソースの ARN。

エラー

• ResourceNotFoundFault

DescribePendingMaintenanceActions (アクション)

        この API の AWS CLI 名は describe-pending-maintenance-actions です。

少なくとも 1 つの保留中のメンテナンスアクションを含むリソース (例: DB インスタンス) のリストを返します。

リクエスト

• Filters (CLI では: --filters) - フィルター オブジェクトの配列。

  保留中のメンテナンスアクションを返す 1 つ以上のリソースを指定するフィルター。

  サポートされているフィルター:

  • db-cluster-id - DB クラスター識別子と DB クラスターの Amazon リソースネーム (ARN) を受け入れます。結果のリストには、これらの ARN で識別された DB クラスターの保留中のメンテナンスアクションのみが含まれます。

  • db-instance-id - DB インスタンス識別子と DB インスタンス ARN を受け入れます。結果のリストには、これらの ARN で識別された DB インスタンスの保留中のメンテナンスアクションのみが含まれます。

• Marker (CLI では: --marker) — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

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

• MaxRecords (CLI では: --max-records) — IntegerOptional、タイプ: integer (符号付き 32 ビット整数)。

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

  デフォルト: 100

  制約: 最小 20、最大 100。

• ResourceIdentifier (CLI では: --resource-identifier) — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

  保留中のメンテナンスアクションを返すリソースの ARN。

レスポンス

• Marker — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

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

• PendingMaintenanceActions – ResourcePendingMaintenanceActions オブジェクトの配列。

  リソースに対する保留中のメンテナンスアクションのリスト。

エラー

• ResourceNotFoundFault

DescribeDBEngineVersions (アクション)

        この API の AWS CLI 名は describe-db-engine-versions です。

利用可能な DB エンジンのリストを返します。

リクエスト

• DBParameterGroupFamily (CLI では: --db-parameter-group-family) — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

  詳細を返す特定の DB パラメータグループファミリーの名前。

  制約:

  • 指定した場合、既存の DBParameterGroupFamily と一致する必要があります。

• DefaultOnly (CLI では: --default-only) — ブール値、タイプ: boolean (ブール値 (真または偽))。

  指定されたエンジンまたはエンジンとメジャーバージョンの組み合わせのデフォルトバージョンのみが返されることを示します。

• Engine (CLI では: --engine) — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

  返されるデータベースエンジン。

• EngineVersion (CLI では: --engine-version) — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

  返されるデータベースエンジンのバージョン。

  例: 5.1.49

• Filters (CLI では: --filters) - フィルター オブジェクトの配列。

  現在サポートされていません。

• ListSupportedCharacterSets (CLI では: --list-supported-character-sets) — BooleanOptional、タイプ: boolean (ブール値 (真または偽))。

  このパラメータが指定され、要求されたエンジンが CreateDBInstance に対して CharacterSetName パラメータをサポートしている場合、レスポンスには各エンジンバージョンでサポートされている文字セットのリストが含まれます。

• ListSupportedTimezones (CLI では: --list-supported-timezones) — BooleanOptional、タイプ: boolean (ブール値 (真または偽))。

  このパラメータが指定され、要求されたエンジンが CreateDBInstance に対して TimeZone パラメータをサポートしている場合、レスポンスには各エンジンバージョンでサポートされているタイムゾーンのリストが含まれます。

• Marker (CLI では: --marker) — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

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

• MaxRecords (CLI では: --max-records) — IntegerOptional、タイプ: integer (符号付き 32 ビット整数)。

  レスポンスに含めるレコードの最大数。指定された MaxRecords の値よりも多くのレコードが利用可能な場合、マーカーと呼ばれるページ分割トークンがレスポンスに含まれるため、以下の結果を取得できます。

  デフォルト: 100

  制約: 最小 20、最大 100。

レスポンス

• DBEngineVersions – DBEngineVersion オブジェクトの配列。

  DBEngineVersion 要素のリスト。

• Marker — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

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

構造:

DBEngineVersion (構造)

このデータ型は、DescribeDBEngineVersions (アクション) アクションのレスポンス要素として使用されます。

フィールド

• DBEngineDescription — 文字列、タイプ:string (UTF-8 でエンコードされた文字列)。

  データベースエンジンの説明。

• DBEngineVersionDescription — 文字列、タイプ:string (UTF-8 でエンコードされた文字列)。

  データベースエンジンのバージョンの説明。

• DBParameterGroupFamily — 文字列、タイプ:string (UTF-8 でエンコードされた文字列)。

  データベースエンジンの DB パラメータグループファミリーの名前。

• Engine — 文字列、タイプ:string (UTF-8 でエンコードされた文字列)。

  データベースエンジンの名前。

• EngineVersion — 文字列、タイプ:string (UTF-8 でエンコードされた文字列)。

  データベースエンジンのバージョン番号。

• ExportableLogTypes — 文字列、タイプ:string (UTF-8 でエンコードされた文字列)。

  データベースエンジンが CloudWatch Logs にエクスポートできるログのタイプ。

• SupportedTimezones — タイムゾーン オブジェクトの配列。

  CreateDBInstance アクションの Timezone パラメータに対してこのエンジンでサポートされているタイムゾーンのリスト。

• SupportsGlobalDatabases — ブール値、タイプ: boolean (ブール値 (真または偽))。

  特定の DB エンジンバージョンを持つ Aurora グローバルデータベースを使用できるかどうかを示す値。

• SupportsLogExportsToCloudwatchLogs — ブール値、タイプ: boolean (ブール値 (真または偽))。

  エンジンのバージョンが ExportableLogTypes で指定されたログタイプの CloudWatch Logs へのエクスポートをサポートするかどうかを示す値。

• SupportsReadReplica — ブール値、タイプ: boolean (ブール値 (真または偽))。

  データベースエンジンのバージョンがリードレプリカをサポートしているかどうかを示します。

• ValidUpgradeTarget — UpgradeTarget オブジェクトの配列。

  このデータベースエンジンのバージョンをアップグレードできるエンジンのバージョンのリスト。

EngineDefaults (構造)

DescribeEngineDefaultParameters (アクション) アクションの呼び出しが成功した結果が含まれています。

フィールド

• DBParameterGroupFamily — 文字列、タイプ:string (UTF-8 でエンコードされた文字列)。

  エンジンのデフォルトパラメータが適用される DB パラメータグループファミリーの名前を指定します。

• Marker — 文字列、タイプ:string (UTF-8 でエンコードされた文字列)。

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

• Parameters — パラメータ オブジェクトの配列。

  エンジンのデフォルトパラメータのリストが含まれます。

EngineDefaults は、以下のレスポンス要素として使用されます。

• DescribeEngineDefaultParameters

• DescribeEngineDefaultClusterParameters

PendingMaintenanceAction (構造)

リソースの保留中のメンテナンスアクションに関する情報を入力します。

フィールド

• Action — 文字列、タイプ:string (UTF-8 でエンコードされた文字列)。

  リソースに対して使用可能な保留中のメンテナンスアクションのタイプ。

• AutoAppliedAfterDate — TStamp、タイプ: timestamp (通常、1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定時点)。

  アクションが適用されたときのメンテナンスウィンドウの日付。メンテナンスアクションは、この日以降の最初のメンテナンスウィンドウ中にリソースに適用されます。この日付を指定した場合、next-maintenance オプトインリクエストは無視されます。

• CurrentApplyDate — TStamp、タイプ: timestamp (通常、1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定時点)。

  保留中のメンテナンスアクションがリソースに適用される有効日。この日付では、ApplyPendingMaintenanceAction (アクション) API、AutoAppliedAfterDate、および ForcedApplyDate から受信したオプトインリクエストが考慮されます。オプトインリクエストが受信されておらず、AutoAppliedAfterDate または ForcedApplyDate として何も指定されていない場合、この値は空白になります。

• Description — 文字列、タイプ:string (UTF-8 でエンコードされた文字列)。

  メンテナンスアクションについての詳細を提供する説明。

• ForcedApplyDate — TStamp、タイプ: timestamp (通常、1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定時点)。

  アクションが自動的に適用されたときのメンテナンスウィンドウの日付。メンテナンスアクションは、リソースのメンテナンスウィンドウに関係なく、この日にリソースに適用されます。この日付を指定した場合、immediate オプトインリクエストは無視されます。

• OptInStatus — 文字列、タイプ:string (UTF-8 でエンコードされた文字列)。

  リソースに対して受信されたオプトインリクエストのタイプを示します。

ResourcePendingMaintenanceActions (構造)

リソースに対する保留中のメンテナンスアクションについて説明します。

フィールド

• PendingMaintenanceActionDetails — PendingMaintenanceAction オブジェクトの配列。

  リソースの保留中のメンテナンスアクションに関する詳細を提供するリスト。

• ResourceIdentifier — 文字列、タイプ:string (UTF-8 でエンコードされた文字列)。

  保留中のメンテナンスアクションがあるリソースの ARN。

ResourcePendingMaintenanceActions は、以下のレスポンス要素として使用されます。

• ApplyPendingMaintenanceAction

UpgradeTarget (構造)

DB インスタンスをアップグレードできるデータベースエンジンのバージョン。

フィールド

• AutoUpgrade — ブール値、タイプ: boolean (ブール値 (真または偽))。

  AutoMinorVersionUpgrade が true に設定されているソース DB インスタンスにターゲットバージョンが適用されるかどうかを示す値。

• Description — 文字列、タイプ:string (UTF-8 でエンコードされた文字列)。

  DB インスタンスをアップグレードできるデータベースエンジンのバージョン。

• Engine — 文字列、タイプ:string (UTF-8 でエンコードされた文字列)。

  アップグレードターゲットデータベースエンジンの名前。

• EngineVersion — 文字列、タイプ:string (UTF-8 でエンコードされた文字列)。

  アップグレードターゲットのデータベースエンジンのバージョン番号。

• IsMajorVersionUpgrade — ブール値、タイプ: boolean (ブール値 (真または偽))。

  データベースエンジンがメジャーバージョンにアップグレードされているかどうかを示す値。

• SupportsGlobalDatabases — BooleanOptional、タイプ: boolean (ブール値 (真または偽))。

  ターゲットのエンジンバージョンを持つ Neptune グローバルデータベースを使用できるかどうかを示す値。

タグ (構造)

キーと値のペアで構成される Amazon Neptune リソースに割り当てられるメタデータ。

フィールド

• Key — 文字列、タイプ:string (UTF-8 でエンコードされた文字列)。

  キーはタグの必須の名前です。文字列値は、1〜128 文字の Unicode 文字です。aws: または rds: をプレフィックスとして使用することはできません。文字列には、一連の Unicode 文字、数字、空白、「_」、「.」、「/」、「=」、「+」、「-」 (Java 正規表現: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)") のみ使用できます。

• Value — 文字列、タイプ:string (UTF-8 でエンコードされた文字列)。

  値はタグの省略可能な値です。文字列値は、1〜256 文字の Unicode 文字です。aws: または rds: をプレフィックスとして使用することはできません。文字列には、一連の Unicode 文字、数字、空白、「_」、「.」、「/」、「=」、「+」、「-」 (Java 正規表現: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)") のみ使用できます。