翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
ListCampaigns
特定のソリューションを使用するキャンペーンのリストを返します。ソリューションが指定されていない場合、アカウントに関連付けられているすべてのキャンペーンが一覧表示されます。レスポンスは、Amazon リソースネーム (ARN) など、各キャンペーンのプロパティを提供します。キャンペーンの詳細については、を参照してくださいCreateCampaign。
リクエストの構文
{
"maxResults": number,
"nextToken": "string",
"solutionArn": "string"
}リクエストパラメータ
リクエストは以下の JSON 形式のデータを受け入れます。
- maxResults
-
返されるキャンペーンの最大数。
タイプ：整数
有効範囲: 最小値 は 1 です。最大値は 100 です。
必須: いいえ
- nextToken
-
前回の呼び出しで返されたトークンで、次のキャンペーンセット (存在する場合) ListCampaignsを取得するために返されます。
型: 文字列
長さの制限: 最大長は 1500 です。
Pattern:
\p{ASCII}{0,1500}必須: いいえ
- solutionArn
-
キャンペーンを一覧表示するソリューションの Amazon リソースネーム (ARN)。ソリューションが指定されていない場合、アカウントに関連付けられているすべてのキャンペーンが一覧表示されます。
型: 文字列
長さの制限：最大長は 256 です。
パターン:
arn:([a-z\d-]+):personalize:.*:.*:.+必須: いいえ
レスポンスの構文
{
"campaigns": [
{
"campaignArn": "string",
"creationDateTime": number,
"failureReason": "string",
"lastUpdatedDateTime": number,
"name": "string",
"status": "string"
}
],
"nextToken": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- campaigns
-
キャンペーンのリスト。
型: CampaignSummary オブジェクトの配列
配列メンバー: 最大数は 100 項目です。
- nextToken
-
キャンペーンの次のセットを取得するためのトークン (存在する場合)。
型: 文字列
長さの制限: 最大長は 1500 です。
パターン：
\p{ASCII}{0,1500}
エラー
- InvalidInputException
-
フィールドまたはパラメータに有効な値を指定します。
HTTP ステータスコード：400
- InvalidNextTokenException
-
トークンが無効です。
HTTP ステータスコード：400
その他の参照資料
この API を言語固有の AWS SDK で使用する方法の詳細については、以下を参照してください。
