設定バンドルを取得する
設定バンドルを取得してメタデータを検査するか、特定のバージョンの完全な設定コンテンツを読み込みます。次の 2 つのオペレーションを使用できます。
-
GetConfigurationBundle — バンドルの最新バージョンを返します。
branchNameが指定されている場合、 はそのブランチの最新バージョンを返します。省略すると、すべてのブランチで最新バージョンが返されます。これを使用して、現在のアクティブな設定を読み取ります。 -
GetConfigurationBundleVersion — 特定の履歴バージョンをバージョン ID で返します。これを使用して、過去の設定を検査したり、バージョンを比較したりします。
バンドルメタデータとバージョンコンテンツ
GetConfigurationBundle は、バンドルレベルのメタデータ (名前、説明、ARN) とフルバージョンのコンテンツ (設定キーと値のペアを持つコンポーネント) の両方を返します。完全なコンテンツを取得せずに、どのバージョンが存在するかのみを知る必要がある場合は、ListConfigurationBundleVersions代わりに を使用してください。
GetConfigurationBundleVersion は、同じフィールドと を返します。これはversionCreatedAt、特定のバージョンが作成された日時 (バンドル自体createdAtが最初に作成された日時である とは対照的) を正確に知らせます。
コードサンプル
例
リクエストパラメータ
GetConfigurationBundle
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
|
|
文字列 |
はい |
設定バンドルの ID。パスパラメータとして渡されます。 |
|
|
String |
いいえ |
最新バージョンを取得するブランチ名。省略すると、すべてのブランチで最新バージョンが返されます。 |
GetConfigurationBundleVersion
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
|
|
文字列 |
はい |
設定バンドルの ID。パスパラメータとして渡されます。 |
|
|
String |
はい |
取得する特定のバージョンの UUID。パスパラメータとして渡されます。 |
[応答]
どちらのオペレーションも同じフィールドを返します。 GetConfigurationBundleVersionはさらに を返しますversionCreatedAt。
| フィールド | タイプ | 説明 |
|---|---|---|
|
|
文字列 |
設定バンドルの ARN。 |
|
|
String |
設定バンドルの ID。 |
|
|
String |
バンドルの名前。 |
|
|
String |
バンドルの説明 (設定されている場合)。 |
|
|
String |
返されたバージョンの UUID。 |
|
|
マッピング |
コンポーネント識別子のコンポーネント設定へのマップ。各値には、このバージョンに保存されているキーと値のペアを持つ |
|
|
オブジェクト |
|
|
|
タイムスタンプ |
バンドルが最初に作成された日時。 |
|
|
タイムスタンプ |
バンドルが最後に更新された日時 (GetConfigurationBundle のみ)。 |
|
|
タイムスタンプ |
この特定のバージョンが作成されたとき (GetConfigurationBundleVersion のみ)。 |
エラー
| エラー | HTTP ステータス | 説明 |
|---|---|---|
|
|
400 |
リクエストパラメータが無効です。 |
|
|
404 |
指定された |
|
|
403 |
アクセス許可が不十分です。IAM ポリシーに |
|
|
429 |
リクエストレートを超えました。エクスポネンシャルバックオフを使用して再試行してください。 |
|
|
500 |
サービス側のエラー。リクエストを再試行します。 |