Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Forecast.Types.ExplainabilitySummary

Description

Synopsis

data ExplainabilitySummary = ExplainabilitySummary' {
- creationTime :: Maybe POSIX
- explainabilityArn :: Maybe Text
- explainabilityConfig :: Maybe ExplainabilityConfig
- explainabilityName :: Maybe Text
- lastModificationTime :: Maybe POSIX
- message :: Maybe Text
- resourceArn :: Maybe Text
- status :: Maybe Text
}
newExplainabilitySummary :: ExplainabilitySummary
explainabilitySummary_creationTime :: Lens' ExplainabilitySummary (Maybe UTCTime)
explainabilitySummary_explainabilityArn :: Lens' ExplainabilitySummary (Maybe Text)
explainabilitySummary_explainabilityConfig :: Lens' ExplainabilitySummary (Maybe ExplainabilityConfig)
explainabilitySummary_explainabilityName :: Lens' ExplainabilitySummary (Maybe Text)
explainabilitySummary_lastModificationTime :: Lens' ExplainabilitySummary (Maybe UTCTime)
explainabilitySummary_message :: Lens' ExplainabilitySummary (Maybe Text)
explainabilitySummary_resourceArn :: Lens' ExplainabilitySummary (Maybe Text)
explainabilitySummary_status :: Lens' ExplainabilitySummary (Maybe Text)

Documentation

data ExplainabilitySummary Source #

Provides a summary of the Explainability properties used in the ListExplainabilities operation. To get a complete set of properties, call the DescribeExplainability operation, and provide the listed ExplainabilityArn.

See: newExplainabilitySummary smart constructor.

Constructors

ExplainabilitySummary'

Fields

creationTime :: Maybe POSIX
When the Explainability was created.
explainabilityArn :: Maybe Text
The Amazon Resource Name (ARN) of the Explainability.
explainabilityConfig :: Maybe ExplainabilityConfig
The configuration settings that define the granularity of time series and time points for the Explainability.
explainabilityName :: Maybe Text
The name of the Explainability.
lastModificationTime :: Maybe POSIX
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 :: Maybe Text
Information about any errors that may have occurred during the Explainability creation process.
resourceArn :: Maybe Text
The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.
status :: Maybe Text
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

Instances

Instances details

FromJSON ExplainabilitySummary Source #
Instance details Defined in Amazonka.Forecast.Types.ExplainabilitySummary Methods parseJSON :: Value -> Parser ExplainabilitySummary # parseJSONList :: Value -> Parser [ExplainabilitySummary] #
Generic ExplainabilitySummary Source #
Instance details Defined in Amazonka.Forecast.Types.ExplainabilitySummary Associated Types type Rep ExplainabilitySummary :: Type -> Type # Methods from :: ExplainabilitySummary -> Rep ExplainabilitySummary x # to :: Rep ExplainabilitySummary x -> ExplainabilitySummary #
Read ExplainabilitySummary Source #
Instance details Defined in Amazonka.Forecast.Types.ExplainabilitySummary Methods readsPrec :: Int -> ReadS ExplainabilitySummary # readList :: ReadS [ExplainabilitySummary] # readPrec :: ReadPrec ExplainabilitySummary # readListPrec :: ReadPrec [ExplainabilitySummary] #
Show ExplainabilitySummary Source #
Instance details Defined in Amazonka.Forecast.Types.ExplainabilitySummary Methods showsPrec :: Int -> ExplainabilitySummary -> ShowS # show :: ExplainabilitySummary -> String # showList :: [ExplainabilitySummary] -> ShowS #
NFData ExplainabilitySummary Source #
Instance details Defined in Amazonka.Forecast.Types.ExplainabilitySummary Methods rnf :: ExplainabilitySummary -> () #
Eq ExplainabilitySummary Source #
Instance details Defined in Amazonka.Forecast.Types.ExplainabilitySummary Methods (==) :: ExplainabilitySummary -> ExplainabilitySummary -> Bool # (/=) :: ExplainabilitySummary -> ExplainabilitySummary -> Bool #
Hashable ExplainabilitySummary Source #
Instance details Defined in Amazonka.Forecast.Types.ExplainabilitySummary Methods hashWithSalt :: Int -> ExplainabilitySummary -> Int # hash :: ExplainabilitySummary -> Int #
type Rep ExplainabilitySummary Source #
Instance details Defined in Amazonka.Forecast.Types.ExplainabilitySummary type Rep ExplainabilitySummary = D1 ('MetaData "ExplainabilitySummary" "Amazonka.Forecast.Types.ExplainabilitySummary" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "ExplainabilitySummary'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "explainabilityArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "explainabilityConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExplainabilityConfig)) :: S1 ('MetaSel ('Just "explainabilityName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "lastModificationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newExplainabilitySummary :: ExplainabilitySummary Source #

Create a value of ExplainabilitySummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:creationTime:ExplainabilitySummary', explainabilitySummary_creationTime - When the Explainability was created.

$sel:explainabilityArn:ExplainabilitySummary', explainabilitySummary_explainabilityArn - The Amazon Resource Name (ARN) of the Explainability.

$sel:explainabilityConfig:ExplainabilitySummary', explainabilitySummary_explainabilityConfig - The configuration settings that define the granularity of time series and time points for the Explainability.

$sel:explainabilityName:ExplainabilitySummary', explainabilitySummary_explainabilityName - The name of the Explainability.

$sel:lastModificationTime:ExplainabilitySummary', explainabilitySummary_lastModificationTime - 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.

$sel:message:ExplainabilitySummary', explainabilitySummary_message - Information about any errors that may have occurred during the Explainability creation process.

$sel:resourceArn:ExplainabilitySummary', explainabilitySummary_resourceArn - The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.

$sel:status:ExplainabilitySummary', explainabilitySummary_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

explainabilitySummary_creationTime :: Lens' ExplainabilitySummary (Maybe UTCTime) Source #

When the Explainability was created.

explainabilitySummary_explainabilityArn :: Lens' ExplainabilitySummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Explainability.

explainabilitySummary_explainabilityConfig :: Lens' ExplainabilitySummary (Maybe ExplainabilityConfig) Source #

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

explainabilitySummary_explainabilityName :: Lens' ExplainabilitySummary (Maybe Text) Source #

The name of the Explainability.

explainabilitySummary_lastModificationTime :: Lens' ExplainabilitySummary (Maybe UTCTime) Source #

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.

explainabilitySummary_message :: Lens' ExplainabilitySummary (Maybe Text) Source #

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

explainabilitySummary_resourceArn :: Lens' ExplainabilitySummary (Maybe Text) Source #

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

explainabilitySummary_status :: Lens' ExplainabilitySummary (Maybe Text) Source #

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