We recommend new projects start with resources from the AWS provider.
aws-native.sagemaker.getFeatureGroup
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Resource Type definition for AWS::SageMaker::FeatureGroup
Using getFeatureGroup
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getFeatureGroup(args: GetFeatureGroupArgs, opts?: InvokeOptions): Promise<GetFeatureGroupResult>
function getFeatureGroupOutput(args: GetFeatureGroupOutputArgs, opts?: InvokeOptions): Output<GetFeatureGroupResult>
def get_feature_group(feature_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetFeatureGroupResult
def get_feature_group_output(feature_group_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetFeatureGroupResult]
func LookupFeatureGroup(ctx *Context, args *LookupFeatureGroupArgs, opts ...InvokeOption) (*LookupFeatureGroupResult, error)
func LookupFeatureGroupOutput(ctx *Context, args *LookupFeatureGroupOutputArgs, opts ...InvokeOption) LookupFeatureGroupResultOutput
> Note: This function is named LookupFeatureGroup
in the Go SDK.
public static class GetFeatureGroup
{
public static Task<GetFeatureGroupResult> InvokeAsync(GetFeatureGroupArgs args, InvokeOptions? opts = null)
public static Output<GetFeatureGroupResult> Invoke(GetFeatureGroupInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetFeatureGroupResult> getFeatureGroup(GetFeatureGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:sagemaker:getFeatureGroup
arguments:
# arguments dictionary
The following arguments are supported:
- Feature
Group stringName - The Name of the FeatureGroup.
- Feature
Group stringName - The Name of the FeatureGroup.
- feature
Group StringName - The Name of the FeatureGroup.
- feature
Group stringName - The Name of the FeatureGroup.
- feature_
group_ strname - The Name of the FeatureGroup.
- feature
Group StringName - The Name of the FeatureGroup.
getFeatureGroup Result
The following output properties are available:
- Creation
Time string - A timestamp of FeatureGroup creation time.
- Feature
Definitions List<Pulumi.Aws Native. Sage Maker. Outputs. Feature Group Feature Definition> - An Array of Feature Definition
- Feature
Group stringStatus - The status of the feature group.
- Online
Store Pulumi.Config Aws Native. Sage Maker. Outputs. Online Store Config Properties - The configuration of an
OnlineStore
. - Throughput
Config Pulumi.Aws Native. Sage Maker. Outputs. Feature Group Throughput Config Used to set feature group throughput configuration. There are two modes:
ON_DEMAND
andPROVISIONED
. 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 theStandard
tier online store.
- Creation
Time string - A timestamp of FeatureGroup creation time.
- Feature
Definitions []FeatureGroup Feature Definition - An Array of Feature Definition
- Feature
Group stringStatus - The status of the feature group.
- Online
Store OnlineConfig Store Config Properties - The configuration of an
OnlineStore
. - Throughput
Config FeatureGroup Throughput Config Used to set feature group throughput configuration. There are two modes:
ON_DEMAND
andPROVISIONED
. 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 theStandard
tier online store.
- creation
Time String - A timestamp of FeatureGroup creation time.
- feature
Definitions List<FeatureGroup Feature Definition> - An Array of Feature Definition
- feature
Group StringStatus - The status of the feature group.
- online
Store OnlineConfig Store Config Properties - The configuration of an
OnlineStore
. - throughput
Config FeatureGroup Throughput Config Used to set feature group throughput configuration. There are two modes:
ON_DEMAND
andPROVISIONED
. 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 theStandard
tier online store.
- creation
Time string - A timestamp of FeatureGroup creation time.
- feature
Definitions FeatureGroup Feature Definition[] - An Array of Feature Definition
- feature
Group stringStatus - The status of the feature group.
- online
Store OnlineConfig Store Config Properties - The configuration of an
OnlineStore
. - throughput
Config FeatureGroup Throughput Config Used to set feature group throughput configuration. There are two modes:
ON_DEMAND
andPROVISIONED
. 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 theStandard
tier online store.
- creation_
time str - A timestamp of FeatureGroup creation time.
- feature_
definitions Sequence[FeatureGroup Feature Definition] - An Array of Feature Definition
- feature_
group_ strstatus - The status of the feature group.
- online_
store_ Onlineconfig Store Config Properties - The configuration of an
OnlineStore
. - throughput_
config FeatureGroup Throughput Config Used to set feature group throughput configuration. There are two modes:
ON_DEMAND
andPROVISIONED
. 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 theStandard
tier online store.
- creation
Time String - A timestamp of FeatureGroup creation time.
- feature
Definitions List<Property Map> - An Array of Feature Definition
- feature
Group StringStatus - The status of the feature group.
- online
Store Property MapConfig - The configuration of an
OnlineStore
. - throughput
Config Property Map Used to set feature group throughput configuration. There are two modes:
ON_DEMAND
andPROVISIONED
. 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 theStandard
tier online store.
Supporting Types
FeatureGroupFeatureDefinition
- Feature
Name string The name of a feature. The type must be a string.
FeatureName
cannot be any of the following:is_deleted
,write_time
,api_invocation_time
.The name:
- Must start with an alphanumeric character.
- Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.
- Feature
Type Pulumi.Aws Native. Sage Maker. Feature Group Feature Definition Feature Type - The value type of a feature. Valid values are Integral, Fractional, or String.
- Feature
Name string The name of a feature. The type must be a string.
FeatureName
cannot be any of the following:is_deleted
,write_time
,api_invocation_time
.The name:
- Must start with an alphanumeric character.
- Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.
- Feature
Type FeatureGroup Feature Definition Feature Type - The value type of a feature. Valid values are Integral, Fractional, or String.
- feature
Name String The name of a feature. The type must be a string.
FeatureName
cannot be any of the following:is_deleted
,write_time
,api_invocation_time
.The name:
- Must start with an alphanumeric character.
- Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.
- feature
Type FeatureGroup Feature Definition Feature Type - The value type of a feature. Valid values are Integral, Fractional, or String.
- feature
Name string The name of a feature. The type must be a string.
FeatureName
cannot be any of the following:is_deleted
,write_time
,api_invocation_time
.The name:
- Must start with an alphanumeric character.
- Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.
- feature
Type FeatureGroup Feature Definition Feature Type - The value type of a feature. Valid values are Integral, Fractional, or String.
- feature_
name str The name of a feature. The type must be a string.
FeatureName
cannot be any of the following:is_deleted
,write_time
,api_invocation_time
.The name:
- Must start with an alphanumeric character.
- Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.
- feature_
type FeatureGroup Feature Definition Feature Type - The value type of a feature. Valid values are Integral, Fractional, or String.
- feature
Name String The name of a feature. The type must be a string.
FeatureName
cannot be any of the following:is_deleted
,write_time
,api_invocation_time
.The name:
- Must start with an alphanumeric character.
- Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.
- feature
Type "Integral" | "Fractional" | "String" - The value type of a feature. Valid values are Integral, Fractional, or String.
FeatureGroupFeatureDefinitionFeatureType
FeatureGroupOnlineStoreSecurityConfig
- Kms
Key stringId The AWS Key Management Service (KMS) key ARN that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.
The caller (either user or IAM role) of
CreateFeatureGroup
must have below permissions to theOnlineStore
KmsKeyId
:"kms:Encrypt"
"kms:Decrypt"
"kms:DescribeKey"
"kms:CreateGrant"
"kms:RetireGrant"
"kms:ReEncryptFrom"
"kms:ReEncryptTo"
"kms:GenerateDataKey"
"kms:ListAliases"
"kms:ListGrants"
"kms:RevokeGrant"
The caller (either user or IAM role) to all DataPlane operations (
PutRecord
,GetRecord
,DeleteRecord
) must have the following permissions to theKmsKeyId
:"kms:Decrypt"
- Kms
Key stringId The AWS Key Management Service (KMS) key ARN that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.
The caller (either user or IAM role) of
CreateFeatureGroup
must have below permissions to theOnlineStore
KmsKeyId
:"kms:Encrypt"
"kms:Decrypt"
"kms:DescribeKey"
"kms:CreateGrant"
"kms:RetireGrant"
"kms:ReEncryptFrom"
"kms:ReEncryptTo"
"kms:GenerateDataKey"
"kms:ListAliases"
"kms:ListGrants"
"kms:RevokeGrant"
The caller (either user or IAM role) to all DataPlane operations (
PutRecord
,GetRecord
,DeleteRecord
) must have the following permissions to theKmsKeyId
:"kms:Decrypt"
- kms
Key StringId The AWS Key Management Service (KMS) key ARN that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.
The caller (either user or IAM role) of
CreateFeatureGroup
must have below permissions to theOnlineStore
KmsKeyId
:"kms:Encrypt"
"kms:Decrypt"
"kms:DescribeKey"
"kms:CreateGrant"
"kms:RetireGrant"
"kms:ReEncryptFrom"
"kms:ReEncryptTo"
"kms:GenerateDataKey"
"kms:ListAliases"
"kms:ListGrants"
"kms:RevokeGrant"
The caller (either user or IAM role) to all DataPlane operations (
PutRecord
,GetRecord
,DeleteRecord
) must have the following permissions to theKmsKeyId
:"kms:Decrypt"
- kms
Key stringId The AWS Key Management Service (KMS) key ARN that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.
The caller (either user or IAM role) of
CreateFeatureGroup
must have below permissions to theOnlineStore
KmsKeyId
:"kms:Encrypt"
"kms:Decrypt"
"kms:DescribeKey"
"kms:CreateGrant"
"kms:RetireGrant"
"kms:ReEncryptFrom"
"kms:ReEncryptTo"
"kms:GenerateDataKey"
"kms:ListAliases"
"kms:ListGrants"
"kms:RevokeGrant"
The caller (either user or IAM role) to all DataPlane operations (
PutRecord
,GetRecord
,DeleteRecord
) must have the following permissions to theKmsKeyId
:"kms:Decrypt"
- kms_
key_ strid The AWS Key Management Service (KMS) key ARN that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.
The caller (either user or IAM role) of
CreateFeatureGroup
must have below permissions to theOnlineStore
KmsKeyId
:"kms:Encrypt"
"kms:Decrypt"
"kms:DescribeKey"
"kms:CreateGrant"
"kms:RetireGrant"
"kms:ReEncryptFrom"
"kms:ReEncryptTo"
"kms:GenerateDataKey"
"kms:ListAliases"
"kms:ListGrants"
"kms:RevokeGrant"
The caller (either user or IAM role) to all DataPlane operations (
PutRecord
,GetRecord
,DeleteRecord
) must have the following permissions to theKmsKeyId
:"kms:Decrypt"
- kms
Key StringId The AWS Key Management Service (KMS) key ARN that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.
The caller (either user or IAM role) of
CreateFeatureGroup
must have below permissions to theOnlineStore
KmsKeyId
:"kms:Encrypt"
"kms:Decrypt"
"kms:DescribeKey"
"kms:CreateGrant"
"kms:RetireGrant"
"kms:ReEncryptFrom"
"kms:ReEncryptTo"
"kms:GenerateDataKey"
"kms:ListAliases"
"kms:ListGrants"
"kms:RevokeGrant"
The caller (either user or IAM role) to all DataPlane operations (
PutRecord
,GetRecord
,DeleteRecord
) must have the following permissions to theKmsKeyId
:"kms:Decrypt"
FeatureGroupStorageType
FeatureGroupThroughputConfig
- Throughput
Mode Pulumi.Aws Native. Sage Maker. Feature Group Throughput Mode - The mode used for your feature group throughput:
ON_DEMAND
orPROVISIONED
. - Provisioned
Read intCapacity Units - For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.
- Provisioned
Write intCapacity Units - For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.
- Throughput
Mode FeatureGroup Throughput Mode - The mode used for your feature group throughput:
ON_DEMAND
orPROVISIONED
. - Provisioned
Read intCapacity Units - For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.
- Provisioned
Write intCapacity Units - For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.
- throughput
Mode FeatureGroup Throughput Mode - The mode used for your feature group throughput:
ON_DEMAND
orPROVISIONED
. - provisioned
Read IntegerCapacity Units - For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.
- provisioned
Write IntegerCapacity Units - For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.
- throughput
Mode FeatureGroup Throughput Mode - The mode used for your feature group throughput:
ON_DEMAND
orPROVISIONED
. - provisioned
Read numberCapacity Units - For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.
- provisioned
Write numberCapacity Units - For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.
- throughput_
mode FeatureGroup Throughput Mode - The mode used for your feature group throughput:
ON_DEMAND
orPROVISIONED
. - provisioned_
read_ intcapacity_ units - For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.
- provisioned_
write_ intcapacity_ units - For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.
- throughput
Mode "OnDemand" | "Provisioned" - The mode used for your feature group throughput:
ON_DEMAND
orPROVISIONED
. - provisioned
Read NumberCapacity Units - For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.
- provisioned
Write NumberCapacity Units - For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.
FeatureGroupThroughputMode
FeatureGroupTtlDuration
- Unit
Pulumi.
Aws Native. Sage Maker. Feature Group Unit TtlDuration
time unit.- Value int
TtlDuration
time value.
- Unit
Feature
Group Unit TtlDuration
time unit.- Value int
TtlDuration
time value.
- unit
Feature
Group Unit TtlDuration
time unit.- value Integer
TtlDuration
time value.
- unit
Feature
Group Unit TtlDuration
time unit.- value number
TtlDuration
time value.
- unit
Feature
Group Unit TtlDuration
time unit.- value int
TtlDuration
time value.
- unit "Seconds" | "Minutes" | "Hours" | "Days" | "Weeks"
TtlDuration
time unit.- value Number
TtlDuration
time value.
FeatureGroupUnit
OnlineStoreConfigProperties
- Enable
Online boolStore Turn
OnlineStore
off by specifyingFalse
for theEnableOnlineStore
flag. TurnOnlineStore
on by specifyingTrue
for theEnableOnlineStore
flag.The default value is
False
.- Security
Config Pulumi.Aws Native. Sage Maker. Inputs. Feature Group Online Store Security Config - Use to specify KMS Key ID (
KMSKeyId
) for at-rest encryption of yourOnlineStore
. - Storage
Type Pulumi.Aws Native. Sage Maker. Feature Group Storage Type - Option for different tiers of low latency storage for real-time data retrieval.
Standard
: A managed low latency data store for feature groups.InMemory
: A managed data store for feature groups that supports very low latency retrieval.
- Ttl
Duration Pulumi.Aws Native. Sage Maker. Inputs. Feature Group Ttl Duration - Time to live duration, where the record is hard deleted after the expiration time is reached;
ExpiresAt
=EventTime
+TtlDuration
. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
- Enable
Online boolStore Turn
OnlineStore
off by specifyingFalse
for theEnableOnlineStore
flag. TurnOnlineStore
on by specifyingTrue
for theEnableOnlineStore
flag.The default value is
False
.- Security
Config FeatureGroup Online Store Security Config - Use to specify KMS Key ID (
KMSKeyId
) for at-rest encryption of yourOnlineStore
. - Storage
Type FeatureGroup Storage Type - Option for different tiers of low latency storage for real-time data retrieval.
Standard
: A managed low latency data store for feature groups.InMemory
: A managed data store for feature groups that supports very low latency retrieval.
- Ttl
Duration FeatureGroup Ttl Duration - Time to live duration, where the record is hard deleted after the expiration time is reached;
ExpiresAt
=EventTime
+TtlDuration
. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
- enable
Online BooleanStore Turn
OnlineStore
off by specifyingFalse
for theEnableOnlineStore
flag. TurnOnlineStore
on by specifyingTrue
for theEnableOnlineStore
flag.The default value is
False
.- security
Config FeatureGroup Online Store Security Config - Use to specify KMS Key ID (
KMSKeyId
) for at-rest encryption of yourOnlineStore
. - storage
Type FeatureGroup Storage Type - Option for different tiers of low latency storage for real-time data retrieval.
Standard
: A managed low latency data store for feature groups.InMemory
: A managed data store for feature groups that supports very low latency retrieval.
- ttl
Duration FeatureGroup Ttl Duration - Time to live duration, where the record is hard deleted after the expiration time is reached;
ExpiresAt
=EventTime
+TtlDuration
. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
- enable
Online booleanStore Turn
OnlineStore
off by specifyingFalse
for theEnableOnlineStore
flag. TurnOnlineStore
on by specifyingTrue
for theEnableOnlineStore
flag.The default value is
False
.- security
Config FeatureGroup Online Store Security Config - Use to specify KMS Key ID (
KMSKeyId
) for at-rest encryption of yourOnlineStore
. - storage
Type FeatureGroup Storage Type - Option for different tiers of low latency storage for real-time data retrieval.
Standard
: A managed low latency data store for feature groups.InMemory
: A managed data store for feature groups that supports very low latency retrieval.
- ttl
Duration FeatureGroup Ttl Duration - Time to live duration, where the record is hard deleted after the expiration time is reached;
ExpiresAt
=EventTime
+TtlDuration
. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
- enable_
online_ boolstore Turn
OnlineStore
off by specifyingFalse
for theEnableOnlineStore
flag. TurnOnlineStore
on by specifyingTrue
for theEnableOnlineStore
flag.The default value is
False
.- security_
config FeatureGroup Online Store Security Config - Use to specify KMS Key ID (
KMSKeyId
) for at-rest encryption of yourOnlineStore
. - storage_
type FeatureGroup Storage Type - Option for different tiers of low latency storage for real-time data retrieval.
Standard
: A managed low latency data store for feature groups.InMemory
: A managed data store for feature groups that supports very low latency retrieval.
- ttl_
duration FeatureGroup Ttl Duration - Time to live duration, where the record is hard deleted after the expiration time is reached;
ExpiresAt
=EventTime
+TtlDuration
. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
- enable
Online BooleanStore Turn
OnlineStore
off by specifyingFalse
for theEnableOnlineStore
flag. TurnOnlineStore
on by specifyingTrue
for theEnableOnlineStore
flag.The default value is
False
.- security
Config Property Map - Use to specify KMS Key ID (
KMSKeyId
) for at-rest encryption of yourOnlineStore
. - storage
Type "Standard" | "InMemory" - Option for different tiers of low latency storage for real-time data retrieval.
Standard
: A managed low latency data store for feature groups.InMemory
: A managed data store for feature groups that supports very low latency retrieval.
- ttl
Duration Property Map - Time to live duration, where the record is hard deleted after the expiration time is reached;
ExpiresAt
=EventTime
+TtlDuration
. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.