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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes an Explainability export created using the CreateExplainabilityExport operation.

Synopsis

Creating a Request

data DescribeExplainabilityExport Source #

See: newDescribeExplainabilityExport smart constructor.

Constructors

DescribeExplainabilityExport'
Fields explainabilityExportArn :: Text The Amazon Resource Name (ARN) of the Explainability export.

Instances

Instances details

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

newDescribeExplainabilityExport Source #

Arguments

:: Text	`DescribeExplainabilityExport`
-> DescribeExplainabilityExport

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

DescribeExplainabilityExport, describeExplainabilityExport_explainabilityExportArn - The Amazon Resource Name (ARN) of the Explainability export.

Request Lenses

describeExplainabilityExport_explainabilityExportArn :: Lens' DescribeExplainabilityExport Text Source #

The Amazon Resource Name (ARN) of the Explainability export.

Destructuring the Response

data DescribeExplainabilityExportResponse Source #

See: newDescribeExplainabilityExportResponse smart constructor.

Constructors

DescribeExplainabilityExportResponse'

Fields

creationTime :: Maybe POSIX
When the Explainability export was created.
destination :: Maybe DataDestination
explainabilityArn :: Maybe Text
The Amazon Resource Name (ARN) of the Explainability export.
explainabilityExportArn :: Maybe Text
The Amazon Resource Name (ARN) of the Explainability export.
explainabilityExportName :: Maybe Text
The name of the Explainability export.
format :: Maybe Text
The format of the exported data, CSV or PARQUET.
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 occurred during the export.
status :: Maybe Text
The status of the Explainability export. 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 DescribeExplainabilityExportResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeExplainabilityExport Associated Types type Rep DescribeExplainabilityExportResponse :: Type -> Type # Methods from :: DescribeExplainabilityExportResponse -> Rep DescribeExplainabilityExportResponse x # to :: Rep DescribeExplainabilityExportResponse x -> DescribeExplainabilityExportResponse #
Read DescribeExplainabilityExportResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeExplainabilityExport Methods readsPrec :: Int -> ReadS DescribeExplainabilityExportResponse # readList :: ReadS [DescribeExplainabilityExportResponse] # readPrec :: ReadPrec DescribeExplainabilityExportResponse # readListPrec :: ReadPrec [DescribeExplainabilityExportResponse] #
Show DescribeExplainabilityExportResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeExplainabilityExport Methods showsPrec :: Int -> DescribeExplainabilityExportResponse -> ShowS # show :: DescribeExplainabilityExportResponse -> String # showList :: [DescribeExplainabilityExportResponse] -> ShowS #
NFData DescribeExplainabilityExportResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeExplainabilityExport Methods rnf :: DescribeExplainabilityExportResponse -> () #
Eq DescribeExplainabilityExportResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeExplainabilityExport Methods (==) :: DescribeExplainabilityExportResponse -> DescribeExplainabilityExportResponse -> Bool # (/=) :: DescribeExplainabilityExportResponse -> DescribeExplainabilityExportResponse -> Bool #
type Rep DescribeExplainabilityExportResponse Source #
Instance details Defined in Amazonka.Forecast.DescribeExplainabilityExport type Rep DescribeExplainabilityExportResponse = D1 ('MetaData "DescribeExplainabilityExportResponse" "Amazonka.Forecast.DescribeExplainabilityExport" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "DescribeExplainabilityExportResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "destination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataDestination))) :: (S1 ('MetaSel ('Just "explainabilityArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "explainabilityExportArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "explainabilityExportName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "format") '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 "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeExplainabilityExportResponse Source #

Arguments

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

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

DescribeExplainabilityExportResponse, describeExplainabilityExportResponse_creationTime - When the Explainability export was created.

DescribeExplainabilityExportResponse, describeExplainabilityExportResponse_destination - Undocumented member.

DescribeExplainabilityExportResponse, describeExplainabilityExportResponse_explainabilityArn - The Amazon Resource Name (ARN) of the Explainability export.

DescribeExplainabilityExport, describeExplainabilityExportResponse_explainabilityExportArn - The Amazon Resource Name (ARN) of the Explainability export.

DescribeExplainabilityExportResponse, describeExplainabilityExportResponse_explainabilityExportName - The name of the Explainability export.

DescribeExplainabilityExportResponse, describeExplainabilityExportResponse_format - The format of the exported data, CSV or PARQUET.

DescribeExplainabilityExportResponse, describeExplainabilityExportResponse_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.

DescribeExplainabilityExportResponse, describeExplainabilityExportResponse_message - Information about any errors that occurred during the export.

DescribeExplainabilityExportResponse, describeExplainabilityExportResponse_status - The status of the Explainability export. States include:

```
ACTIVE
```
CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
CREATE_STOPPING, CREATE_STOPPED
DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

$sel:httpStatus:DescribeExplainabilityExportResponse', describeExplainabilityExportResponse_httpStatus - The response's http status code.

Response Lenses

describeExplainabilityExportResponse_creationTime :: Lens' DescribeExplainabilityExportResponse (Maybe UTCTime) Source #

When the Explainability export was created.

describeExplainabilityExportResponse_destination :: Lens' DescribeExplainabilityExportResponse (Maybe DataDestination) Source #

Undocumented member.

describeExplainabilityExportResponse_explainabilityArn :: Lens' DescribeExplainabilityExportResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Explainability export.

describeExplainabilityExportResponse_explainabilityExportArn :: Lens' DescribeExplainabilityExportResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Explainability export.

describeExplainabilityExportResponse_explainabilityExportName :: Lens' DescribeExplainabilityExportResponse (Maybe Text) Source #

The name of the Explainability export.

describeExplainabilityExportResponse_format :: Lens' DescribeExplainabilityExportResponse (Maybe Text) Source #

The format of the exported data, CSV or PARQUET.

describeExplainabilityExportResponse_lastModificationTime :: Lens' DescribeExplainabilityExportResponse (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.

describeExplainabilityExportResponse_message :: Lens' DescribeExplainabilityExportResponse (Maybe Text) Source #

Information about any errors that occurred during the export.

describeExplainabilityExportResponse_status :: Lens' DescribeExplainabilityExportResponse (Maybe Text) Source #

The status of the Explainability export. States include:

```
ACTIVE
```
CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
CREATE_STOPPING, CREATE_STOPPED
DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

describeExplainabilityExportResponse_httpStatus :: Lens' DescribeExplainabilityExportResponse Int Source #

The response's http status code.