Class: Aws::ForecastService::Types::CreateExplainabilityRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_source ⇒ Types::DataSource

The source of your data, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the data and, optionally, an Key Management Service (KMS) key.

Returns:



1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
 
# File 'lib/aws-sdk-forecastservice/types.rb', line 1138

class CreateExplainabilityRequest < Struct.new(
  :explainability_name,
  :resource_arn,
  :explainability_config,
  :data_source,
  :schema,
  :enable_visualization,
  :start_date_time,
  :end_date_time,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#enable_visualization ⇒ Boolean

Create an Explainability visualization that is viewable within the Amazon Web Services console.

Returns:

  • (Boolean) 


1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
 
# File 'lib/aws-sdk-forecastservice/types.rb', line 1138

class CreateExplainabilityRequest < Struct.new(
  :explainability_name,
  :resource_arn,
  :explainability_config,
  :data_source,
  :schema,
  :enable_visualization,
  :start_date_time,
  :end_date_time,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#end_date_time ⇒ String

If ‘TimePointGranularity` is set to `SPECIFIC`, define the last time point for the Explainability.

Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)

Returns:

  • (String) 


1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
 
# File 'lib/aws-sdk-forecastservice/types.rb', line 1138

class CreateExplainabilityRequest < Struct.new(
  :explainability_name,
  :resource_arn,
  :explainability_config,
  :data_source,
  :schema,
  :enable_visualization,
  :start_date_time,
  :end_date_time,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#explainability_config ⇒ Types::ExplainabilityConfig

The configuration settings that define the granularity of time series and time points for the Explainability.

Returns:



1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
 
# File 'lib/aws-sdk-forecastservice/types.rb', line 1138

class CreateExplainabilityRequest < Struct.new(
  :explainability_name,
  :resource_arn,
  :explainability_config,
  :data_source,
  :schema,
  :enable_visualization,
  :start_date_time,
  :end_date_time,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#explainability_name ⇒ String

A unique name for the Explainability.

Returns:

  • (String) 


1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
 
# File 'lib/aws-sdk-forecastservice/types.rb', line 1138

class CreateExplainabilityRequest < Struct.new(
  :explainability_name,
  :resource_arn,
  :explainability_config,
  :data_source,
  :schema,
  :enable_visualization,
  :start_date_time,
  :end_date_time,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arn ⇒ String

The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.

Returns:

  • (String) 


1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
 
# File 'lib/aws-sdk-forecastservice/types.rb', line 1138

class CreateExplainabilityRequest < Struct.new(
  :explainability_name,
  :resource_arn,
  :explainability_config,
  :data_source,
  :schema,
  :enable_visualization,
  :start_date_time,
  :end_date_time,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#schema ⇒ Types::Schema

Defines the fields of a dataset.

Returns:



1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
 
# File 'lib/aws-sdk-forecastservice/types.rb', line 1138

class CreateExplainabilityRequest < Struct.new(
  :explainability_name,
  :resource_arn,
  :explainability_config,
  :data_source,
  :schema,
  :enable_visualization,
  :start_date_time,
  :end_date_time,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#start_date_time ⇒ String

If ‘TimePointGranularity` is set to `SPECIFIC`, define the first point for the Explainability.

Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)

Returns:

  • (String) 


1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
 
# File 'lib/aws-sdk-forecastservice/types.rb', line 1138

class CreateExplainabilityRequest < Struct.new(
  :explainability_name,
  :resource_arn,
  :explainability_config,
  :data_source,
  :schema,
  :enable_visualization,
  :start_date_time,
  :end_date_time,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<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:



1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
 
# File 'lib/aws-sdk-forecastservice/types.rb', line 1138

class CreateExplainabilityRequest < Struct.new(
  :explainability_name,
  :resource_arn,
  :explainability_config,
  :data_source,
  :schema,
  :enable_visualization,
  :start_date_time,
  :end_date_time,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end