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、証明書ファイルの raw コンテンツを指定します。例えば、--certificate "`cat encryption-cert.pem`" と指定します。

型: 文字列

長さの制限: 最小長は 1 です。最大長は 16384 です。

Pattern: [\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、プライベートキーファイルの raw コンテンツを指定します。例えば、--private-key "`cat encryption-key.pem`"

型: 文字列

長さの制限: 最小長は 1 です。最大長は 16384 です。

パターン: [\u0009\u000A\u000D\u0020-\u00FF]*

必須: いいえ

Tags

証明書のグループ化および検索に使用できるキーと値のペアです。

型: Tag オブジェクトの配列

配列メンバー:最小数は 1 項目です。最大数は 50 項目です。

必須:いいえ

Usage

この証明書を署名に使用するか、暗号化に使用するかを指定します。

型: 文字列

有効な値: SIGNING | ENCRYPTION

必須:はい

レスポンスの構文

{ "CertificateId": "string" }

レスポンス要素

アクションが成功すると、サービスは 200 HTTP レスポンスを送り返します。

次のデータは、 サービスによって 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、以下を参照してください。