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.DescribeExplainability

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes an Explainability resource created using the CreateExplainability operation.

Synopsis

Creating a Request

data DescribeExplainability Source #

See: newDescribeExplainability smart constructor.

Constructors

DescribeExplainability'
Fields explainabilityArn :: Text The Amazon Resource Name (ARN) of the Explaianability to describe.

Instances

Instances details

ToJSON DescribeExplainability Source #
Instance details Defined in Amazonka.Forecast.DescribeExplainability Methods toJSON :: DescribeExplainability -> Value # toEncoding :: DescribeExplainability -> Encoding # toJSONList :: [DescribeExplainability] -> Value # toEncodingList :: [DescribeExplainability] -> Encoding #
ToHeaders DescribeExplainability Source #
Instance details Defined in Amazonka.Forecast.DescribeExplainability Methods toHeaders :: DescribeExplainability -> [Header] #
ToPath DescribeExplainability Source #
Instance details Defined in Amazonka.Forecast.DescribeExplainability Methods toPath :: DescribeExplainability -> ByteString #
ToQuery DescribeExplainability Source #
Instance details Defined in Amazonka.Forecast.DescribeExplainability Methods toQuery :: DescribeExplainability -> QueryString #
AWSRequest DescribeExplainability Source #
Instance details Defined in Amazonka.Forecast.DescribeExplainability Associated Types type AWSResponse DescribeExplainability # Methods request :: (Service -> Service) -> DescribeExplainability -> Request DescribeExplainability # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeExplainability -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeExplainability))) #
Generic DescribeExplainability Source #
Instance details Defined in Amazonka.Forecast.DescribeExplainability Associated Types type Rep DescribeExplainability :: Type -> Type # Methods from :: DescribeExplainability -> Rep DescribeExplainability x # to :: Rep DescribeExplainability x -> DescribeExplainability #
Read DescribeExplainability Source #
Instance details Defined in Amazonka.Forecast.DescribeExplainability Methods readsPrec :: Int -> ReadS DescribeExplainability # readList :: ReadS [DescribeExplainability] # readPrec :: ReadPrec DescribeExplainability # readListPrec :: ReadPrec [DescribeExplainability] #
Show DescribeExplainability Source #
Instance details Defined in Amazonka.Forecast.DescribeExplainability Methods showsPrec :: Int -> DescribeExplainability -> ShowS # show :: DescribeExplainability -> String # showList :: [DescribeExplainability] -> ShowS #
NFData DescribeExplainability Source #
Instance details Defined in Amazonka.Forecast.DescribeExplainability Methods rnf :: DescribeExplainability -> () #
Eq DescribeExplainability Source #
Instance details Defined in Amazonka.Forecast.DescribeExplainability Methods (==) :: DescribeExplainability -> DescribeExplainability -> Bool # (/=) :: DescribeExplainability -> DescribeExplainability -> Bool #
Hashable DescribeExplainability Source #
Instance details Defined in Amazonka.Forecast.DescribeExplainability Methods hashWithSalt :: Int -> DescribeExplainability -> Int # hash :: DescribeExplainability -> Int #
type AWSResponse DescribeExplainability Source #
Instance details Defined in Amazonka.Forecast.DescribeExplainability type AWSResponse DescribeExplainability = DescribeExplainabilityResponse
type Rep DescribeExplainability Source #
Instance details Defined in Amazonka.Forecast.DescribeExplainability type Rep DescribeExplainability = D1 ('MetaData "DescribeExplainability" "Amazonka.Forecast.DescribeExplainability" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "DescribeExplainability'" 'PrefixI 'True) (S1 ('MetaSel ('Just "explainabilityArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeExplainability Source #

Arguments

:: Text	`DescribeExplainability`
-> DescribeExplainability

Create a value of DescribeExplainability 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:

DescribeExplainability, describeExplainability_explainabilityArn - The Amazon Resource Name (ARN) of the Explaianability to describe.

Request Lenses

describeExplainability_explainabilityArn :: Lens' DescribeExplainability Text Source #

The Amazon Resource Name (ARN) of the Explaianability to describe.

Destructuring the Response

data DescribeExplainabilityResponse Source #

See: newDescribeExplainabilityResponse smart constructor.

Constructors

DescribeExplainabilityResponse'

Fields

creationTime :: Maybe POSIX
When the Explainability resource was created.
dataSource :: Maybe DataSource
enableVisualization :: Maybe Bool
Whether the visualization was enabled for the Explainability resource.
endDateTime :: Maybe Text
If TimePointGranularity is set to SPECIFIC, the last time point in the Explainability.
estimatedTimeRemainingInMinutes :: Maybe Integer
The estimated time remaining in minutes for the CreateExplainability job to complete.
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
If an error occurred, a message about the error.
resourceArn :: Maybe Text
The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability resource.
schema :: Maybe Schema
startDateTime :: Maybe Text
If TimePointGranularity is set to SPECIFIC, the first time point in the Explainability.
status :: Maybe Text
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
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeExplainabilityResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeExplainability Associated Types type Rep DescribeExplainabilityResponse :: Type -> Type # Methods from :: DescribeExplainabilityResponse -> Rep DescribeExplainabilityResponse x # to :: Rep DescribeExplainabilityResponse x -> DescribeExplainabilityResponse #
Read DescribeExplainabilityResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeExplainability Methods readsPrec :: Int -> ReadS DescribeExplainabilityResponse # readList :: ReadS [DescribeExplainabilityResponse] # readPrec :: ReadPrec DescribeExplainabilityResponse # readListPrec :: ReadPrec [DescribeExplainabilityResponse] #
Show DescribeExplainabilityResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeExplainability Methods showsPrec :: Int -> DescribeExplainabilityResponse -> ShowS # show :: DescribeExplainabilityResponse -> String # showList :: [DescribeExplainabilityResponse] -> ShowS #
NFData DescribeExplainabilityResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeExplainability Methods rnf :: DescribeExplainabilityResponse -> () #
Eq DescribeExplainabilityResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeExplainability Methods (==) :: DescribeExplainabilityResponse -> DescribeExplainabilityResponse -> Bool # (/=) :: DescribeExplainabilityResponse -> DescribeExplainabilityResponse -> Bool #
type Rep DescribeExplainabilityResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeExplainability type Rep DescribeExplainabilityResponse = D1 ('MetaData "DescribeExplainabilityResponse" "Amazonka.Forecast.DescribeExplainability" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "DescribeExplainabilityResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "dataSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSource)) :: S1 ('MetaSel ('Just "enableVisualization") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "endDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "estimatedTimeRemainingInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :: (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 "schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Schema)) :: S1 ('MetaSel ('Just "startDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeExplainabilityResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeExplainabilityResponse'`
-> DescribeExplainabilityResponse

Create a value of DescribeExplainabilityResponse 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:

DescribeExplainabilityResponse, describeExplainabilityResponse_creationTime - When the Explainability resource was created.

DescribeExplainabilityResponse, describeExplainabilityResponse_dataSource - Undocumented member.

$sel:enableVisualization:DescribeExplainabilityResponse', describeExplainabilityResponse_enableVisualization - Whether the visualization was enabled for the Explainability resource.

$sel:endDateTime:DescribeExplainabilityResponse', describeExplainabilityResponse_endDateTime - If TimePointGranularity is set to SPECIFIC, the last time point in the Explainability.

$sel:estimatedTimeRemainingInMinutes:DescribeExplainabilityResponse', describeExplainabilityResponse_estimatedTimeRemainingInMinutes - The estimated time remaining in minutes for the CreateExplainability job to complete.

DescribeExplainability, describeExplainabilityResponse_explainabilityArn - The Amazon Resource Name (ARN) of the Explainability.

DescribeExplainabilityResponse, describeExplainabilityResponse_explainabilityConfig - The configuration settings that define the granularity of time series and time points for the Explainability.

DescribeExplainabilityResponse, describeExplainabilityResponse_explainabilityName - The name of the Explainability.

DescribeExplainabilityResponse, describeExplainabilityResponse_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.

DescribeExplainabilityResponse, describeExplainabilityResponse_message - If an error occurred, a message about the error.

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

DescribeExplainabilityResponse, describeExplainabilityResponse_schema - Undocumented member.

$sel:startDateTime:DescribeExplainabilityResponse', describeExplainabilityResponse_startDateTime - If TimePointGranularity is set to SPECIFIC, the first time point in the Explainability.

DescribeExplainabilityResponse, describeExplainabilityResponse_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

$sel:httpStatus:DescribeExplainabilityResponse', describeExplainabilityResponse_httpStatus - The response's http status code.

Response Lenses

describeExplainabilityResponse_creationTime :: Lens' DescribeExplainabilityResponse (Maybe UTCTime) Source #

When the Explainability resource was created.

describeExplainabilityResponse_dataSource :: Lens' DescribeExplainabilityResponse (Maybe DataSource) Source #

Undocumented member.

describeExplainabilityResponse_enableVisualization :: Lens' DescribeExplainabilityResponse (Maybe Bool) Source #

Whether the visualization was enabled for the Explainability resource.

describeExplainabilityResponse_endDateTime :: Lens' DescribeExplainabilityResponse (Maybe Text) Source #

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

describeExplainabilityResponse_estimatedTimeRemainingInMinutes :: Lens' DescribeExplainabilityResponse (Maybe Integer) Source #

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

describeExplainabilityResponse_explainabilityArn :: Lens' DescribeExplainabilityResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Explainability.

describeExplainabilityResponse_explainabilityConfig :: Lens' DescribeExplainabilityResponse (Maybe ExplainabilityConfig) Source #

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

describeExplainabilityResponse_explainabilityName :: Lens' DescribeExplainabilityResponse (Maybe Text) Source #

The name of the Explainability.

describeExplainabilityResponse_lastModificationTime :: Lens' DescribeExplainabilityResponse (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.

describeExplainabilityResponse_message :: Lens' DescribeExplainabilityResponse (Maybe Text) Source #

If an error occurred, a message about the error.

describeExplainabilityResponse_resourceArn :: Lens' DescribeExplainabilityResponse (Maybe Text) Source #

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

describeExplainabilityResponse_schema :: Lens' DescribeExplainabilityResponse (Maybe Schema) Source #

Undocumented member.

describeExplainabilityResponse_startDateTime :: Lens' DescribeExplainabilityResponse (Maybe Text) Source #

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

describeExplainabilityResponse_status :: Lens' DescribeExplainabilityResponse (Maybe Text) Source #

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

describeExplainabilityResponse_httpStatus :: Lens' DescribeExplainabilityResponse Int Source #

The response's http status code.