翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
ListSecurityPolicies
サーバーと SFTP コネクタにアタッチされているセキュリティポリシーを一覧表示します。セキュリティポリシーの詳細については、「サーバーのセキュリティポリシーの使用」または「SFTP コネクタのセキュリティポリシーの使用」を参照してください。
リクエストの構文
{
"MaxResults": number,
"NextToken": "string"
}リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下の JSON 形式のデータを受け入れます。
- MaxResults
-
ListSecurityPoliciesクエリへのレスポンスとして返すセキュリティポリシーの数を指定します。型: 整数
有効範囲: 最小値 は 1 です。最大値は 1000 です。
必須: いいえ
- NextToken
-
ListSecurityPoliciesコマンドから付加的な結果を取得する際には、出力でNextTokenパラメータが返されます。以降のコマンドでNextTokenパラメータを渡すことで、追加のセキュリティポリシーを引き続き一覧表示できます。型: 文字列
長さの制限：最小長は 1 です。最大長は 6,144 です。
必須: いいえ
レスポンスの構文
{
"NextToken": "string",
"SecurityPolicyNames": [ "string" ]
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- NextToken
-
ListSecurityPoliciesオペレーションから付加的な結果を得られる場合、出力でNextTokenパラメータが返されます。次のコマンドでは、NextTokenパラメータを渡すことでセキュリティポリシーを引き続き一覧表示します。型: 文字列
長さの制限：最小長は 1 です。最大長は 6,144 です。
- SecurityPolicyNames
-
一覧表示されたセキュリティポリシーの配列。
タイプ：文字列の配列
長さの制限: 最小長は 0 です。最大長は 100 です。
パターン：
Transfer[A-Za-z0-9]*SecurityPolicy-[A-Za-z0-9-]+
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InternalServiceError
-
この例外は、 AWS Transfer Family サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード：500
- InvalidNextTokenException
-
渡された
NextTokenパラメータが無効です。HTTP ステータスコード：400
- InvalidRequestException
-
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード：400
- ServiceUnavailableException
-
AWS Transfer Family サービスが利用できないため、リクエストは失敗しました。
HTTP ステータスコード：500
例
例
次の例では、使用可能なすべてのセキュリティポリシーの名前を一覧表示します。
リクエスト例
aws transfer list-security-policiesレスポンス例
{
"SecurityPolicyNames": [
"TransferSecurityPolicy-2023-05",
"TransferSecurityPolicy-2022-03",
"TransferSecurityPolicy-FIPS-2024-01",
"TransferSecurityPolicy-2024-01",
"TransferSecurityPolicy-PQ-SSH-FIPS-Experimental-2023-04",
"TransferSecurityPolicy-PQ-SSH-Experimental-2023-04",
"TransferSecurityPolicy-FIPS-2020-06",
"TransferSecurityPolicy-2020-06",
"TransferSecurityPolicy-2018-11",
"TransferSecurityPolicy-FIPS-2023-05"
]
}その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
