使用 的 QLDB 範例 AWS CLI - AWS SDK 程式碼範例
動作

文件 AWS SDK AWS 範例 SDK 儲存庫中有更多可用的 GitHub 範例。

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

使用 的 QLDB 範例 AWS CLI

下列程式碼範例示範如何使用 AWS Command Line Interface 搭配 QLDB 來執行動作和實作常見案例。

Actions 是大型程式的程式碼摘錄，必須在內容中執行。雖然 動作會示範如何呼叫個別服務函數，但您可以在其相關案例中查看內容中的動作。

每個範例都包含完整原始程式碼的連結，您可以在其中找到如何在內容中設定和執行程式碼的指示。

主題

動作

下列程式碼範例示範如何使用 cancel-journal-kinesis-stream。

AWS CLI

若要取消日誌串流

下列cancel-journal-kinesis-stream範例會從分類帳取消指定的日誌串流。

aws qldb cancel-journal-kinesis-stream \
    --ledger-name myExampleLedger \
    --stream-id 7ISCkqwe4y25YyHLzYUFAf

輸出：

{
    "StreamId": "7ISCkqwe4y25YyHLzYUFAf"
}

如需詳細資訊，請參閱 Amazon QLDB 開發人員指南中的從 Amazon Word 串流日誌資料。 QLDB

下列程式碼範例示範如何使用 create-ledger。

AWS CLI

範例 1：建立具有預設屬性的分類帳

下列create-ledger範例會建立具有 名稱myExampleLedger和許可模式 的分類帳STANDARD。未指定刪除保護和 AWS KMS 金鑰的選用參數，因此它們分別預設為 true和 AWS 擁有的 KMS 金鑰。

aws qldb create-ledger \
    --name myExampleLedger \
    --permissions-mode STANDARD

輸出：

{
    "State": "CREATING",
    "Arn": "arn:aws:qldb:us-west-2:123456789012:ledger/myExampleLedger",
    "DeletionProtection": true,
    "CreationDateTime": 1568839243.951,
    "Name": "myExampleLedger",
    "PermissionsMode": "STANDARD"
}

範例 2：建立停用刪除保護的分類帳、客戶受管 KMS 金鑰和指定的標籤

下列create-ledger範例會建立具有 名稱myExampleLedger2和許可模式 的分類帳STANDARD。刪除保護功能已停用，指定的客戶受管 KMS 金鑰用於靜態加密，且指定的標籤會連接至 資源。

aws qldb create-ledger \
    --name myExampleLedger2 \
    --permissions-mode STANDARD \
    --no-deletion-protection \
    --kms-key arn:aws:kms:us-west-2:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \
    --tags IsTest=true,Domain=Test

輸出：

{
    "Arn": "arn:aws:qldb:us-west-2:123456789012:ledger/myExampleLedger2",
    "DeletionProtection": false,
    "CreationDateTime": 1568839543.557,
    "State": "CREATING",
    "Name": "myExampleLedger2",
    "PermissionsMode": "STANDARD",
    "KmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}

如需詳細資訊，請參閱 Amazon QLDB 開發人員指南中的 Amazon Word Ledgers 基本操作。 QLDB

  • 如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 CreateLedger。

下列程式碼範例示範如何使用 delete-ledger。

AWS CLI

若要刪除分類帳

下列delete-ledger範例會刪除指定的分類帳。

aws qldb delete-ledger \
    --name myExampleLedger

此命令不會產生輸出。

如需詳細資訊，請參閱 Amazon QLDB 開發人員指南中的 Amazon Word Ledgers 基本操作。 QLDB

  • 如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeleteLedger。

下列程式碼範例示範如何使用 describe-journal-kinesis-stream。

AWS CLI

描述日誌串流

下列describe-journal-kinesis-stream範例顯示來自分類帳之指定日誌串流的詳細資訊。

aws qldb describe-journal-kinesis-stream \
    --ledger-name myExampleLedger \
    --stream-id 7ISCkqwe4y25YyHLzYUFAf

輸出：

{
    "Stream": {
        "LedgerName": "myExampleLedger",
        "CreationTime": 1591221984.677,
        "InclusiveStartTime": 1590710400.0,
        "ExclusiveEndTime": 1590796799.0,
        "RoleArn": "arn:aws:iam::123456789012:role/my-kinesis-stream-role",
        "StreamId": "7ISCkqwe4y25YyHLzYUFAf",
        "Arn": "arn:aws:qldb:us-east-1:123456789012:stream/myExampleLedger/7ISCkqwe4y25YyHLzYUFAf",
        "Status": "ACTIVE",
        "KinesisConfiguration": {
            "StreamArn": "arn:aws:kinesis:us-east-1:123456789012:stream/stream-for-qldb",
            "AggregationEnabled": true
        },
        "StreamName": "myExampleLedger-stream"
    }
}

如需詳細資訊，請參閱 Amazon QLDB 開發人員指南中的從 Amazon Word 串流日誌資料。 QLDB

下列程式碼範例示範如何使用 describe-journal-s3-export。

AWS CLI

描述日誌匯出任務

下列describe-journal-s3-export範例顯示來自分類帳之指定匯出任務的詳細資訊。

aws qldb describe-journal-s3-export \
    --name myExampleLedger \
    --export-id ADR2ONPKN5LINYGb4dp7yZ

輸出：

{
    "ExportDescription": {
        "S3ExportConfiguration": {
            "Bucket": "awsExampleBucket",
            "Prefix": "ledgerexport1/",
            "EncryptionConfiguration": {
                "ObjectEncryptionType": "SSE_S3"
            }
        },
        "RoleArn": "arn:aws:iam::123456789012:role/my-s3-export-role",
        "Status": "COMPLETED",
        "ExportCreationTime": 1568847801.418,
        "InclusiveStartTime": 1568764800.0,
        "ExclusiveEndTime": 1568847599.0,
        "LedgerName": "myExampleLedger",
        "ExportId": "ADR2ONPKN5LINYGb4dp7yZ"
    }
}

如需詳細資訊，請參閱 Amazon QLDB 開發人員指南中的在 Amazon Word 中匯出日誌。 QLDB

下列程式碼範例示範如何使用 describe-ledger。

AWS CLI

描述分類帳

下列describe-ledger範例顯示指定分類帳的詳細資訊。

aws qldb describe-ledger \
    --name myExampleLedger

輸出：

{
    "CreationDateTime": 1568839243.951,
    "Arn": "arn:aws:qldb:us-west-2:123456789012:ledger/myExampleLedger",
    "State": "ACTIVE",
    "Name": "myExampleLedger",
    "DeletionProtection": true,
    "PermissionsMode": "STANDARD",
    "EncryptionDescription": {
        "KmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "EncryptionStatus": "ENABLED"
    }
}

如需詳細資訊，請參閱 Amazon QLDB 開發人員指南中的 Amazon Word Ledgers 基本操作。 QLDB

  • 如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DescribeLedger。

下列程式碼範例示範如何使用 export-journal-to-s3。

AWS CLI

將日誌區塊匯出至 S3

下列export-journal-to-s3範例會從名為 的分類帳，為指定日期和時間範圍內的日誌區塊建立匯出任務myExampleLedger。匯出任務會將區塊寫入指定的 Amazon S3 儲存貯體。

aws qldb export-journal-to-s3 \
    --name myExampleLedger \
    --inclusive-start-time 2019-09-18T00:00:00Z \
    --exclusive-end-time 2019-09-18T22:59:59Z \
    --role-arn arn:aws:iam::123456789012:role/my-s3-export-role \
    --s3-export-configuration file://my-s3-export-config.json

my-s3-export-config.json 的內容：

{
    "Bucket": "awsExampleBucket",
    "Prefix": "ledgerexport1/",
    "EncryptionConfiguration": {
        "ObjectEncryptionType": "SSE_S3"
    }
}

輸出：

{
    "ExportId": "ADR2ONPKN5LINYGb4dp7yZ"
}

如需詳細資訊，請參閱 Amazon QLDB 開發人員指南中的在 Amazon Word 中匯出日誌。 QLDB

  • 如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 ExportJournalToS3。

下列程式碼範例示範如何使用 get-block。

AWS CLI

範例 1：取得日誌區塊和使用輸入檔案進行驗證的證明

下列get-block範例會請求區塊資料物件和來自指定分類帳的證明。請求適用於指定的摘要提示地址和區塊地址。

aws qldb get-block \
    --name vehicle-registration \
    --block-address file://myblockaddress.json \
    --digest-tip-address file://mydigesttipaddress.json

myblockaddress.json 的內容：

{
    "IonText": "{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:100}"
}

mydigesttipaddress.json 的內容：

{
    "IonText": "{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:123}"
}

輸出：

{
    "Block": {
        "IonText": "{blockAddress:{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:100},transactionId:\"FnQeJBAicTX0Ah32ZnVtSX\",blockTimestamp:2019-09-16T19:37:05.360Z,blockHash:{{NoChM92yKRuJAb/jeLd1VnYn4DHiWIf071ACfic9uHc=}},entriesHash:{{l05LOsiKV14SDbuaYnH7uwXzUvqzIwUiRLXGbTyj/nY=}},previousBlockHash:{{7kewBXhpdbClcZKxhVmpoMHpUGOJtWQD0iY2LPfZkYA=}},entriesHashList:[{{eRSwnmAM7WWANWDd5iGOyK+T4tDXyzUq6HZ/0fgLHos=}},{{mHVex/yjHAWjFPpwhBuH2GKXmKJjK2FBa9faqoUVNtg=}},{{y5cCBr7pOAIUfsVQ1j0TqtE97b4b4oo1R0vnYyE5wWM=}},{{TvTXygML1bMe6NvEZtGkX+KR+W/EJl4qD1mmV77KZQg=}}],transactionInfo:{statements:[{statement:\"FROM VehicleRegistration AS r \\nWHERE r.VIN = '1N4AL11D75C109151'\\nINSERT INTO r.Owners.SecondaryOwners\\n    VALUE { 'PersonId' : 'CMVdR77XP8zAglmmFDGTvt' }\",startTime:2019-09-16T19:37:05.302Z,statementDigest:{{jcgPX2vsOJ0waum4qmDYtn1pCAT9xKNIzA+2k4R+mxA=}}}],documents:{JUJgkIcNbhS2goq8RqLuZ4:{tableName:\"VehicleRegistration\",tableId:\"BFJKdXgzt9oF4wjMbuxy4G\",statements:[0]}}},revisions:[{blockAddress:{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:100},hash:{{mHVex/yjHAWjFPpwhBuH2GKXmKJjK2FBa9faqoUVNtg=}},data:{VIN:\"1N4AL11D75C109151\",LicensePlateNumber:\"LEWISR261LL\",State:\"WA\",PendingPenaltyTicketAmount:90.25,ValidFromDate:2017-08-21,ValidToDate:2020-05-11,Owners:{PrimaryOwner:{PersonId:\"BFJKdXhnLRT27sXBnojNGW\"},SecondaryOwners:[{PersonId:\"CMVdR77XP8zAglmmFDGTvt\"}]},City:\"Everett\"},metadata:{id:\"JUJgkIcNbhS2goq8RqLuZ4\",version:3,txTime:2019-09-16T19:37:05.344Z,txId:\"FnQeJBAicTX0Ah32ZnVtSX\"}}]}"
    },
    "Proof": {
        "IonText": "[{{l3+EXs69K1+rehlqyWLkt+oHDlw4Zi9pCLW/t/mgTPM=}},{{48CXG3ehPqsxCYd34EEa8Fso0ORpWWAO8010RJKf3Do=}},{{9UnwnKSQT0i3ge1JMVa+tMIqCEDaOPTkWxmyHSn8UPQ=}},{{3nW6Vryghk+7pd6wFCtLufgPM6qXHyTNeCb1sCwcDaI=}},{{Irb5fNhBrNEQ1VPhzlnGT/ZQPadSmgfdtMYcwkNOxoI=}},{{+3CWpYG/ytf/vq9GidpzSx6JJiLXt1hMQWNnqOy3jfY=}},{{NPx6cRhwsiy5m9UEWS5JTJrZoUdO2jBOAAOmyZAT+qE=}}]"
    }
}

如需詳細資訊，請參閱 Amazon QLDB 開發人員指南中的 Amazon Word 中的資料驗證。 QLDB

範例 2：取得日誌區塊和使用短期語法進行驗證的證明

下列get-block範例使用短期語法，請求區塊資料物件和來自指定分類帳的證明。請求適用於指定的摘要提示地址和區塊地址。

aws qldb get-block \
    --name vehicle-registration \
    --block-address 'IonText="{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:100}"' \
    --digest-tip-address 'IonText="{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:123}"'

輸出：

{
    "Block": {
        "IonText": "{blockAddress:{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:100},transactionId:\"FnQeJBAicTX0Ah32ZnVtSX\",blockTimestamp:2019-09-16T19:37:05.360Z,blockHash:{{NoChM92yKRuJAb/jeLd1VnYn4DHiWIf071ACfic9uHc=}},entriesHash:{{l05LOsiKV14SDbuaYnH7uwXzUvqzIwUiRLXGbTyj/nY=}},previousBlockHash:{{7kewBXhpdbClcZKxhVmpoMHpUGOJtWQD0iY2LPfZkYA=}},entriesHashList:[{{eRSwnmAM7WWANWDd5iGOyK+T4tDXyzUq6HZ/0fgLHos=}},{{mHVex/yjHAWjFPpwhBuH2GKXmKJjK2FBa9faqoUVNtg=}},{{y5cCBr7pOAIUfsVQ1j0TqtE97b4b4oo1R0vnYyE5wWM=}},{{TvTXygML1bMe6NvEZtGkX+KR+W/EJl4qD1mmV77KZQg=}}],transactionInfo:{statements:[{statement:\"FROM VehicleRegistration AS r \\nWHERE r.VIN = '1N4AL11D75C109151'\\nINSERT INTO r.Owners.SecondaryOwners\\n    VALUE { 'PersonId' : 'CMVdR77XP8zAglmmFDGTvt' }\",startTime:2019-09-16T19:37:05.302Z,statementDigest:{{jcgPX2vsOJ0waum4qmDYtn1pCAT9xKNIzA+2k4R+mxA=}}}],documents:{JUJgkIcNbhS2goq8RqLuZ4:{tableName:\"VehicleRegistration\",tableId:\"BFJKdXgzt9oF4wjMbuxy4G\",statements:[0]}}},revisions:[{blockAddress:{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:100},hash:{{mHVex/yjHAWjFPpwhBuH2GKXmKJjK2FBa9faqoUVNtg=}},data:{VIN:\"1N4AL11D75C109151\",LicensePlateNumber:\"LEWISR261LL\",State:\"WA\",PendingPenaltyTicketAmount:90.25,ValidFromDate:2017-08-21,ValidToDate:2020-05-11,Owners:{PrimaryOwner:{PersonId:\"BFJKdXhnLRT27sXBnojNGW\"},SecondaryOwners:[{PersonId:\"CMVdR77XP8zAglmmFDGTvt\"}]},City:\"Everett\"},metadata:{id:\"JUJgkIcNbhS2goq8RqLuZ4\",version:3,txTime:2019-09-16T19:37:05.344Z,txId:\"FnQeJBAicTX0Ah32ZnVtSX\"}}]}"
    },
    "Proof": {
        "IonText": "[{{l3+EXs69K1+rehlqyWLkt+oHDlw4Zi9pCLW/t/mgTPM=}},{{48CXG3ehPqsxCYd34EEa8Fso0ORpWWAO8010RJKf3Do=}},{{9UnwnKSQT0i3ge1JMVa+tMIqCEDaOPTkWxmyHSn8UPQ=}},{{3nW6Vryghk+7pd6wFCtLufgPM6qXHyTNeCb1sCwcDaI=}},{{Irb5fNhBrNEQ1VPhzlnGT/ZQPadSmgfdtMYcwkNOxoI=}},{{+3CWpYG/ytf/vq9GidpzSx6JJiLXt1hMQWNnqOy3jfY=}},{{NPx6cRhwsiy5m9UEWS5JTJrZoUdO2jBOAAOmyZAT+qE=}}]"
    }
}

如需詳細資訊，請參閱 Amazon QLDB 開發人員指南中的 Amazon Word 中的資料驗證。 QLDB

  • 如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetBlock。

下列程式碼範例示範如何使用 get-digest。

AWS CLI

若要取得分類帳的摘要

下列get-digest範例請求從指定分類帳摘要，最晚在日誌中遞交區塊。

aws qldb get-digest \
    --name vehicle-registration

輸出：

{
    "Digest": "6m6BMXobbJKpMhahwVthAEsN6awgnHK62Qq5McGP1Gk=",
    "DigestTipAddress": {
        "IonText": "{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:123}"
    }
}

如需詳細資訊，請參閱 Amazon QLDB 開發人員指南中的 Amazon Word 中的資料驗證。 QLDB

  • 如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetDigest。

下列程式碼範例示範如何使用 get-revision。

AWS CLI

範例 1：取得文件修訂和使用輸入檔案進行驗證的證明

下列get-revision範例會請求修訂資料物件和來自指定分類帳的證明。請求適用於指定的摘要提示地址、文件 ID 和修訂的區塊地址。

aws qldb get-revision \
    --name vehicle-registration \
    --block-address file://myblockaddress.json \
    --document-id JUJgkIcNbhS2goq8RqLuZ4 \
    --digest-tip-address file://mydigesttipaddress.json

myblockaddress.json 的內容：

{
    "IonText": "{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:100}"
}

mydigesttipaddress.json 的內容：

{
    "IonText": "{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:123}"
}

輸出：

{
    "Revision": {
        "IonText": "{blockAddress:{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:100},hash:{{mHVex/yjHAWjFPpwhBuH2GKXmKJjK2FBa9faqoUVNtg=}},data:{VIN:\"1N4AL11D75C109151\",LicensePlateNumber:\"LEWISR261LL\",State:\"WA\",PendingPenaltyTicketAmount:90.25,ValidFromDate:2017-08-21,ValidToDate:2020-05-11,Owners:{PrimaryOwner:{PersonId:\"BFJKdXhnLRT27sXBnojNGW\"},SecondaryOwners:[{PersonId:\"CMVdR77XP8zAglmmFDGTvt\"}]},City:\"Everett\"},metadata:{id:\"JUJgkIcNbhS2goq8RqLuZ4\",version:3,txTime:2019-09-16T19:37:05.344Z,txId:\"FnQeJBAicTX0Ah32ZnVtSX\"}}"
    },
    "Proof": {
        "IonText": "[{{eRSwnmAM7WWANWDd5iGOyK+T4tDXyzUq6HZ/0fgLHos=}},{{VV1rdaNuf+yJZVGlmsM6gr2T52QvBO8Lg+KgpjcnWAU=}},{{7kewBXhpdbClcZKxhVmpoMHpUGOJtWQD0iY2LPfZkYA=}},{{l3+EXs69K1+rehlqyWLkt+oHDlw4Zi9pCLW/t/mgTPM=}},{{48CXG3ehPqsxCYd34EEa8Fso0ORpWWAO8010RJKf3Do=}},{{9UnwnKSQT0i3ge1JMVa+tMIqCEDaOPTkWxmyHSn8UPQ=}},{{3nW6Vryghk+7pd6wFCtLufgPM6qXHyTNeCb1sCwcDaI=}},{{Irb5fNhBrNEQ1VPhzlnGT/ZQPadSmgfdtMYcwkNOxoI=}},{{+3CWpYG/ytf/vq9GidpzSx6JJiLXt1hMQWNnqOy3jfY=}},{{NPx6cRhwsiy5m9UEWS5JTJrZoUdO2jBOAAOmyZAT+qE=}}]"
    }
}

如需詳細資訊，請參閱 Amazon QLDB 開發人員指南中的 Amazon Word 中的資料驗證。 QLDB

範例 2：取得文件修訂版本和使用短期語法進行驗證的證明

下列get-revision範例使用短期語法，請求修訂資料物件和來自指定分類帳的證明。請求適用於指定的摘要提示地址、文件 ID 和修訂的區塊地址。

aws qldb get-revision \
    --name vehicle-registration \
    --block-address 'IonText="{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:100}"' \
    --document-id JUJgkIcNbhS2goq8RqLuZ4 \
    --digest-tip-address 'IonText="{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:123}"'

輸出：

{
    "Revision": {
        "IonText": "{blockAddress:{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:100},hash:{{mHVex/yjHAWjFPpwhBuH2GKXmKJjK2FBa9faqoUVNtg=}},data:{VIN:\"1N4AL11D75C109151\",LicensePlateNumber:\"LEWISR261LL\",State:\"WA\",PendingPenaltyTicketAmount:90.25,ValidFromDate:2017-08-21,ValidToDate:2020-05-11,Owners:{PrimaryOwner:{PersonId:\"BFJKdXhnLRT27sXBnojNGW\"},SecondaryOwners:[{PersonId:\"CMVdR77XP8zAglmmFDGTvt\"}]},City:\"Everett\"},metadata:{id:\"JUJgkIcNbhS2goq8RqLuZ4\",version:3,txTime:2019-09-16T19:37:05.344Z,txId:\"FnQeJBAicTX0Ah32ZnVtSX\"}}"
    },
    "Proof": {
        "IonText": "[{{eRSwnmAM7WWANWDd5iGOyK+T4tDXyzUq6HZ/0fgLHos=}},{{VV1rdaNuf+yJZVGlmsM6gr2T52QvBO8Lg+KgpjcnWAU=}},{{7kewBXhpdbClcZKxhVmpoMHpUGOJtWQD0iY2LPfZkYA=}},{{l3+EXs69K1+rehlqyWLkt+oHDlw4Zi9pCLW/t/mgTPM=}},{{48CXG3ehPqsxCYd34EEa8Fso0ORpWWAO8010RJKf3Do=}},{{9UnwnKSQT0i3ge1JMVa+tMIqCEDaOPTkWxmyHSn8UPQ=}},{{3nW6Vryghk+7pd6wFCtLufgPM6qXHyTNeCb1sCwcDaI=}},{{Irb5fNhBrNEQ1VPhzlnGT/ZQPadSmgfdtMYcwkNOxoI=}},{{+3CWpYG/ytf/vq9GidpzSx6JJiLXt1hMQWNnqOy3jfY=}},{{NPx6cRhwsiy5m9UEWS5JTJrZoUdO2jBOAAOmyZAT+qE=}}]"
    }
}

如需詳細資訊，請參閱 Amazon QLDB 開發人員指南中的 Amazon Word 中的資料驗證。 QLDB

  • 如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetRevision。

下列程式碼範例示範如何使用 list-journal-kinesis-streams-for-ledger。

AWS CLI

列出分類帳的日誌串流

下列list-journal-kinesis-streams-for-ledger範例會列出指定分類帳的日誌串流。

aws qldb list-journal-kinesis-streams-for-ledger \
    --ledger-name myExampleLedger

輸出：

{
    "Streams": [
        {
            "LedgerName": "myExampleLedger",
            "CreationTime": 1591221984.677,
            "InclusiveStartTime": 1590710400.0,
            "ExclusiveEndTime": 1590796799.0,
            "RoleArn": "arn:aws:iam::123456789012:role/my-kinesis-stream-role",
            "StreamId": "7ISCkqwe4y25YyHLzYUFAf",
            "Arn": "arn:aws:qldb:us-east-1:123456789012:stream/myExampleLedger/7ISCkqwe4y25YyHLzYUFAf",
            "Status": "ACTIVE",
            "KinesisConfiguration": {
                "StreamArn": "arn:aws:kinesis:us-east-1:123456789012:stream/stream-for-qldb",
                "AggregationEnabled": true
            },
            "StreamName": "myExampleLedger-stream"
        }
    ]
}

如需詳細資訊，請參閱 Amazon QLDB 開發人員指南中的從 Amazon Word 串流日誌資料。 QLDB

下列程式碼範例示範如何使用 list-journal-s3-exports-for-ledger。

AWS CLI

列出分類帳的日誌匯出任務

下列list-journal-s3-exports-for-ledger範例列出指定分類帳的日誌匯出任務。

aws qldb list-journal-s3-exports-for-ledger \
    --name myExampleLedger

輸出：

{
    "JournalS3Exports": [
        {
            "LedgerName": "myExampleLedger",
            "ExclusiveEndTime": 1568847599.0,
            "ExportCreationTime": 1568847801.418,
            "S3ExportConfiguration": {
                "Bucket": "awsExampleBucket",
                "Prefix": "ledgerexport1/",
                "EncryptionConfiguration": {
                    "ObjectEncryptionType": "SSE_S3"
                }
            },
            "ExportId": "ADR2ONPKN5LINYGb4dp7yZ",
            "RoleArn": "arn:aws:iam::123456789012:role/qldb-s3-export",
            "InclusiveStartTime": 1568764800.0,
            "Status": "IN_PROGRESS"
        }
    ]
}

如需詳細資訊，請參閱 Amazon QLDB 開發人員指南中的在 Amazon Word 中匯出日誌。 QLDB

下列程式碼範例示範如何使用 list-journal-s3-exports。

AWS CLI

若要列出日誌匯出任務

下列list-journal-s3-exports範例列出與目前 AWS 帳戶和區域相關聯的所有分類帳的日誌匯出任務。

aws qldb list-journal-s3-exports

輸出：

{
    "JournalS3Exports": [
        {
            "Status": "IN_PROGRESS",
            "LedgerName": "myExampleLedger",
            "S3ExportConfiguration": {
                "EncryptionConfiguration": {
                    "ObjectEncryptionType": "SSE_S3"
                },
                "Bucket": "awsExampleBucket",
                "Prefix": "ledgerexport1/"
            },
            "RoleArn": "arn:aws:iam::123456789012:role/my-s3-export-role",
            "ExportCreationTime": 1568847801.418,
            "ExportId": "ADR2ONPKN5LINYGb4dp7yZ",
            "InclusiveStartTime": 1568764800.0,
            "ExclusiveEndTime": 1568847599.0
        },
        {
            "Status": "COMPLETED",
            "LedgerName": "myExampleLedger2",
            "S3ExportConfiguration": {
                "EncryptionConfiguration": {
                    "ObjectEncryptionType": "SSE_S3"
                },
                "Bucket": "awsExampleBucket",
                "Prefix": "ledgerexport1/"
            },
            "RoleArn": "arn:aws:iam::123456789012:role/my-s3-export-role",
            "ExportCreationTime": 1568846847.638,
            "ExportId": "2pdvW8UQrjBAiYTMehEJDI",
            "InclusiveStartTime": 1568592000.0,
            "ExclusiveEndTime": 1568764800.0
        }
    ]
}

如需詳細資訊，請參閱 Amazon QLDB 開發人員指南中的在 Amazon Word 中匯出日誌。 QLDB

下列程式碼範例示範如何使用 list-ledgers。

AWS CLI

列出可用的分類帳

下列list-ledgers範例會列出與目前 AWS 帳戶和區域相關聯的所有分類帳。

aws qldb list-ledgers

輸出：

{
    "Ledgers": [
        {
            "State": "ACTIVE",
            "CreationDateTime": 1568839243.951,
            "Name": "myExampleLedger"
        },
        {
            "State": "ACTIVE",
            "CreationDateTime": 1568839543.557,
            "Name": "myExampleLedger2"
        }
    ]
}

如需詳細資訊，請參閱 Amazon QLDB 開發人員指南中的 Amazon Word Ledgers 基本操作。 QLDB

  • 如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 ListLedgers。

下列程式碼範例示範如何使用 list-tags-for-resource。

AWS CLI

列出連接至分類帳的標籤

下列list-tags-for-resource範例會列出連接至指定分類帳的所有標籤。

aws qldb list-tags-for-resource \
    --resource-arn arn:aws:qldb:us-west-2:123456789012:ledger/myExampleLedger

輸出：

{
    "Tags": {
        "IsTest": "true",
        "Domain": "Test"
    }
}

如需詳細資訊，請參閱 Amazon QLDB 開發人員指南中的標記 Amazon Word 資源。 QLDB

下列程式碼範例示範如何使用 stream-journal-to-kinesis。

AWS CLI

範例 1：使用輸入檔案將日誌資料串流至 Kinesis Data Streams

下列stream-journal-to-kinesis範例會從名為 的分類帳建立指定日期和時間範圍內的日誌資料串流myExampleLedger。串流會將資料傳送至指定的 Amazon Kinesis 資料串流。

aws qldb stream-journal-to-kinesis \
    --ledger-name myExampleLedger \
    --inclusive-start-time 2020-05-29T00:00:00Z \
    --exclusive-end-time 2020-05-29T23:59:59Z \
    --role-arn arn:aws:iam::123456789012:role/my-kinesis-stream-role \
    --kinesis-configuration file://my-kinesis-config.json \
    --stream-name myExampleLedger-stream

my-kinesis-config.json 的內容：

{
    "StreamArn": "arn:aws:kinesis:us-east-1:123456789012:stream/stream-for-qldb",
    "AggregationEnabled": true
}

輸出：

{
    "StreamId": "7ISCkqwe4y25YyHLzYUFAf"
}

如需詳細資訊，請參閱 Amazon QLDB 開發人員指南中的從 Amazon Word 串流日誌資料。 QLDB

範例 2：使用短期語法將日誌資料串流至 Kinesis Data Streams

下列stream-journal-to-kinesis範例會從名為 的分類帳建立指定日期和時間範圍內的日誌資料串流myExampleLedger。串流會將資料傳送至指定的 Amazon Kinesis 資料串流。

aws qldb stream-journal-to-kinesis \
    --ledger-name myExampleLedger \
    --inclusive-start-time 2020-05-29T00:00:00Z \
    --exclusive-end-time 2020-05-29T23:59:59Z \
    --role-arn arn:aws:iam::123456789012:role/my-kinesis-stream-role \
    --stream-name myExampleLedger-stream \
    --kinesis-configuration StreamArn=arn:aws:kinesis:us-east-1:123456789012:stream/stream-for-qldb,AggregationEnabled=true

輸出：

{
    "StreamId": "7ISCkqwe4y25YyHLzYUFAf"
}

如需詳細資訊，請參閱 Amazon QLDB 開發人員指南中的從 Amazon Word 串流日誌資料。 QLDB

下列程式碼範例示範如何使用 tag-resource。

AWS CLI

標記分類帳

下列tag-resource範例會將一組標籤新增至指定的分類帳。

aws qldb tag-resource \
    --resource-arn arn:aws:qldb:us-west-2:123456789012:ledger/myExampleLedger \
    --tags IsTest=true,Domain=Test

此命令不會產生輸出。

如需詳細資訊，請參閱 Amazon QLDB 開發人員指南中的標記 Amazon Word 資源。 QLDB

  • 如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 TagResource。

下列程式碼範例示範如何使用 untag-resource。

AWS CLI

從資源中移除標籤

下列untag-resource範例會從指定的分類帳移除具有指定標籤索引鍵的標籤。

aws qldb untag-resource \
    --resource-arn arn:aws:qldb:us-west-2:123456789012:ledger/myExampleLedger \
    --tag-keys IsTest Domain

此命令不會產生輸出。

如需詳細資訊，請參閱 Amazon QLDB 開發人員指南中的標記 Amazon Word 資源。 QLDB

  • 如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 UntagResource。

下列程式碼範例示範如何使用 update-ledger-permissions-mode。

AWS CLI

範例 1：將分類帳的許可模式更新為 STANDARD

下列update-ledger-permissions-mode範例會將STANDARD許可模式指派給指定的分類帳。

aws qldb update-ledger-permissions-mode \
    --name myExampleLedger \
    --permissions-mode STANDARD

輸出：

{
    "Name": "myExampleLedger",
    "Arn": "arn:aws:qldb:us-west-2:123456789012:ledger/myExampleLedger",
    "PermissionsMode": "STANDARD"
}

範例 2：將分類帳的許可模式更新為 ALLOW_ALL

下列update-ledger-permissions-mode範例會將ALLOW_ALL許可模式指派給指定的分類帳。

aws qldb update-ledger-permissions-mode \
    --name myExampleLedger \
    --permissions-mode ALLOW_ALL

輸出：

{
    "Name": "myExampleLedger",
    "Arn": "arn:aws:qldb:us-west-2:123456789012:ledger/myExampleLedger",
    "PermissionsMode": "ALLOW_ALL"
}

如需詳細資訊，請參閱 Amazon QLDB 開發人員指南中的 Amazon Word Ledgers 基本操作。 QLDB

下列程式碼範例示範如何使用 update-ledger。

AWS CLI

範例 1：更新分類帳的刪除保護屬性

下列update-ledger範例會更新指定的分類帳以停用刪除保護功能。

aws qldb update-ledger \
    --name myExampleLedger \
    --no-deletion-protection

輸出：

{
    "CreationDateTime": 1568839243.951,
    "Arn": "arn:aws:qldb:us-west-2:123456789012:ledger/myExampleLedger",
    "DeletionProtection": false,
    "Name": "myExampleLedger",
    "State": "ACTIVE"
}

範例 2：將分類帳的 AWS KMS 金鑰更新為客戶受管金鑰

下列update-ledger範例會更新指定的分類帳，以使用客戶受管 KMS 金鑰進行靜態加密。

aws qldb update-ledger \
    --name myExampleLedger \
    --kms-key arn:aws:kms:us-west-2:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

輸出：

{
    "CreationDateTime": 1568839243.951,
    "Arn": "arn:aws:qldb:us-west-2:123456789012:ledger/myExampleLedger",
    "DeletionProtection": false,
    "Name": "myExampleLedger",
    "State": "ACTIVE",
    "EncryptionDescription": {
        "KmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "EncryptionStatus": "UPDATING"
    }
}

範例 3：將分類帳的 AWS KMS 金鑰更新為 AWS 擁有的金鑰

下列update-ledger範例會更新指定的分類帳，以使用 AWS 擁有的 KMS 金鑰進行靜態加密。

aws qldb update-ledger \
    --name myExampleLedger \
    --kms-key AWS_OWNED_KMS_KEY

輸出：

{
    "CreationDateTime": 1568839243.951,
    "Arn": "arn:aws:qldb:us-west-2:123456789012:ledger/myExampleLedger",
    "DeletionProtection": false,
    "Name": "myExampleLedger",
    "State": "ACTIVE",
    "EncryptionDescription": {
        "KmsKeyArn": "AWS_OWNED_KMS_KEY",
        "EncryptionStatus": "UPDATING"
    }
}

如需詳細資訊，請參閱 Amazon QLDB 開發人員指南中的 Amazon Word Ledgers 基本操作。 QLDB

  • 如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 UpdateLedger。