Struct aws_sdk_sagemaker::operation::describe_feature_group::DescribeFeatureGroupOutput

#[non_exhaustive]
pub struct DescribeFeatureGroupOutput {

    pub feature_group_arn: Option<String>,
    pub feature_group_name: Option<String>,
    pub record_identifier_feature_name: Option<String>,
    pub event_time_feature_name: Option<String>,
    pub feature_definitions: Option<Vec<FeatureDefinition>>,
    pub creation_time: Option<DateTime>,
    pub last_modified_time: Option<DateTime>,
    pub online_store_config: Option<OnlineStoreConfig>,
    pub offline_store_config: Option<OfflineStoreConfig>,
    pub throughput_config: Option<ThroughputConfigDescription>,
    pub role_arn: Option<String>,
    pub feature_group_status: Option<FeatureGroupStatus>,
    pub offline_store_status: Option<OfflineStoreStatus>,
    pub last_update_status: Option<LastUpdateStatus>,
    pub failure_reason: Option<String>,
    pub description: Option<String>,
    pub next_token: Option<String>,
    pub online_store_total_size_bytes: Option<i64>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

feature_group_arn: Option<String>

The Amazon Resource Name (ARN) of the FeatureGroup.

feature_group_name: Option<String>

he name of the FeatureGroup.

record_identifier_feature_name: Option<String>

The name of the Feature used for RecordIdentifier, whose value uniquely identifies a record stored in the feature store.

event_time_feature_name: Option<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.

feature_definitions: Option<Vec<FeatureDefinition>>

A list of the Features in the FeatureGroup. Each feature is defined by a FeatureName and FeatureType.

creation_time: Option<DateTime>

A timestamp indicating when SageMaker created the FeatureGroup.

last_modified_time: Option<DateTime>

A timestamp indicating when the feature group was last updated.

online_store_config: Option<OnlineStoreConfig>

The configuration for the OnlineStore.

offline_store_config: Option<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.

throughput_config: Option<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.

role_arn: Option<String>

The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.

feature_group_status: Option<FeatureGroupStatus>

The status of the feature group.

offline_store_status: Option<OfflineStoreStatus>

The status of the OfflineStore. Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked

last_update_status: Option<LastUpdateStatus>

A value indicating whether the update made to the feature group was successful.

failure_reason: Option<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 the OfflineStore.

• The FeatureGroup could not be deleted from the OfflineStore.

description: Option<String>

A free form description of the feature group.

next_token: Option<String>

A token to resume pagination of the list of Features (FeatureDefinitions).

online_store_total_size_bytes: Option<i64>

The size of the OnlineStore in bytes.

Implementations

impl DescribeFeatureGroupOutput

pub fn feature_group_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the FeatureGroup.

pub fn feature_group_name(&self) -> Option<&str>

he name of the FeatureGroup.

pub fn record_identifier_feature_name(&self) -> Option<&str>

The name of the Feature used for RecordIdentifier, whose value uniquely identifies a record stored in the feature store.

pub fn event_time_feature_name(&self) -> Option<&str>

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.

pub fn feature_definitions(&self) -> &[FeatureDefinition]

A list of the Features in the FeatureGroup. Each feature is defined by a FeatureName and FeatureType.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .feature_definitions.is_none().

pub fn creation_time(&self) -> Option<&DateTime>

A timestamp indicating when SageMaker created the FeatureGroup.

pub fn last_modified_time(&self) -> Option<&DateTime>

A timestamp indicating when the feature group was last updated.

pub fn online_store_config(&self) -> Option<&OnlineStoreConfig>

The configuration for the OnlineStore.

pub fn offline_store_config(&self) -> Option<&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.

pub fn throughput_config(&self) -> Option<&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.

pub fn role_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.

pub fn feature_group_status(&self) -> Option<&FeatureGroupStatus>

The status of the feature group.

pub fn offline_store_status(&self) -> Option<&OfflineStoreStatus>

The status of the OfflineStore. Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked

pub fn last_update_status(&self) -> Option<&LastUpdateStatus>

A value indicating whether the update made to the feature group was successful.

pub fn failure_reason(&self) -> Option<&str>

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 the OfflineStore.

• The FeatureGroup could not be deleted from the OfflineStore.

pub fn description(&self) -> Option<&str>

A free form description of the feature group.

pub fn next_token(&self) -> Option<&str>

A token to resume pagination of the list of Features (FeatureDefinitions).

pub fn online_store_total_size_bytes(&self) -> Option<i64>

The size of the OnlineStore in bytes.

impl DescribeFeatureGroupOutput

pub fn builder() -> DescribeFeatureGroupOutputBuilder

Creates a new builder-style object to manufacture DescribeFeatureGroupOutput.

Trait Implementations

impl Clone for DescribeFeatureGroupOutput

fn clone(&self) -> DescribeFeatureGroupOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeFeatureGroupOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DescribeFeatureGroupOutput

fn eq(&self, other: &DescribeFeatureGroupOutput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for DescribeFeatureGroupOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for DescribeFeatureGroupOutput