ListWhatIfAnalyses - Amazon Forecast

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

ListWhatIfAnalyses

CreateWhatIfAnalysis 작업을 사용하여 생성한 what-if 분석의 목록을 반환합니다. 이 작업은 각 what-if 분석마다 Amazon 리소스 이름(ARN)을 포함하여 속성의 요약을 반환합니다. what-if 분석 ARN을 DescribeWhatIfAnalysis 작업과 함께 사용하여 전체 속성 세트를 검색할 수 있습니다.

구문 요청

{ "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" }

요청 파라미터

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

Filters

필터 배열입니다. 각 필터마다 조건과 일치 문을 제공합니다. 조건은 문과 일치하는 what-if 분석 작업을 목록에 포함할지 제외할지 여부를 각각 지정하는 IS 또는 IS_NOT입니다. 일치 문은 키와 값으로 구성됩니다.

필터 속성

  • Condition - 적용할 조건입니다. 유효 값은 ISIS_NOT입니다. 문과 일치하는 what-if 분석 작업을 포함하려면 IS를 지정합니다. 일치하는 what-if 분석 작업을 제외하려면 IS_NOT을 지정합니다.

  • Key - 필터링할 파라미터의 이름입니다. 유효 값은 WhatIfAnalysisArnStatus입니다.

  • Value - 일치시킬 값입니다.

예를 들어 electricityWhatIf, 이름이 지정된 예측을 내보내는 모든 작업을 나열하려면 다음 필터를 지정하십시오.

"Filters": [ { "Condition": "IS", "Key": "WhatIfAnalysisArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIf" } ]

타입: Filter객체 배열

필수: 아니요

MaxResults

응답에서 반환할 총 항목 수입니다.

타입: 정수

유효 범위: 최소값 1. 최대값 100.

필수 여부: 아니요

NextToken

이전 요청의 결과가 잘린 경우 응답에는 NextToken이 포함됩니다. 다음 결과 세트를 검색하려면 다음 요청에서 토큰을 사용하세요. 토큰은 24시간 후 만료됩니다.

유형: 문자열

길이 제약: 최소 길이 1. 최대 길이는 3,000입니다.

패턴: .+

필수 여부: 아니요

응답 구문

{ "NextToken": "string", "WhatIfAnalyses": [ { "CreationTime": number, "ForecastArn": "string", "LastModificationTime": number, "Message": "string", "Status": "string", "WhatIfAnalysisArn": "string", "WhatIfAnalysisName": "string" } ] }

응답 요소

작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

NextToken

응답이 잘린 경우 Forecast는 이 토큰을 반환합니다. 다음 결과 세트를 검색하려면 다음 요청에서 토큰을 사용하세요.

유형: 문자열

길이 제약: 최소 길이 1. 최대 길이는 3,000입니다.

패턴: .+

WhatIfAnalyses

일치하는 분석을 설명하는 WhatIfAnalysisSummary 객체의 배열입니다.

타입: WhatIfAnalysisSummary 객체 배열

Errors

InvalidInputException

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

HTTP 상태 코드: 400

InvalidNextTokenException

토큰이 유효하지 않습니다. 토큰은 24시간 후 만료됩니다.

HTTP 상태 코드: 400

참고

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.