createExplainabilityExport method

Future<CreateExplainabilityExportResponse> createExplainabilityExport({ required DataDestination destination, required String explainabilityArn, required String explainabilityExportName, String? format, List<Tag>? tags, })

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.

May throw InvalidInputException. May throw LimitExceededException. May throw ResourceAlreadyExistsException. May throw ResourceInUseException. May throw ResourceNotFoundException.

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

Parameter explainabilityExportName : A unique name for the Explainability export.

Parameter format : The format of the exported data, CSV or PARQUET.

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

Implementation

Future<CreateExplainabilityExportResponse> createExplainabilityExport({
  required DataDestination destination,
  required String explainabilityArn,
  required String explainabilityExportName,
  String? format,
  List<Tag>? tags,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AmazonForecast.CreateExplainabilityExport'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'Destination': destination,
      'ExplainabilityArn': explainabilityArn,
      'ExplainabilityExportName': explainabilityExportName,
      if (format != null) 'Format': format,
      if (tags != null) 'Tags': tags,
    },
  );

  return CreateExplainabilityExportResponse.fromJson(jsonResponse.body);
}