[ aws . sagemaker ]

describe-feature-group

Description

Use this operation to describe a FeatureGroup . The response includes information on the creation time, FeatureGroup name, the unique identifier for each FeatureGroup , and more.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-feature-group
--feature-group-name <value>
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--feature-group-name (string)

The name of the FeatureGroup you want described.

--next-token (string)

A token to resume pagination of the list of Features (FeatureDefinitions ). 2,500 Features are returned by default.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

FeatureGroupArn -> (string)

The Amazon Resource Name (ARN) of the FeatureGroup .

FeatureGroupName -> (string)

he name of the FeatureGroup .

RecordIdentifierFeatureName -> (string)

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

EventTimeFeatureName -> (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 .

FeatureDefinitions -> (list)

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

(structure)

A list of features. You must include FeatureName and FeatureType . Valid feature FeatureType s are Integral , Fractional and String .

FeatureName -> (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 .

FeatureType -> (string)

The value type of a feature. Valid values are Integral, Fractional, or String.

CreationTime -> (timestamp)

A timestamp indicating when SageMaker created the FeatureGroup .

OnlineStoreConfig -> (structure)

The configuration for the OnlineStore .

SecurityConfig -> (structure)

Use to specify KMS Key ID (KMSKeyId ) for at-rest encryption of your OnlineStore .

KmsKeyId -> (string)

The ID of the AWS Key Management Service (AWS KMS) key that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.

The caller (either IAM user or IAM role) of CreateFeatureGroup must have below permissions to the OnlineStore 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 IAM user or IAM role) to all DataPlane operations (PutRecord , GetRecord , DeleteRecord ) must have the following permissions to the KmsKeyId :

• "kms:Decrypt"

EnableOnlineStore -> (boolean)

Turn OnlineStore off by specifying False for the EnableOnlineStore flag. Turn OnlineStore on by specifying True for the EnableOnlineStore flag.

The default value is False .

OfflineStoreConfig -> (structure)

The configuration of the OfflineStore , inducing the S3 location of the OfflineStore , AWS Glue or AWS Hive data catalogue configurations, and the security configuration.

S3StorageConfig -> (structure)

The Amazon Simple Storage (Amazon S3) location of OfflineStore .

S3Uri -> (string)

The S3 URI, or location in Amazon S3, of OfflineStore .

S3 URIs have a format similar to the following: s3://example-bucket/prefix/ .

KmsKeyId -> (string)

The AWS Key Management Service (KMS) key ID of the key used to encrypt any objects written into the OfflineStore S3 location.

The IAM roleARN that is passed as a parameter to CreateFeatureGroup must have below permissions to the KmsKeyId :

• "kms:GenerateDataKey"

DisableGlueTableCreation -> (boolean)

Set to True to disable the automatic creation of an AWS Glue table when configuring an OfflineStore .

DataCatalogConfig -> (structure)

The meta data of the Glue table that is autogenerated when an OfflineStore is created.

TableName -> (string)

The name of the Glue table.

Catalog -> (string)

The name of the Glue table catalog.

Database -> (string)

The name of the Glue table database.

RoleArn -> (string)

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

FeatureGroupStatus -> (string)

The status of the feature group.

OfflineStoreStatus -> (structure)

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

Status -> (string)

An OfflineStore status.

BlockedReason -> (string)

The justification for why the OfflineStoreStatus is Blocked (if applicable).

FailureReason -> (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 -> (string)

A free form description of the feature group.

NextToken -> (string)

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