ListCampaigns - Amazon Personalize

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

ListCampaigns

指定されたソリューションを使用するキャンペーンのリストを返します。ソリューションを指定しないと、アカウントに関連付けられているすべてのキャンペーンが一覧表示されます。応答は Amazon リソースネーム (ARN) を含む各キャンペーンのプロパティを提供します。キャンペーンの詳細については、「」を参照してください。CreateCampaign

リクエストの構文

{ "maxResults": number, "nextToken": "string", "solutionArn": "string" }

リクエストパラメータ

リクエストは以下の JSON 形式のデータを受け入れます。

maxResults

返されるキャンペーンの最大数。

Type: 整数

有効範囲: 最小値は 1 です。最大値は 100 です。

必須: いいえ

nextToken

前回の呼び出しから返されたトークンキャンペーンを一覧表示次のキャンペーンセット(存在する場合)を取得するためのものです。

Type: 文字列

長さの制約: 最大長は 1500 です。

必須: いいえ

solutionArn

キャンペーンをリストするソリューションの Amazon リソースネーム (ARN)。ソリューションを指定しないと、アカウントに関連付けられているすべてのキャンペーンが一覧表示されます。

Type: 文字列

長さの制約: 最大長は 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

キャンペーンのリスト。

Type: の配列CampaignSummaryオブジェクト

配列メンバ: 最大数は 100 項目です。

nextToken

次のキャンペーンセットを取得するためのトークン(存在する場合)。

Type: 文字列

長さの制約: 最大長は 1500 です。

エラー

InvalidInputException

フィールドまたはパラメータに有効な値を指定します。

HTTP ステータスコード: 400

InvalidNextTokenException

トークンが無効です。

HTTP ステータスコード: 400

以下の資料も参照してください。

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください: