Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
Synopsis
- data DescribeFeatureGroup = DescribeFeatureGroup' {}
- newDescribeFeatureGroup :: Text -> DescribeFeatureGroup
- describeFeatureGroup_nextToken :: Lens' DescribeFeatureGroup (Maybe Text)
- describeFeatureGroup_featureGroupName :: Lens' DescribeFeatureGroup Text
- data DescribeFeatureGroupResponse = DescribeFeatureGroupResponse' {
- description :: Maybe Text
- failureReason :: Maybe Text
- featureGroupStatus :: Maybe FeatureGroupStatus
- lastModifiedTime :: Maybe POSIX
- lastUpdateStatus :: Maybe LastUpdateStatus
- offlineStoreConfig :: Maybe OfflineStoreConfig
- offlineStoreStatus :: Maybe OfflineStoreStatus
- onlineStoreConfig :: Maybe OnlineStoreConfig
- onlineStoreTotalSizeBytes :: Maybe Integer
- roleArn :: Maybe Text
- httpStatus :: Int
- featureGroupArn :: Text
- featureGroupName :: Text
- recordIdentifierFeatureName :: Text
- eventTimeFeatureName :: Text
- featureDefinitions :: NonEmpty FeatureDefinition
- creationTime :: POSIX
- nextToken :: Text
- newDescribeFeatureGroupResponse :: Int -> Text -> Text -> Text -> Text -> NonEmpty FeatureDefinition -> UTCTime -> Text -> DescribeFeatureGroupResponse
- describeFeatureGroupResponse_description :: Lens' DescribeFeatureGroupResponse (Maybe Text)
- describeFeatureGroupResponse_failureReason :: Lens' DescribeFeatureGroupResponse (Maybe Text)
- describeFeatureGroupResponse_featureGroupStatus :: Lens' DescribeFeatureGroupResponse (Maybe FeatureGroupStatus)
- describeFeatureGroupResponse_lastModifiedTime :: Lens' DescribeFeatureGroupResponse (Maybe UTCTime)
- describeFeatureGroupResponse_lastUpdateStatus :: Lens' DescribeFeatureGroupResponse (Maybe LastUpdateStatus)
- describeFeatureGroupResponse_offlineStoreConfig :: Lens' DescribeFeatureGroupResponse (Maybe OfflineStoreConfig)
- describeFeatureGroupResponse_offlineStoreStatus :: Lens' DescribeFeatureGroupResponse (Maybe OfflineStoreStatus)
- describeFeatureGroupResponse_onlineStoreConfig :: Lens' DescribeFeatureGroupResponse (Maybe OnlineStoreConfig)
- describeFeatureGroupResponse_onlineStoreTotalSizeBytes :: Lens' DescribeFeatureGroupResponse (Maybe Integer)
- describeFeatureGroupResponse_roleArn :: Lens' DescribeFeatureGroupResponse (Maybe Text)
- describeFeatureGroupResponse_httpStatus :: Lens' DescribeFeatureGroupResponse Int
- describeFeatureGroupResponse_featureGroupArn :: Lens' DescribeFeatureGroupResponse Text
- describeFeatureGroupResponse_featureGroupName :: Lens' DescribeFeatureGroupResponse Text
- describeFeatureGroupResponse_recordIdentifierFeatureName :: Lens' DescribeFeatureGroupResponse Text
- describeFeatureGroupResponse_eventTimeFeatureName :: Lens' DescribeFeatureGroupResponse Text
- describeFeatureGroupResponse_featureDefinitions :: Lens' DescribeFeatureGroupResponse (NonEmpty FeatureDefinition)
- describeFeatureGroupResponse_creationTime :: Lens' DescribeFeatureGroupResponse UTCTime
- describeFeatureGroupResponse_nextToken :: Lens' DescribeFeatureGroupResponse Text
Creating a Request
data DescribeFeatureGroup Source #
See: newDescribeFeatureGroup
smart constructor.
DescribeFeatureGroup' | |
|
Instances
newDescribeFeatureGroup Source #
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) Source #
A token to resume pagination of the list of Features
(FeatureDefinitions
). 2,500 Features
are returned by default.
describeFeatureGroup_featureGroupName :: Lens' DescribeFeatureGroup Text Source #
The name of the FeatureGroup
you want described.
Destructuring the Response
data DescribeFeatureGroupResponse Source #
See: newDescribeFeatureGroupResponse
smart constructor.
DescribeFeatureGroupResponse' | |
|
Instances
newDescribeFeatureGroupResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> Text | |
-> Text | |
-> NonEmpty FeatureDefinition | |
-> UTCTime | |
-> Text | |
-> 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 theOfflineStore
. - The
FeatureGroup
could not be deleted from theOfflineStore
.
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) Source #
A free form description of the feature group.
describeFeatureGroupResponse_failureReason :: Lens' DescribeFeatureGroupResponse (Maybe Text) Source #
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 theOfflineStore
. - The
FeatureGroup
could not be deleted from theOfflineStore
.
describeFeatureGroupResponse_featureGroupStatus :: Lens' DescribeFeatureGroupResponse (Maybe FeatureGroupStatus) Source #
The status of the feature group.
describeFeatureGroupResponse_lastModifiedTime :: Lens' DescribeFeatureGroupResponse (Maybe UTCTime) Source #
A timestamp indicating when the feature group was last updated.
describeFeatureGroupResponse_lastUpdateStatus :: Lens' DescribeFeatureGroupResponse (Maybe LastUpdateStatus) Source #
A value indicating whether the update made to the feature group was successful.
describeFeatureGroupResponse_offlineStoreConfig :: Lens' DescribeFeatureGroupResponse (Maybe OfflineStoreConfig) Source #
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) Source #
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) Source #
The configuration for the OnlineStore
.
describeFeatureGroupResponse_onlineStoreTotalSizeBytes :: Lens' DescribeFeatureGroupResponse (Maybe Integer) Source #
The size of the OnlineStore
in bytes.
describeFeatureGroupResponse_roleArn :: Lens' DescribeFeatureGroupResponse (Maybe Text) Source #
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 Source #
The response's http status code.
describeFeatureGroupResponse_featureGroupArn :: Lens' DescribeFeatureGroupResponse Text Source #
The Amazon Resource Name (ARN) of the FeatureGroup
.
describeFeatureGroupResponse_featureGroupName :: Lens' DescribeFeatureGroupResponse Text Source #
he name of the FeatureGroup
.
describeFeatureGroupResponse_recordIdentifierFeatureName :: Lens' DescribeFeatureGroupResponse Text Source #
The name of the Feature
used for RecordIdentifier
, whose value
uniquely identifies a record stored in the feature store.
describeFeatureGroupResponse_eventTimeFeatureName :: Lens' DescribeFeatureGroupResponse Text Source #
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) Source #
A list of the Features
in the FeatureGroup
. Each feature is defined
by a FeatureName
and FeatureType
.
describeFeatureGroupResponse_creationTime :: Lens' DescribeFeatureGroupResponse UTCTime Source #
A timestamp indicating when SageMaker created the FeatureGroup
.
describeFeatureGroupResponse_nextToken :: Lens' DescribeFeatureGroupResponse Text Source #
A token to resume pagination of the list of Features
(FeatureDefinitions
).