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 |
Describes an Explainability resource created using the CreateExplainability operation.
Synopsis
- data DescribeExplainability = DescribeExplainability' {}
- newDescribeExplainability :: Text -> DescribeExplainability
- describeExplainability_explainabilityArn :: Lens' DescribeExplainability Text
- data DescribeExplainabilityResponse = DescribeExplainabilityResponse' {
- creationTime :: Maybe POSIX
- dataSource :: Maybe DataSource
- enableVisualization :: Maybe Bool
- endDateTime :: Maybe Text
- estimatedTimeRemainingInMinutes :: Maybe Integer
- explainabilityArn :: Maybe Text
- explainabilityConfig :: Maybe ExplainabilityConfig
- explainabilityName :: Maybe Text
- lastModificationTime :: Maybe POSIX
- message :: Maybe Text
- resourceArn :: Maybe Text
- schema :: Maybe Schema
- startDateTime :: Maybe Text
- status :: Maybe Text
- httpStatus :: Int
- newDescribeExplainabilityResponse :: Int -> DescribeExplainabilityResponse
- describeExplainabilityResponse_creationTime :: Lens' DescribeExplainabilityResponse (Maybe UTCTime)
- describeExplainabilityResponse_dataSource :: Lens' DescribeExplainabilityResponse (Maybe DataSource)
- describeExplainabilityResponse_enableVisualization :: Lens' DescribeExplainabilityResponse (Maybe Bool)
- describeExplainabilityResponse_endDateTime :: Lens' DescribeExplainabilityResponse (Maybe Text)
- describeExplainabilityResponse_estimatedTimeRemainingInMinutes :: Lens' DescribeExplainabilityResponse (Maybe Integer)
- describeExplainabilityResponse_explainabilityArn :: Lens' DescribeExplainabilityResponse (Maybe Text)
- describeExplainabilityResponse_explainabilityConfig :: Lens' DescribeExplainabilityResponse (Maybe ExplainabilityConfig)
- describeExplainabilityResponse_explainabilityName :: Lens' DescribeExplainabilityResponse (Maybe Text)
- describeExplainabilityResponse_lastModificationTime :: Lens' DescribeExplainabilityResponse (Maybe UTCTime)
- describeExplainabilityResponse_message :: Lens' DescribeExplainabilityResponse (Maybe Text)
- describeExplainabilityResponse_resourceArn :: Lens' DescribeExplainabilityResponse (Maybe Text)
- describeExplainabilityResponse_schema :: Lens' DescribeExplainabilityResponse (Maybe Schema)
- describeExplainabilityResponse_startDateTime :: Lens' DescribeExplainabilityResponse (Maybe Text)
- describeExplainabilityResponse_status :: Lens' DescribeExplainabilityResponse (Maybe Text)
- describeExplainabilityResponse_httpStatus :: Lens' DescribeExplainabilityResponse Int
Creating a Request
data DescribeExplainability Source #
See: newDescribeExplainability
smart constructor.
DescribeExplainability' | |
|
Instances
newDescribeExplainability Source #
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.
DescribeExplainabilityResponse' | |
|
Instances
newDescribeExplainabilityResponse Source #
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
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_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
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_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.