本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
匯入建立本機 (AS2) 設定檔和合作夥伴設定檔所需的簽署和加密憑證。
請求語法
{
"ActiveDate": number
,
"Certificate": "string
",
"CertificateChain": "string
",
"Description": "string
",
"InactiveDate": number
,
"PrivateKey": "string
",
"Tags": [
{
"Key": "string
",
"Value": "string
"
}
],
"Usage": "string
"
}
請求參數
如需所有動作的一般參數資訊,請參閱《Common Parameters》。
請求接受下列JSON格式的資料。
- ActiveDate
-
選擇性日期,指定憑證變為作用的時間。
類型:Timestamp
必要:否
- Certificate
-
-
對於 CLI, 會以 URI 格式提供憑證的檔案路徑。例如:
--certificate file://encryption-cert.pem
。或者,您可以提供原始內容。 -
針對 SDK,指定憑證檔案的原始內容。例如:
--certificate "`cat encryption-cert.pem`"
。
類型:字串
長度限制:長度下限為 1。長度上限為 16384。
模式:
[\u0009\u000A\u000D\u0020-\u00FF]*
必要:是
-
- CertificateChain
-
選擇性的憑證清單,構成匯入憑證的鏈。
類型:字串
長度限制:長度下限為 1。長度上限為 2097152。
模式:
[\u0009\u000A\u000D\u0020-\u00FF]*
必要:否
- Description
-
有助於識別憑證的簡短描述。
類型:字串
長度限制:長度下限為 1。長度上限為 200。
模式:
[\p{Graph}]+
必要:否
- InactiveDate
-
選擇性日期,指定憑證變為停用的時間。
類型:Timestamp
必要:否
- PrivateKey
-
-
對於 CLI,請以 URI 格式提供私有金鑰的檔案路徑。例如,
--private-key file://encryption-key.pem
。或者,您可以提供私有金鑰檔案的原始內容。 -
針對 SDK,指定私有金鑰檔案的原始內容。例如
--private-key "`cat encryption-key.pem`"
類型:字串
長度限制:長度下限為 1。長度上限為 16384。
模式:
[\u0009\u000A\u000D\u0020-\u00FF]*
必要:否
-
- Tags
-
金鑰/值對,可用來分組和搜尋憑證。
類型:Tag 物件陣列
陣列成員:項目數下限為 1。項目數上限為 50。
必要:否
- Usage
-
指定此憑證用於簽署或加密。
類型:字串
有效值:
SIGNING | ENCRYPTION
必要:是
回應語法
{
"CertificateId": "string"
}
回應元素
如果動作成功,服務會傳回 HTTP 200 個回應。
服務會以 JSON 格式傳回下列資料。
- CertificateId
-
已匯入憑證的識別碼陣列。您可以使用此識別碼處理設定檔和合作夥伴設定檔。
類型:字串
長度限制條件:固定長度為 22。
模式:
cert-([0-9a-f]{17})
錯誤
如需所有動作常見錯誤的資訊,請參閱常見錯誤。
- InternalServiceError
-
當 AWS Transfer Family 服務發生錯誤時,就會擲回此例外狀況。
HTTP 狀態碼:500
- InvalidRequestException
-
當用戶端提交格式不正確的請求時,就會擲回此例外狀況。
HTTP 狀態碼:400
- ResourceNotFoundException
-
當 AWS Transfer Family 服務找不到資源時,就會擲回此例外狀況。
HTTP 狀態碼:400
- ServiceUnavailableException
-
請求失敗,因為 AWS Transfer Family 服務無法使用。
HTTP 狀態碼:500
範例
範例
下列範例會匯入要用於加密的憑證。在第一個命令中,我們提供憑證和憑證鏈檔案的內容。針對SDK命令使用此格式。
aws transfer import-certificate --usage ENCRYPTION --certificate "`cat encryption-cert.pem`" \
--private-key "`cat encryption-key.pem`" --certificate-chain "`cat root-ca.pem`"
範例
下列範例與上述命令相同,除了我們為私有金鑰、憑證和憑證鏈檔案提供檔案位置。如果您使用的是 ,則此版本的命令無法運作SDK。
aws transfer import-certificate --usage ENCRYPTION --certificate file://encryption-cert.pem \
--private-key file://encryption-key.pem --certificate-chain file://root-ca.pem
另請參閱
如需在其中一種語言特定的 API中使用此功能的詳細資訊 AWS SDKs,請參閱下列內容: