DescribeExplainability - Amazon Forecast

Amazon Forecast は、新規のお客様は利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。詳細はこちら

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

DescribeExplainability

CreateExplainability オペレーションを使用して作成された Explainability リソースを記述します。

重要

Amazon Forecast は、新規のお客様は利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。詳細はこちら

リクエストの構文

{ "ExplainabilityArn": "string" }

リクエストパラメータ

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

ExplainabilityArn

記述する説明可能性の Amazon リソースネーム (ARN)。

型: 文字列

長さの制限:最大長は 256 です。

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

必須:はい

レスポンスの構文

{ "CreationTime": number, "DataSource": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "EnableVisualization": boolean, "EndDateTime": "string", "EstimatedTimeRemainingInMinutes": number, "ExplainabilityArn": "string", "ExplainabilityConfig": { "TimePointGranularity": "string", "TimeSeriesGranularity": "string" }, "ExplainabilityName": "string", "LastModificationTime": number, "Message": "string", "ResourceArn": "string", "Schema": { "Attributes": [ { "AttributeName": "string", "AttributeType": "string" } ] }, "StartDateTime": "string", "Status": "string" }

レスポンス要素

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

次のデータは、 サービスによって JSON 形式で返されます。

CreationTime

Explainability リソースが作成された時点。

型: タイムスタンプ

DataSource

データのソース、Amazon Forecast がデータにアクセスできるようにする AWS Identity and Access Management (IAM) ロール、およびオプションで AWS Key Management Service (KMS) キー。

型: DataSource オブジェクト

EnableVisualization

Explainability リソースのためにビジュアライゼーションが有効になっているかどうか。

型: ブール値

EndDateTime

TimePointGranularitySPECIFIC に設定されている場合、Explainability の最後の時間ポイント。

型: 文字列

長さの制限: 最大長は 19。

パターン: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$

EstimatedTimeRemainingInMinutes

CreateExplainability ジョブが完了するまでの推定残り時間 (分)。

型: 長整数

ExplainabilityArn

Explainability の Amazon リソースネーム (ARN)。

型: 文字列

長さの制限:最大長は 256 です。

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

ExplainabilityConfig

Explainability の時系列と時間ポイントの粒度を定義する構成設定。

型: ExplainabilityConfig オブジェクト

ExplainabilityName

Explainability の名前。

型: 文字列

長さの制限:最小長は 1 です。最大長は 63 です。

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

LastModificationTime

リソースの最終変更時刻。タイムスタンプは、ジョブのステータスによって異なります。

  • CREATE_PENDING (CreationTime)

  • CREATE_IN_PROGRESS - 現在のタイムスタンプ。

  • CREATE_STOPPING - 現在のタイムスタンプ。

  • CREATE_STOPPED - ジョブが停止した時点。

  • ACTIVE または CREATE_FAILED - ジョブが終了または失敗した時点。

型: タイムスタンプ

Message

エラーが発生した場合は、エラーに関するメッセージ。

型: 文字列

ResourceArn

Explainability リソースの作成に使用される Predictor または Forecast の Amazon リソースネーム (ARN)。

型: 文字列

長さの制限:最大長は 256 です。

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

Schema

データセットのフィールドを定義します。

型: Schema オブジェクト

StartDateTime

TimePointGranularitySPECIFIC に設定されている場合、Explainability の最初の時間ポイント。

型: 文字列

長さの制限: 最大長は 19。

パターン: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$

Status

Explainability リソースのステータス。含まれる状態は次のとおりです。

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

型: 文字列

長さの制限:最大長は 256 です。

エラー

InvalidInputException

無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。

HTTP ステータスコード: 400

ResourceNotFoundException

Amazon リソースネーム () を持つリソースが見つかりませんARN。を確認してARN、もう一度試してください。

HTTP ステータスコード: 400

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

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