翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
DescribeCampaign
ステータスを含む、特定のキャンペーンを記述します。
キャンペーンは、次に示す状態のいずれかになります。
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -または- CREATE FAILED
-
DELETE PENDING > DELETE IN_PROGRESS
status
が CREATE FAILED
の場合、レスポンスには理由を記述する failureReason
キーが含まれます。
キャンペーンの詳細については、を参照してくださいCreateCampaign。
リクエストの構文
{
"campaignArn": "string
"
}
リクエストパラメータ
リクエストは以下の JSON 形式のデータを受け入れます。
- campaignArn
-
キャンペーンの Amazon リソースネーム (ARN)。
型: 文字列
長さの制限:最大長は 256 です。
パターン:
arn:([a-z\d-]+):personalize:.*:.*:.+
必須:はい
レスポンスの構文
{
"campaign": {
"campaignArn": "string",
"campaignConfig": {
"enableMetadataWithRecommendations": boolean,
"itemExplorationConfig": {
"string" : "string"
},
"syncWithLatestSolutionVersion": boolean
},
"creationDateTime": number,
"failureReason": "string",
"lastUpdatedDateTime": number,
"latestCampaignUpdate": {
"campaignConfig": {
"enableMetadataWithRecommendations": boolean,
"itemExplorationConfig": {
"string" : "string"
},
"syncWithLatestSolutionVersion": boolean
},
"creationDateTime": number,
"failureReason": "string",
"lastUpdatedDateTime": number,
"minProvisionedTPS": number,
"solutionVersionArn": "string",
"status": "string"
},
"minProvisionedTPS": number,
"name": "string",
"solutionVersionArn": "string",
"status": "string"
}
}
レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
エラー
- InvalidInputException
-
フィールドまたはパラメータに有効な値を指定します。
HTTP ステータスコード:400
- ResourceNotFoundException
-
指定されたリソースが見つかりませんでした。
HTTP ステータスコード:400
その他の参照資料
言語固有の AWS SDK の 1 つでこの API を使用する方法について詳しくは、以下を参照してください。