amazonka-forecast-2.0: Amazon Forecast Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Forecast.CreateExplainabilityExport

Description

Exports an Explainability resource created by the CreateExplainability operation. Exported files are exported to an Amazon Simple Storage Service (Amazon S3) bucket.

You must specify a DataDestination object that includes an Amazon S3 bucket and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.

The Status of the export job must be ACTIVE before you can access the export in your Amazon S3 bucket. To get the status, use the DescribeExplainabilityExport operation.

Synopsis

Creating a Request

data CreateExplainabilityExport Source #

See: newCreateExplainabilityExport smart constructor.

Constructors

CreateExplainabilityExport' 

Fields

  • format :: Maybe Text

    The format of the exported data, CSV or PARQUET.

  • tags :: Maybe [Tag]

    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.
  • explainabilityExportName :: Text

    A unique name for the Explainability export.

  • explainabilityArn :: Text

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

  • destination :: DataDestination
     

Instances

Instances details
ToJSON CreateExplainabilityExport Source # 
Instance details

Defined in Amazonka.Forecast.CreateExplainabilityExport

Methods

toJSON :: CreateExplainabilityExport -> Value #

toEncoding :: CreateExplainabilityExport -> Encoding #

toJSONList :: [CreateExplainabilityExport] -> Value #

toEncodingList :: [CreateExplainabilityExport] -> Encoding #

ToHeaders CreateExplainabilityExport Source # 
Instance details

Defined in Amazonka.Forecast.CreateExplainabilityExport

Methods

toHeaders :: CreateExplainabilityExport -> [Header] #

ToPath CreateExplainabilityExport Source # 
Instance details

Defined in Amazonka.Forecast.CreateExplainabilityExport

Methods

toPath :: CreateExplainabilityExport -> ByteString #

ToQuery CreateExplainabilityExport Source # 
Instance details

Defined in Amazonka.Forecast.CreateExplainabilityExport

Methods

toQuery :: CreateExplainabilityExport -> QueryString #

AWSRequest CreateExplainabilityExport Source # 
Instance details

Defined in Amazonka.Forecast.CreateExplainabilityExport

Associated Types

type AWSResponse CreateExplainabilityExport #

Methods

request :: (Service -> Service) -> CreateExplainabilityExport -> Request CreateExplainabilityExport #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateExplainabilityExport -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateExplainabilityExport))) #

Generic CreateExplainabilityExport Source # 
Instance details

Defined in Amazonka.Forecast.CreateExplainabilityExport

Associated Types

type Rep CreateExplainabilityExport :: Type -> Type #

Methods

from :: CreateExplainabilityExport -> Rep CreateExplainabilityExport x #

to :: Rep CreateExplainabilityExport x -> CreateExplainabilityExport #

Show CreateExplainabilityExport Source # 
Instance details

Defined in Amazonka.Forecast.CreateExplainabilityExport

Methods

showsPrec :: Int -> CreateExplainabilityExport -> ShowS #

show :: CreateExplainabilityExport -> String #

showList :: [CreateExplainabilityExport] -> ShowS #

NFData CreateExplainabilityExport Source # 
Instance details

Defined in Amazonka.Forecast.CreateExplainabilityExport

Methods

rnf :: CreateExplainabilityExport -> () #

Eq CreateExplainabilityExport Source # 
Instance details

Defined in Amazonka.Forecast.CreateExplainabilityExport

Methods

(==) :: CreateExplainabilityExport -> CreateExplainabilityExport -> Bool #

(/=) :: CreateExplainabilityExport -> CreateExplainabilityExport -> Bool #

Hashable CreateExplainabilityExport Source # 
Instance details

Defined in Amazonka.Forecast.CreateExplainabilityExport

Methods

hashWithSalt :: Int -> CreateExplainabilityExport -> Int #

hash :: CreateExplainabilityExport -> Int #

type AWSResponse CreateExplainabilityExport Source # 
Instance details

Defined in Amazonka.Forecast.CreateExplainabilityExport

type AWSResponse CreateExplainabilityExport = CreateExplainabilityExportResponse
type Rep CreateExplainabilityExport Source # 
Instance details

Defined in Amazonka.Forecast.CreateExplainabilityExport

type Rep CreateExplainabilityExport = D1 ('MetaData "CreateExplainabilityExport" "Amazonka.Forecast.CreateExplainabilityExport" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "CreateExplainabilityExport'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :*: (S1 ('MetaSel ('Just "explainabilityExportName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "explainabilityArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "destination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DataDestination)))))

newCreateExplainabilityExport Source #

Arguments

:: Text

CreateExplainabilityExport

-> Text

CreateExplainabilityExport

-> DataDestination

CreateExplainabilityExport

-> CreateExplainabilityExport 

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

CreateExplainabilityExport, createExplainabilityExport_format - The format of the exported data, CSV or PARQUET.

$sel:tags:CreateExplainabilityExport', createExplainabilityExport_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.

CreateExplainabilityExport, createExplainabilityExport_explainabilityExportName - A unique name for the Explainability export.

CreateExplainabilityExport, createExplainabilityExport_explainabilityArn - The Amazon Resource Name (ARN) of the Explainability to export.

CreateExplainabilityExport, createExplainabilityExport_destination - Undocumented member.

Request Lenses

createExplainabilityExport_format :: Lens' CreateExplainabilityExport (Maybe Text) Source #

The format of the exported data, CSV or PARQUET.

createExplainabilityExport_tags :: Lens' CreateExplainabilityExport (Maybe [Tag]) Source #

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.

createExplainabilityExport_explainabilityExportName :: Lens' CreateExplainabilityExport Text Source #

A unique name for the Explainability export.

createExplainabilityExport_explainabilityArn :: Lens' CreateExplainabilityExport Text Source #

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

createExplainabilityExport_destination :: Lens' CreateExplainabilityExport DataDestination Source #

Undocumented member.

Destructuring the Response

data CreateExplainabilityExportResponse Source #

See: newCreateExplainabilityExportResponse smart constructor.

Constructors

CreateExplainabilityExportResponse' 

Fields

Instances

Instances details
Generic CreateExplainabilityExportResponse Source # 
Instance details

Defined in Amazonka.Forecast.CreateExplainabilityExport

Associated Types

type Rep CreateExplainabilityExportResponse :: Type -> Type #

Methods

from :: CreateExplainabilityExportResponse -> Rep CreateExplainabilityExportResponse x #

to :: Rep CreateExplainabilityExportResponse x -> CreateExplainabilityExportResponse #

Read CreateExplainabilityExportResponse Source # 
Instance details

Defined in Amazonka.Forecast.CreateExplainabilityExport

Methods

readsPrec :: Int -> ReadS CreateExplainabilityExportResponse #

readList :: ReadS [CreateExplainabilityExportResponse] #

readPrec :: ReadPrec CreateExplainabilityExportResponse #

readListPrec :: ReadPrec [CreateExplainabilityExportResponse] #

Show CreateExplainabilityExportResponse Source # 
Instance details

Defined in Amazonka.Forecast.CreateExplainabilityExport

Methods

showsPrec :: Int -> CreateExplainabilityExportResponse -> ShowS #

show :: CreateExplainabilityExportResponse -> String #

showList :: [CreateExplainabilityExportResponse] -> ShowS #

NFData CreateExplainabilityExportResponse Source # 
Instance details

Defined in Amazonka.Forecast.CreateExplainabilityExport

Methods

rnf :: CreateExplainabilityExportResponse -> () #

Eq CreateExplainabilityExportResponse Source # 
Instance details

Defined in Amazonka.Forecast.CreateExplainabilityExport

Methods

(==) :: CreateExplainabilityExportResponse -> CreateExplainabilityExportResponse -> Bool #

(/=) :: CreateExplainabilityExportResponse -> CreateExplainabilityExportResponse -> Bool #

type Rep CreateExplainabilityExportResponse Source # 
Instance details

Defined in Amazonka.Forecast.CreateExplainabilityExport

type Rep CreateExplainabilityExportResponse = D1 ('MetaData "CreateExplainabilityExportResponse" "Amazonka.Forecast.CreateExplainabilityExport" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "CreateExplainabilityExportResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "explainabilityExportArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateExplainabilityExportResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateExplainabilityExportResponse'

-> CreateExplainabilityExportResponse 

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

CreateExplainabilityExportResponse, createExplainabilityExportResponse_explainabilityExportArn - The Amazon Resource Name (ARN) of the export.

$sel:httpStatus:CreateExplainabilityExportResponse', createExplainabilityExportResponse_httpStatus - The response's http status code.

Response Lenses

createExplainabilityExportResponse_explainabilityExportArn :: Lens' CreateExplainabilityExportResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the export.

createExplainabilityExportResponse_httpStatus :: Lens' CreateExplainabilityExportResponse Int Source #

The response's http status code.