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

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 CreateExplainabilityRequest data as a hash:

{
  explainability_name: "Name", # required
  resource_arn: "Arn", # required
  explainability_config: { # required
    time_series_granularity: "ALL", # required, accepts ALL, SPECIFIC
    time_point_granularity: "ALL", # required, accepts ALL, SPECIFIC
  },
  data_source: {
    s3_config: { # required
      path: "S3Path", # required
      role_arn: "Arn", # required
      kms_key_arn: "KMSKeyArn",
    },
  },
  schema: {
    attributes: [
      {
        attribute_name: "Name",
        attribute_type: "string", # accepts string, integer, float, timestamp, geolocation
      },
    ],
  },
  enable_visualization: false,
  start_date_time: "LocalDateTime",
  end_date_time: "LocalDateTime",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_sourceTypes::DataSource

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

Returns:



1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1254

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_visualizationBoolean

Create an Explainability visualization that is viewable within the AWS console.

Returns:

  • (Boolean)


1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1254

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_timeString

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)


1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1254

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_configTypes::ExplainabilityConfig

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



1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1254

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_nameString

A unique name for the Explainability.

Returns:

  • (String)


1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1254

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_arnString

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

Returns:

  • (String)


1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1254

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

#schemaTypes::Schema

Defines the fields of a dataset.

Returns:



1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1254

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_timeString

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)


1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1254

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

#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:



1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1254

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