DescribeWhatIfForecast - Amazon Forecast
구문 요청요청 파라미터응답 구문Response ElementsErrors참고

Amazon Forecast는 더 이상 신규 고객에게 제공되지 않습니다. Amazon Forecast의 기존 고객은 서비스를 정상적으로 계속 사용할 수 있습니다. 자세히 알아보기

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

DescribeWhatIfForecast

CreateWhatIfForecast 작업을 사용하여 생성한 what-if 예측을 설명합니다.

중요

신규 고객은 더 이상 Amazon Forecast를 사용할 수 없습니다. Amazon Forecast의 기존 고객은 서비스를 정상적으로 계속 사용할 수 있습니다. 자세히 알아보기

이 작업은 CreateWhatIfForecast 요청에서 제공된 속성을 나열하는 것 외에도 다음 속성을 나열합니다.

  • CreationTime

  • LastModificationTime

  • Message - 오류가 발생한 경우 오류에 대한 정보.

  • Status

구문 요청

{
   "WhatIfForecastArn": "string"
}

요청 파라미터

요청은 다음과 같은 JSON 형식의 데이터를 수락합니다.

WhatIfForecastArn

관심 있는 가정 예측의 Amazon 리소스 이름 (ARN)

유형: 문자열

길이 제약 조건: 최대 길이는 300입니다.

Pattern: arn:([a-z\d-]+):forecast:.*:.*:.+

필수 여부: 예

응답 구문

{
   "CreationTime": number,
   "EstimatedTimeRemainingInMinutes": number,
   "ForecastTypes": [ "string" ],
   "LastModificationTime": number,
   "Message": "string",
   "Status": "string",
   "TimeSeriesReplacementsDataSource": { 
      "Format": "string",
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      },
      "Schema": { 
         "Attributes": [ 
            { 
               "AttributeName": "string",
               "AttributeType": "string"
            }
         ]
      },
      "TimestampFormat": "string"
   },
   "TimeSeriesTransformations": [ 
      { 
         "Action": { 
            "AttributeName": "string",
            "Operation": "string",
            "Value": number
         },
         "TimeSeriesConditions": [ 
            { 
               "AttributeName": "string",
               "AttributeValue": "string",
               "Condition": "string"
            }
         ]
      }
   ],
   "WhatIfAnalysisArn": "string",
   "WhatIfForecastArn": "string",
   "WhatIfForecastName": "string"
}

Response Elements

작업이 성공하면 서비스는 HTTP 200개의 응답을 다시 보냅니다.

서비스는 다음 데이터를 JSON 형식으로 반환합니다.

CreationTime

what-if 예측이 생성된 시점.

유형: 타임스탬프

EstimatedTimeRemainingInMinutes

what-if 예측 완료까지 남은 대략적인 시간(분).

타입: Long

ForecastTypes

확률적 예측이 생성되는 분위수입니다. CreateWhatIfForecast 작업에서 what-if 예측당 최대 5개의 분위수를 지정할 수 있습니다. 분위수를 지정하지 않은 경우 기본값은 ["0.1", "0.5", "0.9"]입니다.

타입: 문자열 배열

배열 멤버: 최소 항목 수는 1개입니다. 최대 항목 수는 20개입니다.

길이 제약: 최소 길이는 2입니다. 최대 길이는 4입니다.

패턴: (^0?\.\d\d?$|^mean$)

LastModificationTime

리소스가 마지막으로 수정된 시간입니다. 타임스탬프는 작업 상태에 따라 달라집니다.

  • CREATE_PENDING: CreationTime.

  • CREATE_IN_PROGRESS - 현재 타임스탬프.

  • CREATE_STOPPING - 현재 타임스탬프.

  • CREATE_STOPPED - 작업이 중지된 시점.

  • ACTIVE 또는 CREATE_FAILED - 작업이 완료되거나 실패한 경우.

유형: 타임스탬프

Message

오류가 발생한 경우 오류에 대한 정보 메시지.

유형: 문자열

Status

what-if 예측의 상태입니다. 상태는 다음을 포함합니다.

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

참고

what-if 예측에 액세스하려면 what-if 예측의 Status가 ACTIVE여야 합니다.

유형: 문자열

길이 제약: 최대 길이 256.

패턴: ^[a-zA-Z0-9\_]+$

TimeSeriesReplacementsDataSource

대체 시계열을 설명하는 S3Config, Schema, Format 요소의 배열입니다.

유형: TimeSeriesReplacementsDataSource 객체

TimeSeriesTransformations

각 시계열에 어떤 변환이 적용되었는지 설명하는 Action 및 TimeSeriesConditions 요소로 구성된 배열입니다.

유형: TimeSeriesTransformation객체 어레이

배열 구성원: 최소수는 0개입니다. 최대 항목 수는 30개입니다.

WhatIfAnalysisArn

이 예측이 포함된 what-if 분석의 Amazon 리소스 이름 (ARN)

유형: 문자열

길이 제약: 최대 길이 256.

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

WhatIfForecastArn

가정 예측의 Amazon 리소스 이름 (ARN)

유형: 문자열

길이 제약 조건: 최대 길이는 300입니다.

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

WhatIfForecastName

what-if 예측의 이름입니다.

유형: 문자열

길이 제약: 최소 길이 1. 최대 길이 63.

패턴: ^[a-zA-Z][a-zA-Z0-9_]*

Errors

InvalidInputException

요청에 잘못된 값이나 유효한 범위를 초과하는 값이 포함되어 있기 때문에 요청을 처리할 수 없습니다.

HTTP상태 코드: 400

ResourceNotFoundException

해당 Amazon 리소스 이름 (ARN) 을 가진 리소스를 찾을 수 없습니다. 를 ARN 확인하고 다시 시도하십시오.

HTTP상태 코드: 400

참고

언어별 사용 방법에 대한 자세한 내용은 AWS SDKs 다음을 참조하십시오. API