Struct aws_sdk_sagemaker::operation::create_feature_group::builders::CreateFeatureGroupFluentBuilder

pub struct CreateFeatureGroupFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateFeatureGroup.

Create a new FeatureGroup. A FeatureGroup is a group of Features defined in the FeatureStore to describe a Record.

The FeatureGroup defines the schema and features contained in the FeatureGroup. A FeatureGroup definition is composed of a list of Features, a RecordIdentifierFeatureName, an EventTimeFeatureName and configurations for its OnlineStore and OfflineStore. Check Amazon Web Services service quotas to see the FeatureGroups quota for your Amazon Web Services account.

Note that it can take approximately 10-15 minutes to provision an OnlineStore FeatureGroup with the InMemory StorageType.

You must include at least one of OnlineStoreConfig and OfflineStoreConfig to create a FeatureGroup.

Implementations

impl CreateFeatureGroupFluentBuilder

pub fn as_input(&self) -> &CreateFeatureGroupInputBuilder

Access the CreateFeatureGroup as a reference.

pub async fn send( self ) -> Result<CreateFeatureGroupOutput, SdkError<CreateFeatureGroupError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<CreateFeatureGroupOutput, CreateFeatureGroupError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn feature_group_name(self, input: impl Into<String>) -> Self

The name of the FeatureGroup. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

The name:

• Must start with an alphanumeric character.

• Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.

pub fn set_feature_group_name(self, input: Option<String>) -> Self

The name of the FeatureGroup. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

The name:

• Must start with an alphanumeric character.

• Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.

pub fn get_feature_group_name(&self) -> &Option<String>

The name of the FeatureGroup. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

The name:

• Must start with an alphanumeric character.

• Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.

pub fn record_identifier_feature_name(self, input: impl Into<String>) -> Self

The name of the Feature whose value uniquely identifies a Record defined in the FeatureStore. Only the latest record per identifier value will be stored in the OnlineStore. RecordIdentifierFeatureName must be one of feature definitions' names.

You use the RecordIdentifierFeatureName to access data in a FeatureStore.

This name:

• Must start with an alphanumeric character.

• Can only contains alphanumeric characters, hyphens, underscores. Spaces are not allowed.

pub fn set_record_identifier_feature_name(self, input: Option<String>) -> Self

The name of the Feature whose value uniquely identifies a Record defined in the FeatureStore. Only the latest record per identifier value will be stored in the OnlineStore. RecordIdentifierFeatureName must be one of feature definitions' names.

You use the RecordIdentifierFeatureName to access data in a FeatureStore.

This name:

• Must start with an alphanumeric character.

• Can only contains alphanumeric characters, hyphens, underscores. Spaces are not allowed.

pub fn get_record_identifier_feature_name(&self) -> &Option<String>

The name of the Feature whose value uniquely identifies a Record defined in the FeatureStore. Only the latest record per identifier value will be stored in the OnlineStore. RecordIdentifierFeatureName must be one of feature definitions' names.

You use the RecordIdentifierFeatureName to access data in a FeatureStore.

This name:

• Must start with an alphanumeric character.

• Can only contains alphanumeric characters, hyphens, underscores. Spaces are not allowed.

pub fn event_time_feature_name(self, input: impl Into<String>) -> Self

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 must have a corresponding EventTime.

An EventTime can be a String or Fractional.

• Fractional: EventTime feature values must be a Unix timestamp in seconds.

• String: EventTime feature values must be an ISO-8601 string in the format. The following formats are supported yyyy-MM-dd'T'HH:mm:ssZ and yyyy-MM-dd'T'HH:mm:ss.SSSZ where yyyy, MM, and dd represent the year, month, and day respectively and HH, mm, ss, and if applicable, SSS represent the hour, month, second and milliseconds respsectively. 'T' and Z are constants.

pub fn set_event_time_feature_name(self, input: Option<String>) -> Self

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 must have a corresponding EventTime.

An EventTime can be a String or Fractional.

• Fractional: EventTime feature values must be a Unix timestamp in seconds.

• String: EventTime feature values must be an ISO-8601 string in the format. The following formats are supported yyyy-MM-dd'T'HH:mm:ssZ and yyyy-MM-dd'T'HH:mm:ss.SSSZ where yyyy, MM, and dd represent the year, month, and day respectively and HH, mm, ss, and if applicable, SSS represent the hour, month, second and milliseconds respsectively. 'T' and Z are constants.

pub fn get_event_time_feature_name(&self) -> &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 must have a corresponding EventTime.

An EventTime can be a String or Fractional.

• Fractional: EventTime feature values must be a Unix timestamp in seconds.

• String: EventTime feature values must be an ISO-8601 string in the format. The following formats are supported yyyy-MM-dd'T'HH:mm:ssZ and yyyy-MM-dd'T'HH:mm:ss.SSSZ where yyyy, MM, and dd represent the year, month, and day respectively and HH, mm, ss, and if applicable, SSS represent the hour, month, second and milliseconds respsectively. 'T' and Z are constants.

pub fn feature_definitions(self, input: FeatureDefinition) -> Self

Appends an item to FeatureDefinitions.

To override the contents of this collection use set_feature_definitions.

A list of Feature names and types. Name and Type is compulsory per Feature.

Valid feature FeatureTypes are Integral, Fractional and String.

FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time

You can create up to 2,500 FeatureDefinitions per FeatureGroup.

pub fn set_feature_definitions( self, input: Option<Vec<FeatureDefinition>> ) -> Self

A list of Feature names and types. Name and Type is compulsory per Feature.

Valid feature FeatureTypes are Integral, Fractional and String.

FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time

You can create up to 2,500 FeatureDefinitions per FeatureGroup.

pub fn get_feature_definitions(&self) -> &Option<Vec<FeatureDefinition>>

A list of Feature names and types. Name and Type is compulsory per Feature.

Valid feature FeatureTypes are Integral, Fractional and String.

FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time

You can create up to 2,500 FeatureDefinitions per FeatureGroup.

pub fn online_store_config(self, input: OnlineStoreConfig) -> Self

You can turn the OnlineStore on or off by specifying True for the EnableOnlineStore flag in OnlineStoreConfig.

You can also include an Amazon Web Services KMS key ID (KMSKeyId) for at-rest encryption of the OnlineStore.

The default value is False.

pub fn set_online_store_config(self, input: Option<OnlineStoreConfig>) -> Self

You can turn the OnlineStore on or off by specifying True for the EnableOnlineStore flag in OnlineStoreConfig.

You can also include an Amazon Web Services KMS key ID (KMSKeyId) for at-rest encryption of the OnlineStore.

The default value is False.

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

You can turn the OnlineStore on or off by specifying True for the EnableOnlineStore flag in OnlineStoreConfig.

You can also include an Amazon Web Services KMS key ID (KMSKeyId) for at-rest encryption of the OnlineStore.

The default value is False.

pub fn offline_store_config(self, input: OfflineStoreConfig) -> Self

Use this to configure an OfflineFeatureStore. This parameter allows you to specify:

• The Amazon Simple Storage Service (Amazon S3) location of an OfflineStore.

• A configuration for an Amazon Web Services Glue or Amazon Web Services Hive data catalog.

• An KMS encryption key to encrypt the Amazon S3 location used for OfflineStore. If KMS encryption key is not specified, by default we encrypt all data at rest using Amazon Web Services KMS key. By defining your bucket-level key for SSE, you can reduce Amazon Web Services KMS requests costs by up to 99 percent.

• Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.

To learn more about this parameter, see OfflineStoreConfig.

pub fn set_offline_store_config(self, input: Option<OfflineStoreConfig>) -> Self

Use this to configure an OfflineFeatureStore. This parameter allows you to specify:

• The Amazon Simple Storage Service (Amazon S3) location of an OfflineStore.

• A configuration for an Amazon Web Services Glue or Amazon Web Services Hive data catalog.

• An KMS encryption key to encrypt the Amazon S3 location used for OfflineStore. If KMS encryption key is not specified, by default we encrypt all data at rest using Amazon Web Services KMS key. By defining your bucket-level key for SSE, you can reduce Amazon Web Services KMS requests costs by up to 99 percent.

• Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.

To learn more about this parameter, see OfflineStoreConfig.

pub fn get_offline_store_config(&self) -> &Option<OfflineStoreConfig>

Use this to configure an OfflineFeatureStore. This parameter allows you to specify:

• The Amazon Simple Storage Service (Amazon S3) location of an OfflineStore.

• A configuration for an Amazon Web Services Glue or Amazon Web Services Hive data catalog.

• An KMS encryption key to encrypt the Amazon S3 location used for OfflineStore. If KMS encryption key is not specified, by default we encrypt all data at rest using Amazon Web Services KMS key. By defining your bucket-level key for SSE, you can reduce Amazon Web Services KMS requests costs by up to 99 percent.

• Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.

To learn more about this parameter, see OfflineStoreConfig.

pub fn throughput_config(self, input: ThroughputConfig) -> Self

Used to set feature group throughput configuration. 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 set_throughput_config(self, input: Option<ThroughputConfig>) -> Self

Used to set feature group throughput configuration. 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 get_throughput_config(&self) -> &Option<ThroughputConfig>

Used to set feature group throughput configuration. 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, input: impl Into<String>) -> Self

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

pub fn set_role_arn(self, input: Option<String>) -> Self

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

pub fn get_role_arn(&self) -> &Option<String>

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

pub fn description(self, input: impl Into<String>) -> Self

A free-form description of a FeatureGroup.

pub fn set_description(self, input: Option<String>) -> Self

A free-form description of a FeatureGroup.

pub fn get_description(&self) -> &Option<String>

A free-form description of a FeatureGroup.

pub fn tags(self, input: Tag) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

Tags used to identify Features in each FeatureGroup.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

Tags used to identify Features in each FeatureGroup.

pub fn get_tags(&self) -> &Option<Vec<Tag>>

Tags used to identify Features in each FeatureGroup.

Trait Implementations

impl Clone for CreateFeatureGroupFluentBuilder

fn clone(&self) -> CreateFeatureGroupFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateFeatureGroupFluentBuilder

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

Formats the value using the given formatter.