翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
DescribeLedger
状態、アクセス許可モード、保管時の暗号化の設定、作成日時など、台帳に関する情報を返します。
リクエストの構文
GET /ledgers/name HTTP/1.1
URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
- name
-
記述する台帳の名前。
長さの制限：最小長は 1 です。最大長は 32 です。
Pattern:
(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$必須: はい
リクエストボディ
リクエストにリクエスト本文がありません。
レスポンスの構文
HTTP/1.1 200
Content-type: application/json
{
"Arn": "string",
"CreationDateTime": number,
"DeletionProtection": boolean,
"EncryptionDescription": {
"EncryptionStatus": "string",
"InaccessibleKmsKeyDateTime": number,
"KmsKeyArn": "string"
},
"Name": "string",
"PermissionsMode": "string",
"State": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- Arn
-
台帳の Amazon リソースネーム (ARN)。
型: 文字列
長さの制限: 最小長は 20 です。最大長は 1600 です。
- CreationDateTime
-
台帳が作成された日時 (エポック時刻形式)。(エポック時間形式は 1970 年 1 月 1 日 12:00:00 AM UTC からの経過秒数です。)
型: タイムスタンプ
- DeletionProtection
-
台帳がユーザーによって削除されないように保護されるかどうかを指定します。台帳の作成時に指定しない場合、この機能はデフォルトで有効
trueになります。削除保護が有効になっている場合は、台帳を削除する前に、まず無効にする必要があります。無効にするには、
UpdateLedgerオペレーションを呼び出してパラメータをfalseに設定します。型: ブール値
- EncryptionDescription
-
台帳の保管中のデータの暗号化に関する情報。これには、現在のステータス、 AWS KMS キー、キーにアクセスできなくなった日時 (エラーの場合) が含まれます。このパラメータが未定義の場合、台帳は暗号化に AWS 所有の KMS キーを使用します。
タイプ：LedgerEncryptionDescription オブジェクト
- Name
-
台帳の名前。
型: 文字列
長さの制限：最小長は 1 です。最大長は 32 です。
パターン:
(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$ - PermissionsMode
-
台帳のアクセス許可モード。
型: 文字列
有効な値：
ALLOW_ALL | STANDARD - State
-
台帳の現在のステータス。
型: 文字列
有効な値：
CREATING | ACTIVE | DELETING | DELETED
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InvalidParameterException
-
リクエスト内の 1 つ以上のパラメータが有効ではありません。
HTTP ステータスコード：400
- ResourceNotFoundException
-
指定されたリソースは存在しません。
HTTP ステータスコード: 404
その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
