Class: Aws::SageMaker::Types::DescribeFeatureGroupResponse
- Inherits:
-
Struct
- Object
- Struct
- Aws::SageMaker::Types::DescribeFeatureGroupResponse
- Defined in:
- gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#creation_time ⇒ Time
A timestamp indicating when SageMaker created the
FeatureGroup
. -
#description ⇒ String
A free form description of the feature group.
-
#event_time_feature_name ⇒ String
The name of the feature that stores the
EventTime
of a Record in aFeatureGroup
. -
#failure_reason ⇒ String
The reason that the
FeatureGroup
failed to be replicated in theOfflineStore
. -
#feature_definitions ⇒ Array<Types::FeatureDefinition>
A list of the
Features
in theFeatureGroup
. -
#feature_group_arn ⇒ String
The Amazon Resource Name (ARN) of the
FeatureGroup
. -
#feature_group_name ⇒ String
he name of the
FeatureGroup
. -
#feature_group_status ⇒ String
The status of the feature group.
-
#last_modified_time ⇒ Time
A timestamp indicating when the feature group was last updated.
-
#last_update_status ⇒ Types::LastUpdateStatus
A value indicating whether the update made to the feature group was successful.
-
#next_token ⇒ String
A token to resume pagination of the list of
Features
(FeatureDefinitions
). -
#offline_store_config ⇒ Types::OfflineStoreConfig
The configuration of the offline store.
-
#offline_store_status ⇒ Types::OfflineStoreStatus
The status of the
OfflineStore
. -
#online_store_config ⇒ Types::OnlineStoreConfig
The configuration for the
OnlineStore
. -
#online_store_total_size_bytes ⇒ Integer
The size of the
OnlineStore
in bytes. -
#record_identifier_feature_name ⇒ String
The name of the
Feature
used forRecordIdentifier
, whose value uniquely identifies a record stored in the feature store. -
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.
-
#throughput_config ⇒ Types::ThroughputConfigDescription
Active throughput configuration of the feature group.
Instance Attribute Details
#creation_time ⇒ Time
A timestamp indicating when SageMaker created the FeatureGroup
.
13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449 13450 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 13429 class DescribeFeatureGroupResponse < Struct.new( :feature_group_arn, :feature_group_name, :record_identifier_feature_name, :event_time_feature_name, :feature_definitions, :creation_time, :last_modified_time, :online_store_config, :offline_store_config, :throughput_config, :role_arn, :feature_group_status, :offline_store_status, :last_update_status, :failure_reason, :description, :next_token, :online_store_total_size_bytes) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
A free form description of the feature group.
13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449 13450 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 13429 class DescribeFeatureGroupResponse < Struct.new( :feature_group_arn, :feature_group_name, :record_identifier_feature_name, :event_time_feature_name, :feature_definitions, :creation_time, :last_modified_time, :online_store_config, :offline_store_config, :throughput_config, :role_arn, :feature_group_status, :offline_store_status, :last_update_status, :failure_reason, :description, :next_token, :online_store_total_size_bytes) SENSITIVE = [] include Aws::Structure end |
#event_time_feature_name ⇒ String
The name of the feature that stores the EventTime
of a Record in a
FeatureGroup
.
An EventTime
is a point in time when a new event occurs that
corresponds to the creation or update of a Record
in a
FeatureGroup
. All Records
in the FeatureGroup
have a
corresponding EventTime
.
13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449 13450 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 13429 class DescribeFeatureGroupResponse < Struct.new( :feature_group_arn, :feature_group_name, :record_identifier_feature_name, :event_time_feature_name, :feature_definitions, :creation_time, :last_modified_time, :online_store_config, :offline_store_config, :throughput_config, :role_arn, :feature_group_status, :offline_store_status, :last_update_status, :failure_reason, :description, :next_token, :online_store_total_size_bytes) SENSITIVE = [] include Aws::Structure end |
#failure_reason ⇒ String
The reason that the FeatureGroup
failed to be replicated in the
OfflineStore
. This is failure can occur because:
The
FeatureGroup
could not be created in theOfflineStore
.The
FeatureGroup
could not be deleted from theOfflineStore
.
13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449 13450 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 13429 class DescribeFeatureGroupResponse < Struct.new( :feature_group_arn, :feature_group_name, :record_identifier_feature_name, :event_time_feature_name, :feature_definitions, :creation_time, :last_modified_time, :online_store_config, :offline_store_config, :throughput_config, :role_arn, :feature_group_status, :offline_store_status, :last_update_status, :failure_reason, :description, :next_token, :online_store_total_size_bytes) SENSITIVE = [] include Aws::Structure end |
#feature_definitions ⇒ Array<Types::FeatureDefinition>
A list of the Features
in the FeatureGroup
. Each feature is
defined by a FeatureName
and FeatureType
.
13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449 13450 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 13429 class DescribeFeatureGroupResponse < Struct.new( :feature_group_arn, :feature_group_name, :record_identifier_feature_name, :event_time_feature_name, :feature_definitions, :creation_time, :last_modified_time, :online_store_config, :offline_store_config, :throughput_config, :role_arn, :feature_group_status, :offline_store_status, :last_update_status, :failure_reason, :description, :next_token, :online_store_total_size_bytes) SENSITIVE = [] include Aws::Structure end |
#feature_group_arn ⇒ String
The Amazon Resource Name (ARN) of the FeatureGroup
.
13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449 13450 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 13429 class DescribeFeatureGroupResponse < Struct.new( :feature_group_arn, :feature_group_name, :record_identifier_feature_name, :event_time_feature_name, :feature_definitions, :creation_time, :last_modified_time, :online_store_config, :offline_store_config, :throughput_config, :role_arn, :feature_group_status, :offline_store_status, :last_update_status, :failure_reason, :description, :next_token, :online_store_total_size_bytes) SENSITIVE = [] include Aws::Structure end |
#feature_group_name ⇒ String
he name of the FeatureGroup
.
13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449 13450 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 13429 class DescribeFeatureGroupResponse < Struct.new( :feature_group_arn, :feature_group_name, :record_identifier_feature_name, :event_time_feature_name, :feature_definitions, :creation_time, :last_modified_time, :online_store_config, :offline_store_config, :throughput_config, :role_arn, :feature_group_status, :offline_store_status, :last_update_status, :failure_reason, :description, :next_token, :online_store_total_size_bytes) SENSITIVE = [] include Aws::Structure end |
#feature_group_status ⇒ String
The status of the feature group.
13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449 13450 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 13429 class DescribeFeatureGroupResponse < Struct.new( :feature_group_arn, :feature_group_name, :record_identifier_feature_name, :event_time_feature_name, :feature_definitions, :creation_time, :last_modified_time, :online_store_config, :offline_store_config, :throughput_config, :role_arn, :feature_group_status, :offline_store_status, :last_update_status, :failure_reason, :description, :next_token, :online_store_total_size_bytes) SENSITIVE = [] include Aws::Structure end |
#last_modified_time ⇒ Time
A timestamp indicating when the feature group was last updated.
13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449 13450 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 13429 class DescribeFeatureGroupResponse < Struct.new( :feature_group_arn, :feature_group_name, :record_identifier_feature_name, :event_time_feature_name, :feature_definitions, :creation_time, :last_modified_time, :online_store_config, :offline_store_config, :throughput_config, :role_arn, :feature_group_status, :offline_store_status, :last_update_status, :failure_reason, :description, :next_token, :online_store_total_size_bytes) SENSITIVE = [] include Aws::Structure end |
#last_update_status ⇒ Types::LastUpdateStatus
A value indicating whether the update made to the feature group was successful.
13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449 13450 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 13429 class DescribeFeatureGroupResponse < Struct.new( :feature_group_arn, :feature_group_name, :record_identifier_feature_name, :event_time_feature_name, :feature_definitions, :creation_time, :last_modified_time, :online_store_config, :offline_store_config, :throughput_config, :role_arn, :feature_group_status, :offline_store_status, :last_update_status, :failure_reason, :description, :next_token, :online_store_total_size_bytes) SENSITIVE = [] include Aws::Structure end |
#next_token ⇒ String
A token to resume pagination of the list of Features
(FeatureDefinitions
).
13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449 13450 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 13429 class DescribeFeatureGroupResponse < Struct.new( :feature_group_arn, :feature_group_name, :record_identifier_feature_name, :event_time_feature_name, :feature_definitions, :creation_time, :last_modified_time, :online_store_config, :offline_store_config, :throughput_config, :role_arn, :feature_group_status, :offline_store_status, :last_update_status, :failure_reason, :description, :next_token, :online_store_total_size_bytes) SENSITIVE = [] include Aws::Structure end |
#offline_store_config ⇒ Types::OfflineStoreConfig
The configuration of the offline store. It includes the following configurations:
Amazon S3 location of the offline store.
Configuration of the Glue data catalog.
Table format of the offline store.
Option to disable the automatic creation of a Glue table for the offline store.
Encryption configuration.
13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449 13450 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 13429 class DescribeFeatureGroupResponse < Struct.new( :feature_group_arn, :feature_group_name, :record_identifier_feature_name, :event_time_feature_name, :feature_definitions, :creation_time, :last_modified_time, :online_store_config, :offline_store_config, :throughput_config, :role_arn, :feature_group_status, :offline_store_status, :last_update_status, :failure_reason, :description, :next_token, :online_store_total_size_bytes) SENSITIVE = [] include Aws::Structure end |
#offline_store_status ⇒ Types::OfflineStoreStatus
The status of the OfflineStore
. Notifies you if replicating data
into the OfflineStore
has failed. Returns either: Active
or
Blocked
13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449 13450 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 13429 class DescribeFeatureGroupResponse < Struct.new( :feature_group_arn, :feature_group_name, :record_identifier_feature_name, :event_time_feature_name, :feature_definitions, :creation_time, :last_modified_time, :online_store_config, :offline_store_config, :throughput_config, :role_arn, :feature_group_status, :offline_store_status, :last_update_status, :failure_reason, :description, :next_token, :online_store_total_size_bytes) SENSITIVE = [] include Aws::Structure end |
#online_store_config ⇒ Types::OnlineStoreConfig
The configuration for the OnlineStore
.
13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449 13450 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 13429 class DescribeFeatureGroupResponse < Struct.new( :feature_group_arn, :feature_group_name, :record_identifier_feature_name, :event_time_feature_name, :feature_definitions, :creation_time, :last_modified_time, :online_store_config, :offline_store_config, :throughput_config, :role_arn, :feature_group_status, :offline_store_status, :last_update_status, :failure_reason, :description, :next_token, :online_store_total_size_bytes) SENSITIVE = [] include Aws::Structure end |
#online_store_total_size_bytes ⇒ Integer
The size of the OnlineStore
in bytes.
13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449 13450 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 13429 class DescribeFeatureGroupResponse < Struct.new( :feature_group_arn, :feature_group_name, :record_identifier_feature_name, :event_time_feature_name, :feature_definitions, :creation_time, :last_modified_time, :online_store_config, :offline_store_config, :throughput_config, :role_arn, :feature_group_status, :offline_store_status, :last_update_status, :failure_reason, :description, :next_token, :online_store_total_size_bytes) SENSITIVE = [] include Aws::Structure end |
#record_identifier_feature_name ⇒ String
The name of the Feature
used for RecordIdentifier
, whose value
uniquely identifies a record stored in the feature store.
13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449 13450 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 13429 class DescribeFeatureGroupResponse < Struct.new( :feature_group_arn, :feature_group_name, :record_identifier_feature_name, :event_time_feature_name, :feature_definitions, :creation_time, :last_modified_time, :online_store_config, :offline_store_config, :throughput_config, :role_arn, :feature_group_status, :offline_store_status, :last_update_status, :failure_reason, :description, :next_token, :online_store_total_size_bytes) SENSITIVE = [] include Aws::Structure end |
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.
13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449 13450 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 13429 class DescribeFeatureGroupResponse < Struct.new( :feature_group_arn, :feature_group_name, :record_identifier_feature_name, :event_time_feature_name, :feature_definitions, :creation_time, :last_modified_time, :online_store_config, :offline_store_config, :throughput_config, :role_arn, :feature_group_status, :offline_store_status, :last_update_status, :failure_reason, :description, :next_token, :online_store_total_size_bytes) SENSITIVE = [] include Aws::Structure end |
#throughput_config ⇒ Types::ThroughputConfigDescription
Active throughput configuration of the feature group. There are two
modes: ON_DEMAND
and PROVISIONED
. With on-demand mode, you are
charged for data reads and writes that your application performs on
your feature group. You do not need to specify read and write
throughput because Feature Store accommodates your workloads as they
ramp up and down. You can switch a feature group to on-demand only
once in a 24 hour period. With provisioned throughput mode, you
specify the read and write capacity per second that you expect your
application to require, and you are billed based on those limits.
Exceeding provisioned throughput will result in your requests being
throttled.
Note: PROVISIONED
throughput mode is supported only for feature
groups that are offline-only, or use the Standard
tier
online store.
13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449 13450 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 13429 class DescribeFeatureGroupResponse < Struct.new( :feature_group_arn, :feature_group_name, :record_identifier_feature_name, :event_time_feature_name, :feature_definitions, :creation_time, :last_modified_time, :online_store_config, :offline_store_config, :throughput_config, :role_arn, :feature_group_status, :offline_store_status, :last_update_status, :failure_reason, :description, :next_token, :online_store_total_size_bytes) SENSITIVE = [] include Aws::Structure end |