DescribeCampaign - Personalize

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

DescribeCampaign

상태를 포함하여 해당 캠페인을 설명합니다.

캠페인은 다음 상태 중 하나일 수 있습니다.

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE 또는 CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

statusCREATE FAILED인 경우 응답에는 이유를 설명하는 failureReason키가 포함됩니다.

캠페인에 대한 자세한 내용은 CreateCampaign 단원을 참조하세요.

구문 요청

{ "campaignArn": "string" }

요청 파라미터

요청은 JSON 형식으로 다음 데이터를 받습니다.

campaignArn

캠페인의 Amazon 리소스 이름(ARN)입니다.

유형: 문자열

길이 제약: 최대 길이 256.

패턴: arn:([a-z\d-]+):personalize:.*:.*:.+

필수 여부: 예

응답 구문

{ "campaign": { "campaignArn": "string", "campaignConfig": { "enableMetadataWithRecommendations": boolean, "itemExplorationConfig": { "string" : "string" }, "rankingInfluence": { "string" : number }, "syncWithLatestSolutionVersion": boolean }, "creationDateTime": number, "failureReason": "string", "lastUpdatedDateTime": number, "latestCampaignUpdate": { "campaignConfig": { "enableMetadataWithRecommendations": boolean, "itemExplorationConfig": { "string" : "string" }, "rankingInfluence": { "string" : number }, "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 형식으로 반환됩니다.

campaign
참고

latestCampaignUpdate 필드는 캠페인에 하나 이상의 UpdateCampaign 직접 호출이 있는 경우에만 반환됩니다.

캠페인의 속성.

참고

latestCampaignUpdate 필드는 캠페인에 하나 이상의 UpdateCampaign 직접 호출이 있는 경우에만 반환됩니다.

타입: Campaign 객체

오류

InvalidInputException

필드 또는 파라미터에 유효한 값을 제공합니다.

HTTP 상태 코드: 400

ResourceNotFoundException

지정된 리소스를 찾을 수 없습니다.

HTTP 상태 코드: 400

참고

언어별AWSSDKs