Amazonka.SageMaker.DescribeFeatureGroup

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.

Creating a Request

data DescribeFeatureGroup

See: newDescribeFeatureGroup smart constructor.

Constructors

DescribeFeatureGroup'

Fields

• nextToken :: Maybe Text

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

• featureGroupName :: Text

  The name of the FeatureGroup you want described.

Instances

ToJSON DescribeFeatureGroup

Defined in Amazonka.SageMaker.DescribeFeatureGroup

Methods

toJSON :: DescribeFeatureGroup -> Value

toEncoding :: DescribeFeatureGroup -> Encoding

toJSONList :: [DescribeFeatureGroup] -> Value

toEncodingList :: [DescribeFeatureGroup] -> Encoding

ToHeaders DescribeFeatureGroup

Defined in Amazonka.SageMaker.DescribeFeatureGroup

Methods

toHeaders :: DescribeFeatureGroup -> [Header]

ToPath DescribeFeatureGroup

Defined in Amazonka.SageMaker.DescribeFeatureGroup

Methods

toPath :: DescribeFeatureGroup -> ByteString

ToQuery DescribeFeatureGroup

Defined in Amazonka.SageMaker.DescribeFeatureGroup

Methods

toQuery :: DescribeFeatureGroup -> QueryString

AWSRequest DescribeFeatureGroup

Defined in Amazonka.SageMaker.DescribeFeatureGroup

Associated Types

type AWSResponse DescribeFeatureGroup

Methods

request :: (Service -> Service) -> DescribeFeatureGroup -> Request DescribeFeatureGroup

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeFeatureGroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeFeatureGroup)))

Generic DescribeFeatureGroup

Defined in Amazonka.SageMaker.DescribeFeatureGroup

Associated Types

type Rep DescribeFeatureGroup :: Type -> Type

Methods

from :: DescribeFeatureGroup -> Rep DescribeFeatureGroup x

to :: Rep DescribeFeatureGroup x -> DescribeFeatureGroup

Read DescribeFeatureGroup

Defined in Amazonka.SageMaker.DescribeFeatureGroup

Methods

readsPrec :: Int -> ReadS DescribeFeatureGroup

readList :: ReadS [DescribeFeatureGroup]

readPrec :: ReadPrec DescribeFeatureGroup

readListPrec :: ReadPrec [DescribeFeatureGroup]

Show DescribeFeatureGroup

Defined in Amazonka.SageMaker.DescribeFeatureGroup

Methods

showsPrec :: Int -> DescribeFeatureGroup -> ShowS

show :: DescribeFeatureGroup -> String

showList :: [DescribeFeatureGroup] -> ShowS

NFData DescribeFeatureGroup

Defined in Amazonka.SageMaker.DescribeFeatureGroup

Methods

rnf :: DescribeFeatureGroup -> ()

Eq DescribeFeatureGroup

Defined in Amazonka.SageMaker.DescribeFeatureGroup

Methods

(==) :: DescribeFeatureGroup -> DescribeFeatureGroup -> Bool

(/=) :: DescribeFeatureGroup -> DescribeFeatureGroup -> Bool

Hashable DescribeFeatureGroup

Defined in Amazonka.SageMaker.DescribeFeatureGroup

Methods

hashWithSalt :: Int -> DescribeFeatureGroup -> Int

hash :: DescribeFeatureGroup -> Int

type AWSResponse DescribeFeatureGroup

Defined in Amazonka.SageMaker.DescribeFeatureGroup

type AWSResponse DescribeFeatureGroup = DescribeFeatureGroupResponse

type Rep DescribeFeatureGroup

Defined in Amazonka.SageMaker.DescribeFeatureGroup

type Rep DescribeFeatureGroup = D1 ('MetaData "DescribeFeatureGroup" "Amazonka.SageMaker.DescribeFeatureGroup" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "DescribeFeatureGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "featureGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeFeatureGroup

Arguments

:: Text

DescribeFeatureGroup

-> DescribeFeatureGroup

Create a value of DescribeFeatureGroup with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

DescribeFeatureGroup, describeFeatureGroup_featureGroupName - The name of the FeatureGroup you want described.

Request Lenses

describeFeatureGroup_nextToken :: Lens' DescribeFeatureGroup (Maybe Text)

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

describeFeatureGroup_featureGroupName :: Lens' DescribeFeatureGroup Text

The name of the FeatureGroup you want described.

Destructuring the Response

data DescribeFeatureGroupResponse

See: newDescribeFeatureGroupResponse smart constructor.

Constructors

DescribeFeatureGroupResponse'

Fields

• description :: Maybe Text

  A free form description of the feature group.

• failureReason :: Maybe Text

  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.
• featureGroupStatus :: Maybe FeatureGroupStatus

  The status of the feature group.

• lastModifiedTime :: Maybe POSIX

  A timestamp indicating when the feature group was last updated.

• lastUpdateStatus :: Maybe LastUpdateStatus

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

• offlineStoreConfig :: Maybe 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.
• offlineStoreStatus :: Maybe OfflineStoreStatus

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

• onlineStoreConfig :: Maybe OnlineStoreConfig

  The configuration for the OnlineStore.

• onlineStoreTotalSizeBytes :: Maybe Integer

  The size of the OnlineStore in bytes.

• roleArn :: Maybe Text

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

• httpStatus :: Int

  The response's http status code.

• featureGroupArn :: Text

  The Amazon Resource Name (ARN) of the FeatureGroup.

• featureGroupName :: Text

  he name of the FeatureGroup.

• recordIdentifierFeatureName :: Text

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

• eventTimeFeatureName :: Text

  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 :: NonEmpty FeatureDefinition

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

• creationTime :: POSIX

  A timestamp indicating when SageMaker created the FeatureGroup.

• nextToken :: Text

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

Instances

Generic DescribeFeatureGroupResponse

Defined in Amazonka.SageMaker.DescribeFeatureGroup

Associated Types

type Rep DescribeFeatureGroupResponse :: Type -> Type

Methods

from :: DescribeFeatureGroupResponse -> Rep DescribeFeatureGroupResponse x

to :: Rep DescribeFeatureGroupResponse x -> DescribeFeatureGroupResponse

Read DescribeFeatureGroupResponse

Defined in Amazonka.SageMaker.DescribeFeatureGroup

Methods

readsPrec :: Int -> ReadS DescribeFeatureGroupResponse

readList :: ReadS [DescribeFeatureGroupResponse]

readPrec :: ReadPrec DescribeFeatureGroupResponse

readListPrec :: ReadPrec [DescribeFeatureGroupResponse]

Show DescribeFeatureGroupResponse

Defined in Amazonka.SageMaker.DescribeFeatureGroup

Methods

showsPrec :: Int -> DescribeFeatureGroupResponse -> ShowS

show :: DescribeFeatureGroupResponse -> String

showList :: [DescribeFeatureGroupResponse] -> ShowS

NFData DescribeFeatureGroupResponse

Defined in Amazonka.SageMaker.DescribeFeatureGroup

Methods

rnf :: DescribeFeatureGroupResponse -> ()

Eq DescribeFeatureGroupResponse

Defined in Amazonka.SageMaker.DescribeFeatureGroup

Methods

(==) :: DescribeFeatureGroupResponse -> DescribeFeatureGroupResponse -> Bool

(/=) :: DescribeFeatureGroupResponse -> DescribeFeatureGroupResponse -> Bool

type Rep DescribeFeatureGroupResponse

Defined in Amazonka.SageMaker.DescribeFeatureGroup

type Rep DescribeFeatureGroupResponse = D1 ('MetaData "DescribeFeatureGroupResponse" "Amazonka.SageMaker.DescribeFeatureGroup" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "DescribeFeatureGroupResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "featureGroupStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FeatureGroupStatus)) :*: S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "lastUpdateStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LastUpdateStatus)) :*: S1 ('MetaSel ('Just "offlineStoreConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OfflineStoreConfig))) :*: (S1 ('MetaSel ('Just "offlineStoreStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OfflineStoreStatus)) :*: (S1 ('MetaSel ('Just "onlineStoreConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OnlineStoreConfig)) :*: S1 ('MetaSel ('Just "onlineStoreTotalSizeBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))))) :*: (((S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "featureGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "featureGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "recordIdentifierFeatureName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "eventTimeFeatureName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "featureDefinitions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty FeatureDefinition)) :*: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newDescribeFeatureGroupResponse

Arguments

:: Int

$sel:httpStatus:DescribeFeatureGroupResponse'

-> Text

DescribeFeatureGroupResponse

-> Text

DescribeFeatureGroup

-> Text

DescribeFeatureGroupResponse

-> Text

DescribeFeatureGroupResponse

-> NonEmpty FeatureDefinition

DescribeFeatureGroupResponse

-> UTCTime

DescribeFeatureGroupResponse

-> Text

DescribeFeatureGroup

-> DescribeFeatureGroupResponse

Create a value of DescribeFeatureGroupResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeFeatureGroupResponse, describeFeatureGroupResponse_description - A free form description of the feature group.

DescribeFeatureGroupResponse, describeFeatureGroupResponse_failureReason - 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.

DescribeFeatureGroupResponse, describeFeatureGroupResponse_featureGroupStatus - The status of the feature group.

DescribeFeatureGroupResponse, describeFeatureGroupResponse_lastModifiedTime - A timestamp indicating when the feature group was last updated.

DescribeFeatureGroupResponse, describeFeatureGroupResponse_lastUpdateStatus - A value indicating whether the update made to the feature group was successful.

DescribeFeatureGroupResponse, describeFeatureGroupResponse_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.

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

DescribeFeatureGroupResponse, describeFeatureGroupResponse_onlineStoreConfig - The configuration for the OnlineStore.

$sel:onlineStoreTotalSizeBytes:DescribeFeatureGroupResponse', describeFeatureGroupResponse_onlineStoreTotalSizeBytes - The size of the OnlineStore in bytes.

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

$sel:httpStatus:DescribeFeatureGroupResponse', describeFeatureGroupResponse_httpStatus - The response's http status code.

DescribeFeatureGroupResponse, describeFeatureGroupResponse_featureGroupArn - The Amazon Resource Name (ARN) of the FeatureGroup.

DescribeFeatureGroup, describeFeatureGroupResponse_featureGroupName - he name of the FeatureGroup.

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

DescribeFeatureGroupResponse, describeFeatureGroupResponse_eventTimeFeatureName - 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.

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

DescribeFeatureGroupResponse, describeFeatureGroupResponse_creationTime - A timestamp indicating when SageMaker created the FeatureGroup.

DescribeFeatureGroup, describeFeatureGroupResponse_nextToken - A token to resume pagination of the list of Features (FeatureDefinitions).

Response Lenses

describeFeatureGroupResponse_description :: Lens' DescribeFeatureGroupResponse (Maybe Text)

A free form description of the feature group.

describeFeatureGroupResponse_failureReason :: Lens' DescribeFeatureGroupResponse (Maybe Text)

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.

describeFeatureGroupResponse_featureGroupStatus :: Lens' DescribeFeatureGroupResponse (Maybe FeatureGroupStatus)

The status of the feature group.

describeFeatureGroupResponse_lastModifiedTime :: Lens' DescribeFeatureGroupResponse (Maybe UTCTime)

A timestamp indicating when the feature group was last updated.

describeFeatureGroupResponse_lastUpdateStatus :: Lens' DescribeFeatureGroupResponse (Maybe LastUpdateStatus)

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

describeFeatureGroupResponse_offlineStoreConfig :: Lens' DescribeFeatureGroupResponse (Maybe 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.

describeFeatureGroupResponse_offlineStoreStatus :: Lens' DescribeFeatureGroupResponse (Maybe OfflineStoreStatus)

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

describeFeatureGroupResponse_onlineStoreConfig :: Lens' DescribeFeatureGroupResponse (Maybe OnlineStoreConfig)

The configuration for the OnlineStore.

describeFeatureGroupResponse_onlineStoreTotalSizeBytes :: Lens' DescribeFeatureGroupResponse (Maybe Integer)

The size of the OnlineStore in bytes.

describeFeatureGroupResponse_roleArn :: Lens' DescribeFeatureGroupResponse (Maybe Text)

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

describeFeatureGroupResponse_httpStatus :: Lens' DescribeFeatureGroupResponse Int

The response's http status code.

describeFeatureGroupResponse_featureGroupArn :: Lens' DescribeFeatureGroupResponse Text

The Amazon Resource Name (ARN) of the FeatureGroup.

describeFeatureGroupResponse_featureGroupName :: Lens' DescribeFeatureGroupResponse Text

he name of the FeatureGroup.

describeFeatureGroupResponse_recordIdentifierFeatureName :: Lens' DescribeFeatureGroupResponse Text

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

describeFeatureGroupResponse_eventTimeFeatureName :: Lens' DescribeFeatureGroupResponse Text

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.

describeFeatureGroupResponse_featureDefinitions :: Lens' DescribeFeatureGroupResponse (NonEmpty FeatureDefinition)

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

describeFeatureGroupResponse_creationTime :: Lens' DescribeFeatureGroupResponse UTCTime

A timestamp indicating when SageMaker created the FeatureGroup.

describeFeatureGroupResponse_nextToken :: Lens' DescribeFeatureGroupResponse Text

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