翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
DescribeSecurityPolicy
サーバーまたは SFTP コネクタにアタッチされているセキュリティポリシーについて説明します。レスポンスには、セキュリティポリシーのプロパティの説明が含まれます。セキュリティポリシーの詳細については、「サーバーのセキュリティポリシーの使用」または「SFTP コネクタのセキュリティポリシーの使用」を参照してください。
リクエストの構文
{
"SecurityPolicyName": "string"
}リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下の JSON 形式のデータを受け入れます。
- SecurityPolicyName
-
詳細を取得するセキュリティポリシーのテキスト名を指定します。
型: 文字列
長さの制限: 最小長は 0 です。最大長は 100 です。
パターン:
Transfer[A-Za-z0-9]*SecurityPolicy-[A-Za-z0-9-]+必須：はい
レスポンスの構文
{
"SecurityPolicy": {
"Fips": boolean,
"Protocols": [ "string" ],
"SecurityPolicyName": "string",
"SshCiphers": [ "string" ],
"SshHostKeyAlgorithms": [ "string" ],
"SshKexs": [ "string" ],
"SshMacs": [ "string" ],
"TlsCiphers": [ "string" ],
"Type": "string"
}
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- SecurityPolicy
-
セキュリティポリシーのプロパティを含む配列。
型: DescribedSecurityPolicy オブジェクト
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InternalServiceError
-
この例外は、 AWS Transfer Family サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード：500
- InvalidRequestException
-
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード：400
- ResourceNotFoundException
-
この例外は、 AWS Transfer Family サービスによってリソースが見つからない場合にスローされます。
HTTP ステータスコード：400
- ServiceUnavailableException
-
AWS Transfer Family サービスが利用できないため、リクエストは失敗しました。
HTTP ステータスコード：500
例
例
次のコマンド例は、セキュリティポリシー名を引数として受け取り、指定されたセキュリティポリシーのアルゴリズムを返します。
リクエスト例
aws transfer describe-security-policy --security-policy-name "TransferSecurityPolicy-FIPS-2023-05"レスポンス例
{
"SecurityPolicy": {
"Fips": true,
"SecurityPolicyName": "TransferSecurityPolicy-FIPS-2023-05",
"SshCiphers": [
"aes256-gcm@openssh.com",
"aes128-gcm@openssh.com",
"aes256-ctr",
"aes192-ctr"
],
"SshKexs": [
"diffie-hellman-group16-sha512",
"diffie-hellman-group18-sha512",
"diffie-hellman-group-exchange-sha256"
],
"SshMacs": [
"hmac-sha2-256-etm@openssh.com",
"hmac-sha2-512-etm@openssh.com"
],
"TlsCiphers": [
"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256",
"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256",
"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256",
"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256",
"TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384",
"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384",
"TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384",
"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384"
]
}
}その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
