翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
UpdateProfile
既存のプロファイルのパラメータの一部を更新します。更新するプロファイルの ProfileId
と、更新するパラメータの新しい値を指定します。
リクエストの構文
{
"CertificateIds": [ "string
" ],
"ProfileId": "string
"
}
リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下の JSON 形式のデータを受け入れます。
- CertificateIds
-
インポートされた証明書の識別子の配列です。この識別子は、プロファイルやパートナープロファイルの操作に使用します。
タイプ:文字列の配列
長さの制限: 22 の固定長
Pattern:
cert-([0-9a-f]{17})
必須: いいえ
- ProfileId
-
更新するプロファイル オブジェクトの識別子。
型: 文字列
長さの制限: 固定長は 19 です。
Pattern:
p-([0-9a-f]{17})
必須:はい
レスポンスの構文
{
"ProfileId": "string"
}
レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- ProfileId
-
更新中のプロファイルの識別子を返します。
型: 文字列
長さの制限: 固定長は 19 です。
パターン:
p-([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
その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。