Skip to content

DescribeExplainabilityResponse

Source code in docs_src/capo_forecast/types/describe_explainability_response.py
class DescribeExplainabilityResponse(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 resource.</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>"""
    enable_visualization: NotRequired["capo_forecast.types.boolean.Boolean"]
    """<p>Whether the visualization was enabled for the Explainability resource.</p>"""
    data_source: NotRequired["capo_forecast.types.data_source.DataSource"]
    schema: NotRequired["capo_forecast.types.schema.Schema"]
    start_date_time: NotRequired["capo_forecast.types.local_date_time.LocalDateTime"]
    """<p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, the first time point in the Explainability.</p>"""
    end_date_time: NotRequired["capo_forecast.types.local_date_time.LocalDateTime"]
    """<p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, the last time point in the Explainability.</p>"""
    estimated_time_remaining_in_minutes: NotRequired["capo_forecast.types.long.Long"]
    """<p>The estimated time remaining in minutes for the <a>CreateExplainability</a> job to complete.</p>"""
    message: NotRequired["capo_forecast.types.message.Message"]
    """<p>If an error occurred, a message about the error.</p>"""
    status: NotRequired["capo_forecast.types.status.Status"]
    """<p>The status of the Explainability resource. 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>"""
    creation_time: NotRequired["capo_forecast.types.timestamp.Timestamp"]
    """<p>When the Explainability resource 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 resource was created.

data_source instance-attribute

data_source: NotRequired[DataSource]

enable_visualization instance-attribute

enable_visualization: NotRequired[Boolean]

Whether the visualization was enabled for the Explainability resource.

end_date_time instance-attribute

end_date_time: NotRequired[LocalDateTime]

If TimePointGranularity is set to SPECIFIC, the last time point in the Explainability.

estimated_time_remaining_in_minutes instance-attribute

estimated_time_remaining_in_minutes: NotRequired[Long]

The estimated time remaining in minutes for the CreateExplainability job to complete.

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]

If an error occurred, a message about the error.

resource_arn instance-attribute

resource_arn: NotRequired[Arn]

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

schema instance-attribute

schema: NotRequired[Schema]

start_date_time instance-attribute

start_date_time: NotRequired[LocalDateTime]

If TimePointGranularity is set to SPECIFIC, the first time point in the Explainability.

status instance-attribute

status: NotRequired[Status]

The status of the Explainability resource. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED