Skip to content

CreateExplainabilityRequest

Source code in docs_src/capo_forecast/types/create_explainability_request.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
class CreateExplainabilityRequest(TypedDict, closed=True):
    explainability_name: "capo_forecast.types.name.Name"
    """<p>A unique name for the Explainability.</p>"""
    resource_arn: "capo_forecast.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.</p>"""
    explainability_config: (
        "capo_forecast.types.explainability_config.ExplainabilityConfig"
    )
    """<p>The configuration settings that define the granularity of time series and time points for the Explainability.</p>"""
    data_source: NotRequired["capo_forecast.types.data_source.DataSource"]
    schema: NotRequired["capo_forecast.types.schema.Schema"]
    enable_visualization: NotRequired["capo_forecast.types.boolean.Boolean"]
    """<p>Create an Explainability visualization that is viewable within the Amazon Web Services console.</p>"""
    start_date_time: NotRequired["capo_forecast.types.local_date_time.LocalDateTime"]
    """<p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the first point for the Explainability.</p> <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)</p>"""
    end_date_time: NotRequired["capo_forecast.types.local_date_time.LocalDateTime"]
    """<p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the last time point for the Explainability.</p> <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)</p>"""
    tags: NotRequired["capo_forecast.types.tags.Tags"]
    """<p>Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.</p> <p>The following restrictions apply to tags:</p> <ul> <li> <p>For each resource, each tag key must be unique and each tag key must have one value.</p> </li> <li> <p>Maximum number of tags per resource: 50.</p> </li> <li> <p>Maximum key length: 128 Unicode characters in UTF-8.</p> </li> <li> <p>Maximum value length: 256 Unicode characters in UTF-8.</p> </li> <li> <p>Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply. </p> </li> <li> <p>Key prefixes cannot include any upper or lowercase combination of <code>aws:</code> or <code>AWS:</code>. Values can have this prefix. If a tag value has <code>aws</code> as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.</p> </li> </ul>"""

data_source instance-attribute 

data_source: NotRequired[DataSource]

enable_visualization instance-attribute 

enable_visualization: NotRequired[Boolean]

Create an Explainability visualization that is viewable within the Amazon Web Services console.

end_date_time instance-attribute 

end_date_time: NotRequired[LocalDateTime]

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

Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)

explainability_config instance-attribute 

explainability_config: ExplainabilityConfig

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

explainability_name instance-attribute 

explainability_name: Name

A unique name for the Explainability.

resource_arn instance-attribute 

resource_arn: Arn

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

schema instance-attribute 

schema: NotRequired[Schema]

start_date_time instance-attribute 

start_date_time: NotRequired[LocalDateTime]

If TimePointGranularity is set to SPECIFIC, define the first point for the Explainability.

Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)

tags instance-attribute 

tags: NotRequired[Tags]

Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.

The following restrictions apply to tags:

  • For each resource, each tag key must be unique and each tag key must have one value.

  • Maximum number of tags per resource: 50.

  • Maximum key length: 128 Unicode characters in UTF-8.

  • Maximum value length: 256 Unicode characters in UTF-8.

  • Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.

  • Key prefixes cannot include any upper or lowercase combination of aws: or AWS:. Values can have this prefix. If a tag value has aws as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.