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 |
Derived from API version 2020-07-01
of the AWS service descriptions, licensed under Apache 2.0.
Contains all data plane API operations and data types for the Amazon SageMaker Feature Store. Use this API to put, delete, and retrieve (get) features from a feature store.
Use the following operations to configure your OnlineStore
and
OfflineStore
features, and to create and manage feature groups:
Synopsis
- defaultService :: Service
- _AccessForbidden :: AsError a => Fold a ServiceError
- _InternalFailure :: AsError a => Fold a ServiceError
- _ResourceNotFound :: AsError a => Fold a ServiceError
- _ServiceUnavailable :: AsError a => Fold a ServiceError
- _ValidationError :: AsError a => Fold a ServiceError
- data BatchGetRecord = BatchGetRecord' (NonEmpty BatchGetRecordIdentifier)
- newBatchGetRecord :: NonEmpty BatchGetRecordIdentifier -> BatchGetRecord
- data BatchGetRecordResponse = BatchGetRecordResponse' Int [BatchGetRecordResultDetail] [BatchGetRecordError] [BatchGetRecordIdentifier]
- newBatchGetRecordResponse :: Int -> BatchGetRecordResponse
- data DeleteRecord = DeleteRecord' (Maybe (NonEmpty TargetStore)) Text Text Text
- newDeleteRecord :: Text -> Text -> Text -> DeleteRecord
- data DeleteRecordResponse = DeleteRecordResponse' {
- newDeleteRecordResponse :: DeleteRecordResponse
- data GetRecord = GetRecord' (Maybe (NonEmpty Text)) Text Text
- newGetRecord :: Text -> Text -> GetRecord
- data GetRecordResponse = GetRecordResponse' (Maybe (NonEmpty FeatureValue)) Int
- newGetRecordResponse :: Int -> GetRecordResponse
- data PutRecord = PutRecord' (Maybe (NonEmpty TargetStore)) Text (NonEmpty FeatureValue)
- newPutRecord :: Text -> NonEmpty FeatureValue -> PutRecord
- data PutRecordResponse = PutRecordResponse' {
- newPutRecordResponse :: PutRecordResponse
- newtype TargetStore where
- TargetStore' { }
- pattern TargetStore_OfflineStore :: TargetStore
- pattern TargetStore_OnlineStore :: TargetStore
- data BatchGetRecordError = BatchGetRecordError' Text Text Text Text
- newBatchGetRecordError :: Text -> Text -> Text -> Text -> BatchGetRecordError
- data BatchGetRecordIdentifier = BatchGetRecordIdentifier' (Maybe (NonEmpty Text)) Text (NonEmpty Text)
- newBatchGetRecordIdentifier :: Text -> NonEmpty Text -> BatchGetRecordIdentifier
- data BatchGetRecordResultDetail = BatchGetRecordResultDetail' Text Text (NonEmpty FeatureValue)
- newBatchGetRecordResultDetail :: Text -> Text -> NonEmpty FeatureValue -> BatchGetRecordResultDetail
- data FeatureValue = FeatureValue' Text Text
- newFeatureValue :: Text -> Text -> FeatureValue
Service Configuration
defaultService :: Service Source #
API version 2020-07-01
of the Amazon SageMaker Feature Store Runtime SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by SageMakerFeatureStoreRuntime
.
AccessForbidden
_AccessForbidden :: AsError a => Fold a ServiceError Source #
You do not have permission to perform an action.
InternalFailure
_InternalFailure :: AsError a => Fold a ServiceError Source #
An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web Services customer support.
ResourceNotFound
_ResourceNotFound :: AsError a => Fold a ServiceError Source #
A resource that is required to perform an action was not found.
ServiceUnavailable
_ServiceUnavailable :: AsError a => Fold a ServiceError Source #
The service is currently unavailable.
ValidationError
_ValidationError :: AsError a => Fold a ServiceError Source #
There was an error validating your request.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
BatchGetRecord
data BatchGetRecord Source #
See: newBatchGetRecord
smart constructor.
Instances
Create a value of BatchGetRecord
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:
$sel:identifiers:BatchGetRecord'
, batchGetRecord_identifiers
- A list of FeatureGroup
names, with their corresponding
RecordIdentifier
value, and Feature name that have been requested to
be retrieved in batch.
data BatchGetRecordResponse Source #
See: newBatchGetRecordResponse
smart constructor.
BatchGetRecordResponse' Int [BatchGetRecordResultDetail] [BatchGetRecordError] [BatchGetRecordIdentifier] |
Instances
newBatchGetRecordResponse Source #
Create a value of BatchGetRecordResponse
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:
$sel:httpStatus:BatchGetRecordResponse'
, batchGetRecordResponse_httpStatus
- The response's http status code.
$sel:records:BatchGetRecordResponse'
, batchGetRecordResponse_records
- A list of Records you requested to be retrieved in batch.
$sel:errors:BatchGetRecordResponse'
, batchGetRecordResponse_errors
- A list of errors that have occurred when retrieving a batch of Records.
$sel:unprocessedIdentifiers:BatchGetRecordResponse'
, batchGetRecordResponse_unprocessedIdentifiers
- A unprocessed list of FeatureGroup
names, with their corresponding
RecordIdentifier
value, and Feature name.
DeleteRecord
data DeleteRecord Source #
See: newDeleteRecord
smart constructor.
Instances
Create a value of DeleteRecord
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:
$sel:targetStores:DeleteRecord'
, deleteRecord_targetStores
- A list of stores from which you're deleting the record. By default,
Feature Store deletes the record from all of the stores that you're
using for the FeatureGroup
.
DeleteRecord
, deleteRecord_featureGroupName
- The name of the feature group to delete the record from.
DeleteRecord
, deleteRecord_recordIdentifierValueAsString
- The value for the RecordIdentifier
that uniquely identifies the
record, in string format.
$sel:eventTime:DeleteRecord'
, deleteRecord_eventTime
- Timestamp indicating when the deletion event occurred. EventTime
can
be used to query data at a certain point in time.
data DeleteRecordResponse Source #
See: newDeleteRecordResponse
smart constructor.
Instances
Generic DeleteRecordResponse Source # | |
Defined in Amazonka.SageMakerFeatureStoreRuntime.DeleteRecord type Rep DeleteRecordResponse :: Type -> Type # from :: DeleteRecordResponse -> Rep DeleteRecordResponse x # to :: Rep DeleteRecordResponse x -> DeleteRecordResponse # | |
Read DeleteRecordResponse Source # | |
Show DeleteRecordResponse Source # | |
Defined in Amazonka.SageMakerFeatureStoreRuntime.DeleteRecord showsPrec :: Int -> DeleteRecordResponse -> ShowS # show :: DeleteRecordResponse -> String # showList :: [DeleteRecordResponse] -> ShowS # | |
NFData DeleteRecordResponse Source # | |
Defined in Amazonka.SageMakerFeatureStoreRuntime.DeleteRecord rnf :: DeleteRecordResponse -> () # | |
Eq DeleteRecordResponse Source # | |
Defined in Amazonka.SageMakerFeatureStoreRuntime.DeleteRecord (==) :: DeleteRecordResponse -> DeleteRecordResponse -> Bool # (/=) :: DeleteRecordResponse -> DeleteRecordResponse -> Bool # | |
type Rep DeleteRecordResponse Source # | |
newDeleteRecordResponse :: DeleteRecordResponse Source #
Create a value of DeleteRecordResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
GetRecord
See: newGetRecord
smart constructor.
Instances
Create a value of GetRecord
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:
GetRecord
, getRecord_featureNames
- List of names of Features to be retrieved. If not specified, the latest
value for all the Features are returned.
GetRecord
, getRecord_featureGroupName
- The name of the feature group from which you want to retrieve a record.
GetRecord
, getRecord_recordIdentifierValueAsString
- The value that corresponds to RecordIdentifier
type and uniquely
identifies the record in the FeatureGroup
.
data GetRecordResponse Source #
See: newGetRecordResponse
smart constructor.
Instances
Create a value of GetRecordResponse
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:
GetRecordResponse
, getRecordResponse_record
- The record you requested. A list of FeatureValues
.
$sel:httpStatus:GetRecordResponse'
, getRecordResponse_httpStatus
- The response's http status code.
PutRecord
See: newPutRecord
smart constructor.
Instances
Create a value of PutRecord
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:
$sel:targetStores:PutRecord'
, putRecord_targetStores
- A list of stores to which you're adding the record. By default, Feature
Store adds the record to all of the stores that you're using for the
FeatureGroup
.
PutRecord
, putRecord_featureGroupName
- The name of the feature group that you want to insert the record into.
PutRecord
, putRecord_record
- List of FeatureValues to be inserted. This will be a full over-write. If
you only want to update few of the feature values, do the following:
- Use
GetRecord
to retrieve the latest record. - Update the record returned from
GetRecord
. - Use
PutRecord
to update feature values.
data PutRecordResponse Source #
See: newPutRecordResponse
smart constructor.
Instances
Generic PutRecordResponse Source # | |
Defined in Amazonka.SageMakerFeatureStoreRuntime.PutRecord type Rep PutRecordResponse :: Type -> Type # from :: PutRecordResponse -> Rep PutRecordResponse x # to :: Rep PutRecordResponse x -> PutRecordResponse # | |
Read PutRecordResponse Source # | |
Show PutRecordResponse Source # | |
Defined in Amazonka.SageMakerFeatureStoreRuntime.PutRecord showsPrec :: Int -> PutRecordResponse -> ShowS # show :: PutRecordResponse -> String # showList :: [PutRecordResponse] -> ShowS # | |
NFData PutRecordResponse Source # | |
Defined in Amazonka.SageMakerFeatureStoreRuntime.PutRecord rnf :: PutRecordResponse -> () # | |
Eq PutRecordResponse Source # | |
Defined in Amazonka.SageMakerFeatureStoreRuntime.PutRecord (==) :: PutRecordResponse -> PutRecordResponse -> Bool # (/=) :: PutRecordResponse -> PutRecordResponse -> Bool # | |
type Rep PutRecordResponse Source # | |
newPutRecordResponse :: PutRecordResponse Source #
Create a value of PutRecordResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
Types
TargetStore
newtype TargetStore Source #
pattern TargetStore_OfflineStore :: TargetStore | |
pattern TargetStore_OnlineStore :: TargetStore |
Instances
BatchGetRecordError
data BatchGetRecordError Source #
The error that has occurred when attempting to retrieve a batch of Records.
See: newBatchGetRecordError
smart constructor.
Instances
newBatchGetRecordError Source #
:: Text | |
-> Text | |
-> Text | |
-> Text | |
-> BatchGetRecordError |
Create a value of BatchGetRecordError
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:
$sel:featureGroupName:BatchGetRecordError'
, batchGetRecordError_featureGroupName
- The name of the feature group that the record belongs to.
$sel:recordIdentifierValueAsString:BatchGetRecordError'
, batchGetRecordError_recordIdentifierValueAsString
- The value for the RecordIdentifier
in string format of a Record from a
FeatureGroup
that is causing an error when attempting to be retrieved.
$sel:errorCode:BatchGetRecordError'
, batchGetRecordError_errorCode
- The error code of an error that has occured when attempting to retrieve
a batch of Records. For more information on errors, see
Errors.
$sel:errorMessage:BatchGetRecordError'
, batchGetRecordError_errorMessage
- The error message of an error that has occured when attempting to
retrieve a record in the batch.
BatchGetRecordIdentifier
data BatchGetRecordIdentifier Source #
The identifier that identifies the batch of Records you are retrieving in a batch.
See: newBatchGetRecordIdentifier
smart constructor.
Instances
newBatchGetRecordIdentifier Source #
:: Text | |
-> NonEmpty Text |
|
-> BatchGetRecordIdentifier |
Create a value of BatchGetRecordIdentifier
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:
$sel:featureNames:BatchGetRecordIdentifier'
, batchGetRecordIdentifier_featureNames
- List of names of Features to be retrieved. If not specified, the latest
value for all the Features are returned.
$sel:featureGroupName:BatchGetRecordIdentifier'
, batchGetRecordIdentifier_featureGroupName
- A FeatureGroupName
containing Records you are retrieving in a batch.
$sel:recordIdentifiersValueAsString:BatchGetRecordIdentifier'
, batchGetRecordIdentifier_recordIdentifiersValueAsString
- The value for a list of record identifiers in string format.
BatchGetRecordResultDetail
data BatchGetRecordResultDetail Source #
The output of Records that have been retrieved in a batch.
See: newBatchGetRecordResultDetail
smart constructor.
Instances
newBatchGetRecordResultDetail Source #
:: Text | |
-> Text |
|
-> NonEmpty FeatureValue | |
-> BatchGetRecordResultDetail |
Create a value of BatchGetRecordResultDetail
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:
$sel:featureGroupName:BatchGetRecordResultDetail'
, batchGetRecordResultDetail_featureGroupName
- The FeatureGroupName
containing Records you retrieved in a batch.
$sel:recordIdentifierValueAsString:BatchGetRecordResultDetail'
, batchGetRecordResultDetail_recordIdentifierValueAsString
- The value of the record identifer in string format.
$sel:record:BatchGetRecordResultDetail'
, batchGetRecordResultDetail_record
- The Record
retrieved.
FeatureValue
data FeatureValue Source #
The value associated with a feature.
See: newFeatureValue
smart constructor.
Instances
Create a value of FeatureValue
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:
$sel:featureName:FeatureValue'
, featureValue_featureName
- The name of a feature that a feature value corresponds to.
$sel:valueAsString:FeatureValue'
, featureValue_valueAsString
- The value associated with a feature, in string format. Note that
features types can be String, Integral, or Fractional. This value
represents all three types as a string.