翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
DescribeFramework
指定された FrameworkName のフレームワークの詳細を返します。
リクエストの構文
GET /audit/frameworks/frameworkName HTTP/1.1
URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
- frameworkName
-
フレームワークの一意の名前。
長さの制限：最小長は 1 です。最大長は 256 です。
パターン：
[a-zA-Z][_a-zA-Z0-9]*必須: はい
リクエストボディ
リクエストにリクエスト本文がありません。
レスポンスの構文
HTTP/1.1 200
Content-type: application/json
{
"CreationTime": number,
"DeploymentStatus": "string",
"FrameworkArn": "string",
"FrameworkControls": [
{
"ControlInputParameters": [
{
"ParameterName": "string",
"ParameterValue": "string"
}
],
"ControlName": "string",
"ControlScope": {
"ComplianceResourceIds": [ "string" ],
"ComplianceResourceTypes": [ "string" ],
"Tags": {
"string" : "string"
}
}
}
],
"FrameworkDescription": "string",
"FrameworkName": "string",
"FrameworkStatus": "string",
"IdempotencyToken": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- CreationTime
-
フレームワークが作成された日付と時刻を ISO 8601 で表したものです。
CreationTimeの値は、ミリ秒単位の精度です。例えば、2020-07-10T15:00:00.000-08:00 は 2020 年 7 月 10 日午後 3 時 (UTC から 8 時間遅れ) を表します。型: タイムスタンプ
- DeploymentStatus
-
フレームワークのデプロイステータス。ステータスは次のとおりです。
CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED型: 文字列
- FrameworkArn
-
リソースを一意に識別する Amazon リソースネーム (ARN)。ARN の形式は、リソースタイプによって異なります。
型: 文字列
- FrameworkControls
-
フレームワークを構成するコントロール。リスト内の各コントロールには、名前、入力パラメータ、およびスコープがあります。
型: FrameworkControl オブジェクトの配列
- FrameworkDescription
-
フレームワークの説明 (省略可能)。
型: 文字列
長さの制限: 最小長は 0 です。最大長は 1,024 です。
パターン:
.*\S.* - FrameworkName
-
フレームワークの一意の名前。
型: 文字列
長さの制限：最小長は 1 です。最大長は 256 です。
パターン：
[a-zA-Z][_a-zA-Z0-9]* - FrameworkStatus
-
フレームワークは、1 つ以上のコントロールで構成されます。各コントロールは、バックアッププラン、バックアップ選択、バックアップボールト、復旧ポイントなどのリソースを管理します。また、各リソースの AWS Config 録音をオンまたはオフに切り替えることもできます。ステータスは次のとおりです。
-
ACTIVEフレームワークによって管理されるすべてのリソースで記録が有効になっている場合。 -
PARTIALLY_ACTIVEフレームワークによって管理されている少なくとも 1 つのリソースについて記録がオフになっている場合。 -
INACTIVEフレームワークによって管理されるすべてのリソースで記録がオフになっている場合。 -
UNAVAILABLE現時点で AWS Backup が記録ステータスを検証できない場合。
型: 文字列
-
- IdempotencyToken
-
別の
DescribeFrameworkOutputへの同じコール間を区別するために使用できる顧客が選択した文字列。同じ冪等性トークンで成功したリクエストを再試行すると、アクションは実行されず、成功メッセージが表示されます。型: 文字列
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InvalidParameterValueException
-
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。
HTTP ステータスコード：400
- MissingParameterValueException
-
必須パラメータがないことを示します。
HTTP ステータスコード：400
- ResourceNotFoundException
-
アクションに必要なリソースは存在しません。
HTTP ステータスコード：400
- ServiceUnavailableException
-
サーバーの一時的障害のため、リクエストは失敗しました。
HTTP ステータスコード：500
その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
