Skip to content

Typed dictionaries

Index > SageMaker > Typed dictionaries

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

ActionSourceTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import ActionSourceTypeDef

def get_value() -> ActionSourceTypeDef:
    return {
        "SourceUri": ...,
    }
Definition
class ActionSourceTypeDef(TypedDict):
    SourceUri: str,
    SourceType: NotRequired[str],
    SourceId: NotRequired[str],

AddAssociationRequestRequestTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import AddAssociationRequestRequestTypeDef

def get_value() -> AddAssociationRequestRequestTypeDef:
    return {
        "SourceArn": ...,
        "DestinationArn": ...,
    }
Definition
class AddAssociationRequestRequestTypeDef(TypedDict):
    SourceArn: str,
    DestinationArn: str,
    AssociationType: NotRequired[AssociationEdgeTypeType],  # (1)
  1. See AssociationEdgeTypeType

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
Definition
class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

TagTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
        "Value": ...,
    }
Definition
class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

AgentVersionTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import AgentVersionTypeDef

def get_value() -> AgentVersionTypeDef:
    return {
        "Version": ...,
        "AgentCount": ...,
    }
Definition
class AgentVersionTypeDef(TypedDict):
    Version: str,
    AgentCount: int,

AlarmTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import AlarmTypeDef

def get_value() -> AlarmTypeDef:
    return {
        "AlarmName": ...,
    }
Definition
class AlarmTypeDef(TypedDict):
    AlarmName: NotRequired[str],

MetricDefinitionTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import MetricDefinitionTypeDef

def get_value() -> MetricDefinitionTypeDef:
    return {
        "Name": ...,
        "Regex": ...,
    }
Definition
class MetricDefinitionTypeDef(TypedDict):
    Name: str,
    Regex: str,

AlgorithmStatusItemTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import AlgorithmStatusItemTypeDef

def get_value() -> AlgorithmStatusItemTypeDef:
    return {
        "Name": ...,
        "Status": ...,
    }
Definition
class AlgorithmStatusItemTypeDef(TypedDict):
    Name: str,
    Status: DetailedAlgorithmStatusType,  # (1)
    FailureReason: NotRequired[str],
  1. See DetailedAlgorithmStatusType

AlgorithmSummaryTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import AlgorithmSummaryTypeDef

def get_value() -> AlgorithmSummaryTypeDef:
    return {
        "AlgorithmName": ...,
        "AlgorithmArn": ...,
        "CreationTime": ...,
        "AlgorithmStatus": ...,
    }
Definition
class AlgorithmSummaryTypeDef(TypedDict):
    AlgorithmName: str,
    AlgorithmArn: str,
    CreationTime: datetime,
    AlgorithmStatus: AlgorithmStatusType,  # (1)
    AlgorithmDescription: NotRequired[str],
  1. See AlgorithmStatusType

AnnotationConsolidationConfigTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import AnnotationConsolidationConfigTypeDef

def get_value() -> AnnotationConsolidationConfigTypeDef:
    return {
        "AnnotationConsolidationLambdaArn": ...,
    }
Definition
class AnnotationConsolidationConfigTypeDef(TypedDict):
    AnnotationConsolidationLambdaArn: str,

AppDetailsTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import AppDetailsTypeDef

def get_value() -> AppDetailsTypeDef:
    return {
        "DomainId": ...,
    }
Definition
class AppDetailsTypeDef(TypedDict):
    DomainId: NotRequired[str],
    UserProfileName: NotRequired[str],
    AppType: NotRequired[AppTypeType],  # (1)
    AppName: NotRequired[str],
    Status: NotRequired[AppStatusType],  # (2)
    CreationTime: NotRequired[datetime],
  1. See AppTypeType
  2. See AppStatusType

AppSpecificationTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import AppSpecificationTypeDef

def get_value() -> AppSpecificationTypeDef:
    return {
        "ImageUri": ...,
    }
Definition
class AppSpecificationTypeDef(TypedDict):
    ImageUri: str,
    ContainerEntrypoint: NotRequired[Sequence[str]],
    ContainerArguments: NotRequired[Sequence[str]],

ArtifactSourceTypeTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import ArtifactSourceTypeTypeDef

def get_value() -> ArtifactSourceTypeTypeDef:
    return {
        "SourceIdType": ...,
        "Value": ...,
    }
Definition
class ArtifactSourceTypeTypeDef(TypedDict):
    SourceIdType: ArtifactSourceIdTypeType,  # (1)
    Value: str,
  1. See ArtifactSourceIdTypeType

AssociateTrialComponentRequestRequestTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import AssociateTrialComponentRequestRequestTypeDef

def get_value() -> AssociateTrialComponentRequestRequestTypeDef:
    return {
        "TrialComponentName": ...,
        "TrialName": ...,
    }
Definition
class AssociateTrialComponentRequestRequestTypeDef(TypedDict):
    TrialComponentName: str,
    TrialName: str,

UserContextTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import UserContextTypeDef

def get_value() -> UserContextTypeDef:
    return {
        "UserProfileArn": ...,
    }
Definition
class UserContextTypeDef(TypedDict):
    UserProfileArn: NotRequired[str],
    UserProfileName: NotRequired[str],
    DomainId: NotRequired[str],

AsyncInferenceClientConfigTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import AsyncInferenceClientConfigTypeDef

def get_value() -> AsyncInferenceClientConfigTypeDef:
    return {
        "MaxConcurrentInvocationsPerInstance": ...,
    }
Definition
class AsyncInferenceClientConfigTypeDef(TypedDict):
    MaxConcurrentInvocationsPerInstance: NotRequired[int],

AsyncInferenceNotificationConfigTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import AsyncInferenceNotificationConfigTypeDef

def get_value() -> AsyncInferenceNotificationConfigTypeDef:
    return {
        "SuccessTopic": ...,
    }
Definition
class AsyncInferenceNotificationConfigTypeDef(TypedDict):
    SuccessTopic: NotRequired[str],
    ErrorTopic: NotRequired[str],

AthenaDatasetDefinitionTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import AthenaDatasetDefinitionTypeDef

def get_value() -> AthenaDatasetDefinitionTypeDef:
    return {
        "Catalog": ...,
        "Database": ...,
        "QueryString": ...,
        "OutputS3Uri": ...,
        "OutputFormat": ...,
    }
Definition
class AthenaDatasetDefinitionTypeDef(TypedDict):
    Catalog: str,
    Database: str,
    QueryString: str,
    OutputS3Uri: str,
    OutputFormat: AthenaResultFormatType,  # (1)
    WorkGroup: NotRequired[str],
    KmsKeyId: NotRequired[str],
    OutputCompression: NotRequired[AthenaResultCompressionTypeType],  # (2)
  1. See AthenaResultFormatType
  2. See AthenaResultCompressionTypeType

AutoMLCandidateGenerationConfigTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import AutoMLCandidateGenerationConfigTypeDef

def get_value() -> AutoMLCandidateGenerationConfigTypeDef:
    return {
        "FeatureSpecificationS3Uri": ...,
    }
Definition
class AutoMLCandidateGenerationConfigTypeDef(TypedDict):
    FeatureSpecificationS3Uri: NotRequired[str],

AutoMLCandidateStepTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import AutoMLCandidateStepTypeDef

def get_value() -> AutoMLCandidateStepTypeDef:
    return {
        "CandidateStepType": ...,
        "CandidateStepArn": ...,
        "CandidateStepName": ...,
    }
Definition
class AutoMLCandidateStepTypeDef(TypedDict):
    CandidateStepType: CandidateStepTypeType,  # (1)
    CandidateStepArn: str,
    CandidateStepName: str,
  1. See CandidateStepTypeType

AutoMLContainerDefinitionTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import AutoMLContainerDefinitionTypeDef

def get_value() -> AutoMLContainerDefinitionTypeDef:
    return {
        "Image": ...,
        "ModelDataUrl": ...,
    }
Definition
class AutoMLContainerDefinitionTypeDef(TypedDict):
    Image: str,
    ModelDataUrl: str,
    Environment: NotRequired[Dict[str, str]],

FinalAutoMLJobObjectiveMetricTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import FinalAutoMLJobObjectiveMetricTypeDef

def get_value() -> FinalAutoMLJobObjectiveMetricTypeDef:
    return {
        "MetricName": ...,
        "Value": ...,
    }
Definition
class FinalAutoMLJobObjectiveMetricTypeDef(TypedDict):
    MetricName: AutoMLMetricEnumType,  # (2)
    Value: float,
    Type: NotRequired[AutoMLJobObjectiveTypeType],  # (1)
  1. See AutoMLJobObjectiveTypeType
  2. See AutoMLMetricEnumType

AutoMLS3DataSourceTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import AutoMLS3DataSourceTypeDef

def get_value() -> AutoMLS3DataSourceTypeDef:
    return {
        "S3DataType": ...,
        "S3Uri": ...,
    }
Definition
class AutoMLS3DataSourceTypeDef(TypedDict):
    S3DataType: AutoMLS3DataTypeType,  # (1)
    S3Uri: str,
  1. See AutoMLS3DataTypeType

AutoMLDataSplitConfigTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import AutoMLDataSplitConfigTypeDef

def get_value() -> AutoMLDataSplitConfigTypeDef:
    return {
        "ValidationFraction": ...,
    }
Definition
class AutoMLDataSplitConfigTypeDef(TypedDict):
    ValidationFraction: NotRequired[float],

AutoMLJobArtifactsTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import AutoMLJobArtifactsTypeDef

def get_value() -> AutoMLJobArtifactsTypeDef:
    return {
        "CandidateDefinitionNotebookLocation": ...,
    }
Definition
class AutoMLJobArtifactsTypeDef(TypedDict):
    CandidateDefinitionNotebookLocation: NotRequired[str],
    DataExplorationNotebookLocation: NotRequired[str],

AutoMLJobCompletionCriteriaTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import AutoMLJobCompletionCriteriaTypeDef

def get_value() -> AutoMLJobCompletionCriteriaTypeDef:
    return {
        "MaxCandidates": ...,
    }
Definition
class AutoMLJobCompletionCriteriaTypeDef(TypedDict):
    MaxCandidates: NotRequired[int],
    MaxRuntimePerTrainingJobInSeconds: NotRequired[int],
    MaxAutoMLJobRuntimeInSeconds: NotRequired[int],

AutoMLJobObjectiveTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import AutoMLJobObjectiveTypeDef

def get_value() -> AutoMLJobObjectiveTypeDef:
    return {
        "MetricName": ...,
    }
Definition
class AutoMLJobObjectiveTypeDef(TypedDict):
    MetricName: AutoMLMetricEnumType,  # (1)
  1. See AutoMLMetricEnumType

AutoMLPartialFailureReasonTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import AutoMLPartialFailureReasonTypeDef

def get_value() -> AutoMLPartialFailureReasonTypeDef:
    return {
        "PartialFailureMessage": ...,
    }
Definition
class AutoMLPartialFailureReasonTypeDef(TypedDict):
    PartialFailureMessage: NotRequired[str],

AutoMLOutputDataConfigTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import AutoMLOutputDataConfigTypeDef

def get_value() -> AutoMLOutputDataConfigTypeDef:
    return {
        "S3OutputPath": ...,
    }
Definition
class AutoMLOutputDataConfigTypeDef(TypedDict):
    S3OutputPath: str,
    KmsKeyId: NotRequired[str],

VpcConfigTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import VpcConfigTypeDef

def get_value() -> VpcConfigTypeDef:
    return {
        "SecurityGroupIds": ...,
        "Subnets": ...,
    }
Definition
class VpcConfigTypeDef(TypedDict):
    SecurityGroupIds: Sequence[str],
    Subnets: Sequence[str],

BatchDescribeModelPackageErrorTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import BatchDescribeModelPackageErrorTypeDef

def get_value() -> BatchDescribeModelPackageErrorTypeDef:
    return {
        "ErrorCode": ...,
        "ErrorResponse": ...,
    }
Definition
class BatchDescribeModelPackageErrorTypeDef(TypedDict):
    ErrorCode: str,
    ErrorResponse: str,

BatchDescribeModelPackageInputRequestTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import BatchDescribeModelPackageInputRequestTypeDef

def get_value() -> BatchDescribeModelPackageInputRequestTypeDef:
    return {
        "ModelPackageArnList": ...,
    }
Definition
class BatchDescribeModelPackageInputRequestTypeDef(TypedDict):
    ModelPackageArnList: Sequence[str],

MetricsSourceTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import MetricsSourceTypeDef

def get_value() -> MetricsSourceTypeDef:
    return {
        "ContentType": ...,
        "S3Uri": ...,
    }
Definition
class MetricsSourceTypeDef(TypedDict):
    ContentType: str,
    S3Uri: str,
    ContentDigest: NotRequired[str],

CacheHitResultTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import CacheHitResultTypeDef

def get_value() -> CacheHitResultTypeDef:
    return {
        "SourcePipelineExecutionArn": ...,
    }
Definition
class CacheHitResultTypeDef(TypedDict):
    SourcePipelineExecutionArn: NotRequired[str],

OutputParameterTypeDef

Usage Example
from mypy_boto3_sagemaker.type_defs import OutputParameterTypeDef