CREATEEXPLAINABILITYEXPORT()`¶

About CreateExplainabilityExport¶

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

Method Signature¶

METHODS /AWS1/IF_FCS~CREATEEXPLAINABILITYEXPORT
  IMPORTING
    !IV_EXPLAINABILITYEXPORTNAME TYPE /AWS1/FCSNAME OPTIONAL
    !IV_EXPLAINABILITYARN TYPE /AWS1/FCSARN OPTIONAL
    !IO_DESTINATION TYPE REF TO /AWS1/CL_FCSDATADESTINATION OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_FCSTAG=>TT_TAGS OPTIONAL
    !IV_FORMAT TYPE /AWS1/FCSFORMAT OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_fcscreexplainabilit03
  RAISING
    /AWS1/CX_FCSINVALIDINPUTEX
    /AWS1/CX_FCSLIMITEXCEEDEDEX
    /AWS1/CX_FCSRESRCALRDYEXISTSEX
    /AWS1/CX_FCSRESOURCEINUSEEX
    /AWS1/CX_FCSRESOURCENOTFOUNDEX
    /AWS1/CX_FCSCLIENTEXC
    /AWS1/CX_FCSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_explainabilityexportname` `TYPE /AWS1/FCSNAME` `/AWS1/FCSNAME`¶

A unique name for the Explainability export.

`iv_explainabilityarn` `TYPE /AWS1/FCSARN` `/AWS1/FCSARN`¶

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

`io_destination` `TYPE REF TO /AWS1/CL_FCSDATADESTINATION` `/AWS1/CL_FCSDATADESTINATION`¶

Destination

Optional arguments:¶

`it_tags` `TYPE /AWS1/CL_FCSTAG=>TT_TAGS` `TT_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.

`iv_format` `TYPE /AWS1/FCSFORMAT` `/AWS1/FCSFORMAT`¶

The format of the exported data, CSV or PARQUET.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_fcscreexplainabilit03` `/AWS1/CL_FCSCREEXPLAINABILIT03`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->createexplainabilityexport(
  io_destination = new /aws1/cl_fcsdatadestination(
    io_s3config = new /aws1/cl_fcss3config(
      iv_kmskeyarn = |string|
      iv_path = |string|
      iv_rolearn = |string|
    )
  )
  it_tags = VALUE /aws1/cl_fcstag=>tt_tags(
    (
      new /aws1/cl_fcstag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_explainabilityarn = |string|
  iv_explainabilityexportname = |string|
  iv_format = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_arn = lo_result->get_explainabilityexportarn( ).
ENDIF.

/AWS1/IF_FCS=>CREATEEXPLAINABILITYEXPORT()¶