翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
ListCertificates
にインポートされた現在の証明書のリストを返します AWS Transfer Family。結果を特定の数に制限したい場合は、MaxResults
パラメータに値を指定します。以前にコマンドを実行して NextToken
パラメーターに値が返された場合、その値を提供して、中断した場所から証明書のリストを続けることができます。
リクエストの構文
{
"MaxResults": number
,
"NextToken": "string
"
}
リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下の JSON 形式のデータを受け入れます。
- MaxResults
-
返却する証明書の最大数。
タイプ:整数
有効範囲: 最小値 は 1 です。最大値は 1000 です。
必須: いいえ
- NextToken
-
ListCertificates
からさらに結果を得られる場合、出力でNextToken
パラメータが返されます。その後、NextToken
パラメータに後続のコマンドを渡すことで、さらに証明書をリストアップし続けることができます。型: 文字列
長さの制限:最小長は 1 です。最大長は 6,144 です。
必須: いいえ
レスポンスの構文
{
"Certificates": [
{
"ActiveDate": number,
"Arn": "string",
"CertificateId": "string",
"Description": "string",
"InactiveDate": number,
"Status": "string",
"Type": "string",
"Usage": "string"
}
],
"NextToken": "string"
}
レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- Certificates
-
ListCertificates
呼び出しで指定された証明書の配列を返します。型: ListedCertificate オブジェクトの配列
- NextToken
-
次の証明書をリストするために使用できる次のトークンを返します。
型: 文字列
長さの制限:最小長は 1 です。最大長は 6,144 です。
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InternalServiceError
-
この例外は、 AWS Transfer Family サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード:500
- InvalidNextTokenException
-
渡された
NextToken
パラメータが無効です。HTTP ステータスコード:400
- InvalidRequestException
-
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード:400
- ResourceNotFoundException
-
この例外は、 AWS Transfer Family サービスによってリソースが見つからない場合にスローされます。
HTTP ステータスコード:400
- ServiceUnavailableException
-
AWS Transfer Family サービスが利用できないため、リクエストは失敗しました。
HTTP ステータスコード:500
その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。