Skip to content

ExplainabilitySummary

Source code in docs_src/capo_forecast/types/explainability_summary.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class ExplainabilitySummary(TypedDict, closed=True):
    explainability_arn: NotRequired["capo_forecast.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the Explainability.</p>"""
    explainability_name: NotRequired["capo_forecast.types.name.Name"]
    """<p>The name of the Explainability.</p>"""
    resource_arn: NotRequired["capo_forecast.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.</p>"""
    explainability_config: NotRequired[
        "capo_forecast.types.explainability_config.ExplainabilityConfig"
    ]
    """<p>The configuration settings that define the granularity of time series and time points for the Explainability.</p>"""
    status: NotRequired["capo_forecast.types.status.Status"]
    """<p>The status of the Explainability. States include: </p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> </ul>"""
    message: NotRequired["capo_forecast.types.message.Message"]
    """<p>Information about any errors that may have occurred during the Explainability creation process.</p>"""
    creation_time: NotRequired["capo_forecast.types.timestamp.Timestamp"]
    """<p>When the Explainability was created.</p>"""
    last_modification_time: NotRequired["capo_forecast.types.timestamp.Timestamp"]
    """<p>The last time the resource was modified. The timestamp depends on the status of the job:</p> <ul> <li> <p> <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPING</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPED</code> - When the job stopped.</p> </li> <li> <p> <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or failed.</p> </li> </ul>"""

creation_time instance-attribute 

creation_time: NotRequired[Timestamp]

When the Explainability was created.

explainability_arn instance-attribute 

explainability_arn: NotRequired[Arn]

The Amazon Resource Name (ARN) of the Explainability.

explainability_config instance-attribute 

explainability_config: NotRequired[ExplainabilityConfig]

The configuration settings that define the granularity of time series and time points for the Explainability.

explainability_name instance-attribute 

explainability_name: NotRequired[Name]

The name of the Explainability.

last_modification_time instance-attribute 

last_modification_time: NotRequired[Timestamp]

The last time the resource was modified. The timestamp depends on the status of the job:

  • CREATE_PENDING - The CreationTime.

  • CREATE_IN_PROGRESS - The current timestamp.

  • CREATE_STOPPING - The current timestamp.

  • CREATE_STOPPED - When the job stopped.

  • ACTIVE or CREATE_FAILED - When the job finished or failed.

message instance-attribute 

message: NotRequired[Message]

Information about any errors that may have occurred during the Explainability creation process.

resource_arn instance-attribute 

resource_arn: NotRequired[Arn]

The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.

status instance-attribute 

status: NotRequired[Status]

The status of the Explainability. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED