DescribeCampaign - Amazon Personalize

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

DescribeCampaign

Describes the given campaign, including its status.

A campaign can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

When the status is CREATE FAILED, the response includes the failureReason key, which describes why.

For more information on campaigns, see CreateCampaign.

リクエストの構文

{ "campaignArn": "string" }

リクエストパラメータ

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

campaignArn

キャンペーンの Amazon リソースネーム (ARN)。

タイプ: 文字列

Length Constraints: 最大長は 256 です。

パターン: arn:([a-z\d-]+):personalize:.*:.*:.+

Required: はい

レスポンスの構文

{ "campaign": { "campaignArn": "string", "campaignConfig": { "itemExplorationConfig": { "string" : "string" } }, "creationDateTime": number, "failureReason": "string", "lastUpdatedDateTime": number, "latestCampaignUpdate": { "campaignConfig": { "itemExplorationConfig": { "string" : "string" } }, "creationDateTime": number, "failureReason": "string", "lastUpdatedDateTime": number, "minProvisionedTPS": number, "solutionVersionArn": "string", "status": "string" }, "minProvisionedTPS": number, "name": "string", "solutionVersionArn": "string", "status": "string" } }

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

キャンペーン

The properties of the campaign.

タイプ: Campaign オブジェクト

Errors

InvalidInputException

Provide a valid value for the field or parameter.

HTTP Status Code: 400

ResourceNotFoundException

Could not find the specified resource.

HTTP Status Code: 400

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

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