Skip to content

SageMakerFeatureStoreRuntimeClient#

Index > SageMakerFeatureStoreRuntime > SageMakerFeatureStoreRuntimeClient

Auto-generated documentation for SageMakerFeatureStoreRuntime type annotations stubs module mypy-boto3-sagemaker-featurestore-runtime.

SageMakerFeatureStoreRuntimeClient#

Type annotations and code completion for boto3.client("sagemaker-featurestore-runtime"). boto3 documentation

# SageMakerFeatureStoreRuntimeClient usage example

from boto3.session import Session
from mypy_boto3_sagemaker_featurestore_runtime.client import SageMakerFeatureStoreRuntimeClient

def get_sagemaker-featurestore-runtime_client() -> SageMakerFeatureStoreRuntimeClient:
    return Session().client("sagemaker-featurestore-runtime")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("sagemaker-featurestore-runtime").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("sagemaker-featurestore-runtime")

try:
    do_something(client)
except (
    client.exceptions.AccessForbidden,
    client.exceptions.ClientError,
    client.exceptions.InternalFailure,
    client.exceptions.ResourceNotFound,
    client.exceptions.ServiceUnavailable,
    client.exceptions.ValidationError,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_sagemaker_featurestore_runtime.client import Exceptions

def handle_error(exc: Exceptions.AccessForbidden) -> None:
    ...

Methods#

batch_get_record#

Retrieves a batch of Records from a FeatureGroup.

Type annotations and code completion for boto3.client("sagemaker-featurestore-runtime").batch_get_record method. boto3 documentation

# batch_get_record method definition

def batch_get_record(
    self,
    *,
    Identifiers: Sequence[BatchGetRecordIdentifierUnionTypeDef],  # (1)
    ExpirationTimeResponse: ExpirationTimeResponseType = ...,  # (2)
) -> BatchGetRecordResponseTypeDef:  # (3)
    ...
  1. See BatchGetRecordIdentifierTypeDef BatchGetRecordIdentifierOutputTypeDef
  2. See ExpirationTimeResponseType
  3. See BatchGetRecordResponseTypeDef
# batch_get_record method usage example with argument unpacking

kwargs: BatchGetRecordRequestRequestTypeDef = {  # (1)
    "Identifiers": ...,
}

parent.batch_get_record(**kwargs)
  1. See BatchGetRecordRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("sagemaker-featurestore-runtime").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("sagemaker-featurestore-runtime").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

delete_record#

Deletes a Record from a FeatureGroup in the OnlineStore.

Type annotations and code completion for boto3.client("sagemaker-featurestore-runtime").delete_record method. boto3 documentation

# delete_record method definition

def delete_record(
    self,
    *,
    FeatureGroupName: str,
    RecordIdentifierValueAsString: str,
    EventTime: str,
    TargetStores: Sequence[TargetStoreType] = ...,  # (1)
    DeletionMode: DeletionModeType = ...,  # (2)
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...
  1. See TargetStoreType
  2. See DeletionModeType
  3. See EmptyResponseMetadataTypeDef
# delete_record method usage example with argument unpacking

kwargs: DeleteRecordRequestRequestTypeDef = {  # (1)
    "FeatureGroupName": ...,
    "RecordIdentifierValueAsString": ...,
    "EventTime": ...,
}

parent.delete_record(**kwargs)
  1. See DeleteRecordRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("sagemaker-featurestore-runtime").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_record#

Use for OnlineStore serving from a FeatureStore.

Type annotations and code completion for boto3.client("sagemaker-featurestore-runtime").get_record method. boto3 documentation

# get_record method definition

def get_record(
    self,
    *,
    FeatureGroupName: str,
    RecordIdentifierValueAsString: str,
    FeatureNames: Sequence[str] = ...,
    ExpirationTimeResponse: ExpirationTimeResponseType = ...,  # (1)
) -> GetRecordResponseTypeDef:  # (2)
    ...
  1. See ExpirationTimeResponseType
  2. See GetRecordResponseTypeDef
# get_record method usage example with argument unpacking

kwargs: GetRecordRequestRequestTypeDef = {  # (1)
    "FeatureGroupName": ...,
    "RecordIdentifierValueAsString": ...,
}

parent.get_record(**kwargs)
  1. See GetRecordRequestRequestTypeDef

put_record#

The PutRecord API is used to ingest a list of Records into your feature group.

Type annotations and code completion for boto3.client("sagemaker-featurestore-runtime").put_record method. boto3 documentation

# put_record method definition

def put_record(
    self,
    *,
    FeatureGroupName: str,
    Record: Sequence[FeatureValueUnionTypeDef],  # (1)
    TargetStores: Sequence[TargetStoreType] = ...,  # (2)
    TtlDuration: TtlDurationTypeDef = ...,  # (3)
) -> EmptyResponseMetadataTypeDef:  # (4)
    ...
  1. See FeatureValueTypeDef FeatureValueOutputTypeDef
  2. See TargetStoreType
  3. See TtlDurationTypeDef
  4. See EmptyResponseMetadataTypeDef
# put_record method usage example with argument unpacking

kwargs: PutRecordRequestRequestTypeDef = {  # (1)
    "FeatureGroupName": ...,
    "Record": ...,
}

parent.put_record(**kwargs)
  1. See PutRecordRequestRequestTypeDef