Class: Aws::ForecastService::Types::CreateExplainabilityExportRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb

Overview

Note:

When making an API call, you may pass CreateExplainabilityExportRequest data as a hash:

{
  explainability_export_name: "Name", # required
  explainability_arn: "Arn", # required
  destination: { # required
    s3_config: { # required
      path: "S3Path", # required
      role_arn: "Arn", # required
      kms_key_arn: "KMSKeyArn",
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#destinationTypes::DataDestination

The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an AWS Key Management Service (KMS) key (optional).



1099
1100
1101
1102
1103
1104
1105
1106
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1099

class CreateExplainabilityExportRequest < Struct.new(
  :explainability_export_name,
  :explainability_arn,
  :destination,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#explainability_arnString

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

Returns:

  • (String)


1099
1100
1101
1102
1103
1104
1105
1106
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1099

class CreateExplainabilityExportRequest < Struct.new(
  :explainability_export_name,
  :explainability_arn,
  :destination,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#explainability_export_nameString

A unique name for the Explainability export.

Returns:

  • (String)


1099
1100
1101
1102
1103
1104
1105
1106
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1099

class CreateExplainabilityExportRequest < Struct.new(
  :explainability_export_name,
  :explainability_arn,
  :destination,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::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.

Returns:



1099
1100
1101
1102
1103
1104
1105
1106
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1099

class CreateExplainabilityExportRequest < Struct.new(
  :explainability_export_name,
  :explainability_arn,
  :destination,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end