Skip to content

Type definitions#

Index > SagemakerEdgeManager > Type definitions

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

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

ChecksumTypeDef#

# ChecksumTypeDef definition

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

DeploymentModelTypeDef#

# 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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

GetDeploymentsRequestRequestTypeDef#

# GetDeploymentsRequestRequestTypeDef definition

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

GetDeviceRegistrationRequestRequestTypeDef#

# GetDeviceRegistrationRequestRequestTypeDef definition

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

DefinitionTypeDef#

# 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 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

EdgeMetricTypeDef#

# EdgeMetricTypeDef definition

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

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

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

GetDeviceRegistrationResultTypeDef#

# GetDeviceRegistrationResultTypeDef definition

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

EdgeDeploymentTypeDef#

# 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

ModelTypeDef#

# 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

GetDeploymentsResultTypeDef#

# GetDeploymentsResultTypeDef definition

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

SendHeartbeatRequestRequestTypeDef#

# 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