CreateCampaign - Amazon Personalize

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

CreateCampaign

Creates a campaign by deploying a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request.

Minimum Provisioned TPS and Auto-Scaling

A transaction is a single GetRecommendations or GetPersonalizedRanking call. Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum provisioned TPS (minProvisionedTPS) specifies the baseline throughput provisioned by Amazon Personalize, and thus, the minimum billing charge.

If your TPS increases beyond minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minProvisionedTPS. There's a short time delay while the capacity is increased that might cause loss of transactions.

The actual TPS used is calculated as the average requests/second within a 5-minute window. You pay for maximum of either the minimum provisioned TPS or the actual TPS. We recommend starting with a low minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary.

ステータス

A campaign can be in one of the following states:

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

  • DELETE PENDING > DELETE IN_PROGRESS

To get the campaign status, call DescribeCampaign.

注記

Wait until the status of the campaign is ACTIVE before asking the campaign for recommendations.

リクエストの構文

{ "campaignConfig": { "itemExplorationConfig": { "string" : "string" } }, "minProvisionedTPS": number, "name": "string", "solutionVersionArn": "string" }

リクエストパラメータ

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

campaignConfig

The configuration details of a campaign.

タイプ: CampaignConfig オブジェクト

Required: いいえ

minProvisionedTPS

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.

タイプ: 整数

Valid Range: 最小値は 1 です。

Required: はい

name

A name for the new campaign. The campaign name must be unique within your account.

タイプ: 文字列

Length Constraints: 最小長は 1 です。 最大長は 63 です。

パターン: ^[a-zA-Z0-9][a-zA-Z0-9\-_]*

Required: はい

solutionVersionArn

デプロイするソリューションバージョンの Amazon リソースネーム (ARN)。

タイプ: 文字列

Length Constraints: 最大長は 256 です。

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

Required: はい

レスポンスの構文

{ "campaignArn": "string" }

レスポンス要素

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

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

campaignArn

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

タイプ: 文字列

Length Constraints: 最大長は 256 です。

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

Errors

InvalidInputException

Provide a valid value for the field or parameter.

HTTP Status Code: 400

LimitExceededException

The limit on the number of requests per second has been exceeded.

HTTP Status Code: 400

ResourceAlreadyExistsException

The specified resource already exists.

HTTP Status Code: 400

ResourceInUseException

The specified resource is in use.

HTTP Status Code: 400

ResourceNotFoundException

Could not find the specified resource.

HTTP Status Code: 400

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

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