aws_sdk_sagemaker/client/

describe_feature_group.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeFeatureGroup`](crate::operation::describe_feature_group::builders::DescribeFeatureGroupFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`feature_group_name(impl Into<String>)`](crate::operation::describe_feature_group::builders::DescribeFeatureGroupFluentBuilder::feature_group_name) / [`set_feature_group_name(Option<String>)`](crate::operation::describe_feature_group::builders::DescribeFeatureGroupFluentBuilder::set_feature_group_name):<br>required: **true**<br><p>The name or Amazon Resource Name (ARN) of the <code>FeatureGroup</code> you want described.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_feature_group::builders::DescribeFeatureGroupFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_feature_group::builders::DescribeFeatureGroupFluentBuilder::set_next_token):<br>required: **false**<br><p>A token to resume pagination of the list of <code>Features</code> (<code>FeatureDefinitions</code>). 2,500 <code>Features</code> are returned by default.</p><br>
    /// - On success, responds with [`DescribeFeatureGroupOutput`](crate::operation::describe_feature_group::DescribeFeatureGroupOutput) with field(s):
    ///   - [`feature_group_arn(Option<String>)`](crate::operation::describe_feature_group::DescribeFeatureGroupOutput::feature_group_arn): <p>The Amazon Resource Name (ARN) of the <code>FeatureGroup</code>.</p>
    ///   - [`feature_group_name(Option<String>)`](crate::operation::describe_feature_group::DescribeFeatureGroupOutput::feature_group_name): <p>he name of the <code>FeatureGroup</code>.</p>
    ///   - [`record_identifier_feature_name(Option<String>)`](crate::operation::describe_feature_group::DescribeFeatureGroupOutput::record_identifier_feature_name): <p>The name of the <code>Feature</code> used for <code>RecordIdentifier</code>, whose value uniquely identifies a record stored in the feature store.</p>
    ///   - [`event_time_feature_name(Option<String>)`](crate::operation::describe_feature_group::DescribeFeatureGroupOutput::event_time_feature_name): <p>The name of the feature that stores the <code>EventTime</code> of a Record in a <code>FeatureGroup</code>.</p> <p>An <code>EventTime</code> is a point in time when a new event occurs that corresponds to the creation or update of a <code>Record</code> in a <code>FeatureGroup</code>. All <code>Records</code> in the <code>FeatureGroup</code> have a corresponding <code>EventTime</code>.</p>
    ///   - [`feature_definitions(Option<Vec::<FeatureDefinition>>)`](crate::operation::describe_feature_group::DescribeFeatureGroupOutput::feature_definitions): <p>A list of the <code>Features</code> in the <code>FeatureGroup</code>. Each feature is defined by a <code>FeatureName</code> and <code>FeatureType</code>.</p>
    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_feature_group::DescribeFeatureGroupOutput::creation_time): <p>A timestamp indicating when SageMaker created the <code>FeatureGroup</code>.</p>
    ///   - [`last_modified_time(Option<DateTime>)`](crate::operation::describe_feature_group::DescribeFeatureGroupOutput::last_modified_time): <p>A timestamp indicating when the feature group was last updated.</p>
    ///   - [`online_store_config(Option<OnlineStoreConfig>)`](crate::operation::describe_feature_group::DescribeFeatureGroupOutput::online_store_config): <p>The configuration for the <code>OnlineStore</code>.</p>
    ///   - [`offline_store_config(Option<OfflineStoreConfig>)`](crate::operation::describe_feature_group::DescribeFeatureGroupOutput::offline_store_config): <p>The configuration of the offline store. It includes the following configurations:</p> <ul>  <li>   <p>Amazon S3 location of the offline store.</p></li>  <li>   <p>Configuration of the Glue data catalog.</p></li>  <li>   <p>Table format of the offline store.</p></li>  <li>   <p>Option to disable the automatic creation of a Glue table for the offline store.</p></li>  <li>   <p>Encryption configuration.</p></li> </ul>
    ///   - [`throughput_config(Option<ThroughputConfigDescription>)`](crate::operation::describe_feature_group::DescribeFeatureGroupOutput::throughput_config): <p>Active throughput configuration of the feature group. There are two modes: <code>ON_DEMAND</code> and <code>PROVISIONED</code>. 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.</p> <p>Note: <code>PROVISIONED</code> throughput mode is supported only for feature groups that are offline-only, or use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OnlineStoreConfig.html#sagemaker-Type-OnlineStoreConfig-StorageType"> <code>Standard</code> </a> tier online store.</p>
    ///   - [`role_arn(Option<String>)`](crate::operation::describe_feature_group::DescribeFeatureGroupOutput::role_arn): <p>The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.</p>
    ///   - [`feature_group_status(Option<FeatureGroupStatus>)`](crate::operation::describe_feature_group::DescribeFeatureGroupOutput::feature_group_status): <p>The status of the feature group.</p>
    ///   - [`offline_store_status(Option<OfflineStoreStatus>)`](crate::operation::describe_feature_group::DescribeFeatureGroupOutput::offline_store_status): <p>The status of the <code>OfflineStore</code>. Notifies you if replicating data into the <code>OfflineStore</code> has failed. Returns either: <code>Active</code> or <code>Blocked</code></p>
    ///   - [`last_update_status(Option<LastUpdateStatus>)`](crate::operation::describe_feature_group::DescribeFeatureGroupOutput::last_update_status): <p>A value indicating whether the update made to the feature group was successful.</p>
    ///   - [`failure_reason(Option<String>)`](crate::operation::describe_feature_group::DescribeFeatureGroupOutput::failure_reason): <p>The reason that the <code>FeatureGroup</code> failed to be replicated in the <code>OfflineStore</code>. This is failure can occur because:</p> <ul>  <li>   <p>The <code>FeatureGroup</code> could not be created in the <code>OfflineStore</code>.</p></li>  <li>   <p>The <code>FeatureGroup</code> could not be deleted from the <code>OfflineStore</code>.</p></li> </ul>
    ///   - [`description(Option<String>)`](crate::operation::describe_feature_group::DescribeFeatureGroupOutput::description): <p>A free form description of the feature group.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::describe_feature_group::DescribeFeatureGroupOutput::next_token): <p>A token to resume pagination of the list of <code>Features</code> (<code>FeatureDefinitions</code>).</p>
    ///   - [`online_store_total_size_bytes(Option<i64>)`](crate::operation::describe_feature_group::DescribeFeatureGroupOutput::online_store_total_size_bytes): <p>The size of the <code>OnlineStore</code> in bytes.</p>
    /// - On failure, responds with [`SdkError<DescribeFeatureGroupError>`](crate::operation::describe_feature_group::DescribeFeatureGroupError)
    pub fn describe_feature_group(&self) -> crate::operation::describe_feature_group::builders::DescribeFeatureGroupFluentBuilder {
        crate::operation::describe_feature_group::builders::DescribeFeatureGroupFluentBuilder::new(self.handle.clone())
    }
}