Typed dictionaries

Index > SagemakerEdgeManager > Typed dictionaries

Auto-generated documentation for SagemakerEdgeManager type annotations stubs module mypy-boto3-sagemaker-edge.

ChecksumTypeDef

# ChecksumTypeDef usage example

from mypy_boto3_sagemaker_edge.type_defs import ChecksumTypeDef

def get_value() -> ChecksumTypeDef:
    return {
        "Type": ...,
    }

# ChecksumTypeDef definition

class ChecksumTypeDef(TypedDict):
    Type: NotRequired[ChecksumTypeType],  # (1)
    Sum: NotRequired[str],

1. See ChecksumTypeType

DeploymentModelTypeDef

# DeploymentModelTypeDef usage example

from mypy_boto3_sagemaker_edge.type_defs import DeploymentModelTypeDef

def get_value() -> DeploymentModelTypeDef:
    return {
        "ModelHandle": ...,
    }

# DeploymentModelTypeDef definition

class DeploymentModelTypeDef(TypedDict):
    ModelHandle: NotRequired[str],
    ModelName: NotRequired[str],
    ModelVersion: NotRequired[str],
    DesiredState: NotRequired[ModelStateType],  # (1)
    State: NotRequired[ModelStateType],  # (1)
    Status: NotRequired[DeploymentStatusType],  # (3)
    StatusReason: NotRequired[str],
    RollbackFailureReason: NotRequired[str],

1. See ModelStateType
2. See ModelStateType
3. See DeploymentStatusType

EdgeMetricTypeDef

# EdgeMetricTypeDef usage example

from mypy_boto3_sagemaker_edge.type_defs import EdgeMetricTypeDef

def get_value() -> EdgeMetricTypeDef:
    return {
        "Dimension": ...,
    }

# EdgeMetricTypeDef definition

class EdgeMetricTypeDef(TypedDict):
    Dimension: NotRequired[str],
    MetricName: NotRequired[str],
    Value: NotRequired[float],
    Timestamp: NotRequired[Union[datetime, str]],

EmptyResponseMetadataTypeDef

# EmptyResponseMetadataTypeDef usage example

from mypy_boto3_sagemaker_edge.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

GetDeploymentsRequestRequestTypeDef

# GetDeploymentsRequestRequestTypeDef usage example

from mypy_boto3_sagemaker_edge.type_defs import GetDeploymentsRequestRequestTypeDef

def get_value() -> GetDeploymentsRequestRequestTypeDef:
    return {
        "DeviceName": ...,
        "DeviceFleetName": ...,
    }

# GetDeploymentsRequestRequestTypeDef definition

class GetDeploymentsRequestRequestTypeDef(TypedDict):
    DeviceName: str,
    DeviceFleetName: str,

GetDeviceRegistrationRequestRequestTypeDef

# GetDeviceRegistrationRequestRequestTypeDef usage example

from mypy_boto3_sagemaker_edge.type_defs import GetDeviceRegistrationRequestRequestTypeDef

def get_value() -> GetDeviceRegistrationRequestRequestTypeDef:
    return {
        "DeviceName": ...,
        "DeviceFleetName": ...,
    }

# GetDeviceRegistrationRequestRequestTypeDef definition

class GetDeviceRegistrationRequestRequestTypeDef(TypedDict):
    DeviceName: str,
    DeviceFleetName: str,

GetDeviceRegistrationResultTypeDef

# GetDeviceRegistrationResultTypeDef usage example

from mypy_boto3_sagemaker_edge.type_defs import GetDeviceRegistrationResultTypeDef

def get_value() -> GetDeviceRegistrationResultTypeDef:
    return {
        "DeviceRegistration": ...,
        "CacheTTL": ...,
        "ResponseMetadata": ...,
    }

# GetDeviceRegistrationResultTypeDef definition

class GetDeviceRegistrationResultTypeDef(TypedDict):
    DeviceRegistration: str,
    CacheTTL: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

ResponseMetadataTypeDef

# ResponseMetadataTypeDef usage example

from mypy_boto3_sagemaker_edge.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

DefinitionTypeDef

# DefinitionTypeDef usage example

from mypy_boto3_sagemaker_edge.type_defs import DefinitionTypeDef

def get_value() -> DefinitionTypeDef:
    return {
        "ModelHandle": ...,
    }

# DefinitionTypeDef definition

class DefinitionTypeDef(TypedDict):
    ModelHandle: NotRequired[str],
    S3Url: NotRequired[str],
    Checksum: NotRequired[ChecksumTypeDef],  # (1)
    State: NotRequired[ModelStateType],  # (2)

1. See ChecksumTypeDef
2. See ModelStateType

DeploymentResultTypeDef

# DeploymentResultTypeDef usage example

from mypy_boto3_sagemaker_edge.type_defs import DeploymentResultTypeDef

def get_value() -> DeploymentResultTypeDef:
    return {
        "DeploymentName": ...,
    }

# DeploymentResultTypeDef definition

class DeploymentResultTypeDef(TypedDict):
    DeploymentName: NotRequired[str],
    DeploymentStatus: NotRequired[str],
    DeploymentStatusMessage: NotRequired[str],
    DeploymentStartTime: NotRequired[Union[datetime, str]],
    DeploymentEndTime: NotRequired[Union[datetime, str]],
    DeploymentModels: NotRequired[Sequence[DeploymentModelTypeDef]],  # (1)

1. See DeploymentModelTypeDef

ModelTypeDef

# ModelTypeDef usage example

from mypy_boto3_sagemaker_edge.type_defs import ModelTypeDef

def get_value() -> ModelTypeDef:
    return {
        "ModelName": ...,
    }

# ModelTypeDef definition

class ModelTypeDef(TypedDict):
    ModelName: NotRequired[str],
    ModelVersion: NotRequired[str],
    LatestSampleTime: NotRequired[Union[datetime, str]],
    LatestInference: NotRequired[Union[datetime, str]],
    ModelMetrics: NotRequired[Sequence[EdgeMetricTypeDef]],  # (1)

1. See EdgeMetricTypeDef

EdgeDeploymentTypeDef

# EdgeDeploymentTypeDef usage example

from mypy_boto3_sagemaker_edge.type_defs import EdgeDeploymentTypeDef

def get_value() -> EdgeDeploymentTypeDef:
    return {
        "DeploymentName": ...,
    }

# EdgeDeploymentTypeDef definition

class EdgeDeploymentTypeDef(TypedDict):
    DeploymentName: NotRequired[str],
    Type: NotRequired[DeploymentTypeType],  # (1)
    FailureHandlingPolicy: NotRequired[FailureHandlingPolicyType],  # (2)
    Definitions: NotRequired[List[DefinitionTypeDef]],  # (3)

1. See DeploymentTypeType
2. See FailureHandlingPolicyType
3. See DefinitionTypeDef

SendHeartbeatRequestRequestTypeDef

# SendHeartbeatRequestRequestTypeDef usage example

from mypy_boto3_sagemaker_edge.type_defs import SendHeartbeatRequestRequestTypeDef

def get_value() -> SendHeartbeatRequestRequestTypeDef:
    return {
        "AgentVersion": ...,
        "DeviceName": ...,
        "DeviceFleetName": ...,
    }

# SendHeartbeatRequestRequestTypeDef definition

class SendHeartbeatRequestRequestTypeDef(TypedDict):
    AgentVersion: str,
    DeviceName: str,
    DeviceFleetName: str,
    AgentMetrics: NotRequired[Sequence[EdgeMetricTypeDef]],  # (1)
    Models: NotRequired[Sequence[ModelTypeDef]],  # (2)
    DeploymentResult: NotRequired[DeploymentResultTypeDef],  # (3)

1. See EdgeMetricTypeDef
2. See ModelTypeDef
3. See DeploymentResultTypeDef

GetDeploymentsResultTypeDef

# GetDeploymentsResultTypeDef usage example

from mypy_boto3_sagemaker_edge.type_defs import GetDeploymentsResultTypeDef

def get_value() -> GetDeploymentsResultTypeDef:
    return {
        "Deployments": ...,
        "ResponseMetadata": ...,
    }

# GetDeploymentsResultTypeDef definition

class GetDeploymentsResultTypeDef(TypedDict):
    Deployments: List[EdgeDeploymentTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See EdgeDeploymentTypeDef
2. See ResponseMetadataTypeDef