UpdateCertificate - AWS Transfer Family

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

UpdateCertificate

証明書の有効および無効な日付を更新します。

リクエストの構文

{ "ActiveDate": number, "CertificateId": "string", "Description": "string", "InactiveDate": number }

リクエストパラメータ

すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。

リクエストは以下の JSON 形式のデータを受け入れます。

ActiveDate

証明書がいつアクティブになるかを指定するオプションの日付です。

型: タイムスタンプ

必須: いいえ

CertificateId

更新している証明書オブジェクトの識別子。

型: 文字列

長さの制限: 22 の固定長

Pattern: cert-([0-9a-f]{17})

必須:はい

Description

証明書を識別するための簡単な説明。

型: 文字列

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

Pattern: [\p{Graph}]+

必須: いいえ

InactiveDate

証明書がいつ非アクティブになるかを指定するオプションの日付です。

型: タイムスタンプ

必須: いいえ

レスポンスの構文

{ "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

ThrottlingException

リクエストのスロットリングにより、リクエストが拒否されました。

HTTP ステータスコード:400

以下は、証明書の有効な日付を更新する例であり、有効な日付を2022年1月16日のUTC時刻16:12:07に設定しています(UTC -5時間)。

リクエスト例

aws transfer update-certificate --certificate-id c-abcdefg123456hijk --active-date 2022-01-16T16:12:07-05:00

以下は、この API コールに対するレスポンスのサンプルです。

レスポンス例

"CertificateId": "c-abcdefg123456hijk"

その他の参照資料

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。