ImportCertificate - AWS Transfer Family

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

ImportCertificate

导入创建本地 (AS2) 配置文件和合作伙伴配置文件所需的签名和加密证书。

请求语法

{ "ActiveDate": number, "Certificate": "string", "CertificateChain": "string", "Description": "string", "InactiveDate": number, "PrivateKey": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "Usage": "string" }

请求参数

有关所有操作的通用参数的信息,请参阅通用参数

该请求接受以下JSON格式的数据。

ActiveDate

指定证书何时生效的可选日期。

类型:时间戳

必需:否

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

指定证书何时失效的可选日期。

类型:时间戳

必需:否

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

当 Transfer Family 服务找不到资源时,就会 AWS引发此异常。

HTTP状态码:400

ServiceUnavailableException

请求失败,因为 Trans AWS fer 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,请参阅以下内容: