Skip to content

Type definitions#

Index > MachineLearning > Type definitions

Auto-generated documentation for MachineLearning type annotations stubs module mypy-boto3-machinelearning.

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: NotRequired[str],
    Value: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

BatchPredictionTypeDef#

# BatchPredictionTypeDef definition

class BatchPredictionTypeDef(TypedDict):
    BatchPredictionId: NotRequired[str],
    MLModelId: NotRequired[str],
    BatchPredictionDataSourceId: NotRequired[str],
    InputDataLocationS3: NotRequired[str],
    CreatedByIamUser: NotRequired[str],
    CreatedAt: NotRequired[datetime],
    LastUpdatedAt: NotRequired[datetime],
    Name: NotRequired[str],
    Status: NotRequired[EntityStatusType],  # (1)
    OutputUri: NotRequired[str],
    Message: NotRequired[str],
    ComputeTime: NotRequired[int],
    FinishedAt: NotRequired[datetime],
    StartedAt: NotRequired[datetime],
    TotalRecordCount: NotRequired[int],
    InvalidRecordCount: NotRequired[int],
  1. See EntityStatusType

CreateBatchPredictionInputRequestTypeDef#

# CreateBatchPredictionInputRequestTypeDef definition

class CreateBatchPredictionInputRequestTypeDef(TypedDict):
    BatchPredictionId: str,
    MLModelId: str,
    BatchPredictionDataSourceId: str,
    OutputUri: str,
    BatchPredictionName: NotRequired[str],

S3DataSpecTypeDef#

# S3DataSpecTypeDef definition

class S3DataSpecTypeDef(TypedDict):
    DataLocationS3: str,
    DataRearrangement: NotRequired[str],
    DataSchema: NotRequired[str],
    DataSchemaLocationS3: NotRequired[str],

CreateEvaluationInputRequestTypeDef#

# CreateEvaluationInputRequestTypeDef definition

class CreateEvaluationInputRequestTypeDef(TypedDict):
    EvaluationId: str,
    MLModelId: str,
    EvaluationDataSourceId: str,
    EvaluationName: NotRequired[str],

CreateMLModelInputRequestTypeDef#

# CreateMLModelInputRequestTypeDef definition

class CreateMLModelInputRequestTypeDef(TypedDict):
    MLModelId: str,
    MLModelType: MLModelTypeType,  # (1)
    TrainingDataSourceId: str,
    MLModelName: NotRequired[str],
    Parameters: NotRequired[Mapping[str, str]],
    Recipe: NotRequired[str],
    RecipeUri: NotRequired[str],
  1. See MLModelTypeType

CreateRealtimeEndpointInputRequestTypeDef#

# CreateRealtimeEndpointInputRequestTypeDef definition

class CreateRealtimeEndpointInputRequestTypeDef(TypedDict):
    MLModelId: str,

RealtimeEndpointInfoTypeDef#

# RealtimeEndpointInfoTypeDef definition

class RealtimeEndpointInfoTypeDef(TypedDict):
    PeakRequestsPerSecond: NotRequired[int],
    CreatedAt: NotRequired[datetime],
    EndpointUrl: NotRequired[str],
    EndpointStatus: NotRequired[RealtimeEndpointStatusType],  # (1)
  1. See RealtimeEndpointStatusType

DeleteBatchPredictionInputRequestTypeDef#

# DeleteBatchPredictionInputRequestTypeDef definition

class DeleteBatchPredictionInputRequestTypeDef(TypedDict):
    BatchPredictionId: str,

DeleteDataSourceInputRequestTypeDef#

# DeleteDataSourceInputRequestTypeDef definition

class DeleteDataSourceInputRequestTypeDef(TypedDict):
    DataSourceId: str,

DeleteEvaluationInputRequestTypeDef#

# DeleteEvaluationInputRequestTypeDef definition

class DeleteEvaluationInputRequestTypeDef(TypedDict):
    EvaluationId: str,

DeleteMLModelInputRequestTypeDef#

# DeleteMLModelInputRequestTypeDef definition

class DeleteMLModelInputRequestTypeDef(TypedDict):
    MLModelId: str,

DeleteRealtimeEndpointInputRequestTypeDef#

# DeleteRealtimeEndpointInputRequestTypeDef definition

class DeleteRealtimeEndpointInputRequestTypeDef(TypedDict):
    MLModelId: str,

DeleteTagsInputRequestTypeDef#

# DeleteTagsInputRequestTypeDef definition

class DeleteTagsInputRequestTypeDef(TypedDict):
    TagKeys: Sequence[str],
    ResourceId: str,
    ResourceType: TaggableResourceTypeType,  # (1)
  1. See TaggableResourceTypeType

WaiterConfigTypeDef#

# WaiterConfigTypeDef definition

class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    MaxAttempts: NotRequired[int],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

DescribeBatchPredictionsInputRequestTypeDef#

# DescribeBatchPredictionsInputRequestTypeDef definition

class DescribeBatchPredictionsInputRequestTypeDef(TypedDict):
    FilterVariable: NotRequired[BatchPredictionFilterVariableType],  # (1)
    EQ: NotRequired[str],
    GT: NotRequired[str],
    LT: NotRequired[str],
    GE: NotRequired[str],
    LE: NotRequired[str],
    NE: NotRequired[str],
    Prefix: NotRequired[str],
    SortOrder: NotRequired[SortOrderType],  # (2)
    NextToken: NotRequired[str],
    Limit: NotRequired[int],
  1. See BatchPredictionFilterVariableType
  2. See SortOrderType

DescribeDataSourcesInputRequestTypeDef#

# DescribeDataSourcesInputRequestTypeDef definition

class DescribeDataSourcesInputRequestTypeDef(TypedDict):
    FilterVariable: NotRequired[DataSourceFilterVariableType],  # (1)
    EQ: NotRequired[str],
    GT: NotRequired[str],
    LT: NotRequired[str],
    GE: NotRequired[str],
    LE: NotRequired[str],
    NE: NotRequired[str],
    Prefix: NotRequired[str],
    SortOrder: NotRequired[SortOrderType],  # (2)
    NextToken: NotRequired[str],
    Limit: NotRequired[int],
  1. See DataSourceFilterVariableType
  2. See SortOrderType

DescribeEvaluationsInputRequestTypeDef#

# DescribeEvaluationsInputRequestTypeDef definition

class DescribeEvaluationsInputRequestTypeDef(TypedDict):
    FilterVariable: NotRequired[EvaluationFilterVariableType],  # (1)
    EQ: NotRequired[str],
    GT: NotRequired[str],
    LT: NotRequired[str],
    GE: NotRequired[str],
    LE: NotRequired[str],
    NE: NotRequired[str],
    Prefix: NotRequired[str],
    SortOrder: NotRequired[SortOrderType],  # (2)
    NextToken: NotRequired[str],
    Limit: NotRequired[int],
  1. See EvaluationFilterVariableType
  2. See SortOrderType

DescribeMLModelsInputRequestTypeDef#

# DescribeMLModelsInputRequestTypeDef definition

class DescribeMLModelsInputRequestTypeDef(TypedDict):
    FilterVariable: NotRequired[MLModelFilterVariableType],  # (1)
    EQ: NotRequired[str],
    GT: NotRequired[str],
    LT: NotRequired[str],
    GE: NotRequired[str],
    LE: NotRequired[str],
    NE: NotRequired[str],
    Prefix: NotRequired[str],
    SortOrder: NotRequired[SortOrderType],  # (2)
    NextToken: NotRequired[str],
    Limit: NotRequired[int],
  1. See MLModelFilterVariableType
  2. See SortOrderType

DescribeTagsInputRequestTypeDef#

# DescribeTagsInputRequestTypeDef definition

class DescribeTagsInputRequestTypeDef(TypedDict):
    ResourceId: str,
    ResourceType: TaggableResourceTypeType,  # (1)
  1. See TaggableResourceTypeType

PerformanceMetricsTypeDef#

# PerformanceMetricsTypeDef definition

class PerformanceMetricsTypeDef(TypedDict):
    Properties: NotRequired[Dict[str, str]],

GetBatchPredictionInputRequestTypeDef#

# GetBatchPredictionInputRequestTypeDef definition

class GetBatchPredictionInputRequestTypeDef(TypedDict):
    BatchPredictionId: str,

GetDataSourceInputRequestTypeDef#

# GetDataSourceInputRequestTypeDef definition

class GetDataSourceInputRequestTypeDef(TypedDict):
    DataSourceId: str,
    Verbose: NotRequired[bool],

GetEvaluationInputRequestTypeDef#

# GetEvaluationInputRequestTypeDef definition

class GetEvaluationInputRequestTypeDef(TypedDict):
    EvaluationId: str,

GetMLModelInputRequestTypeDef#

# GetMLModelInputRequestTypeDef definition

class GetMLModelInputRequestTypeDef(TypedDict):
    MLModelId: str,
    Verbose: NotRequired[bool],

PredictInputRequestTypeDef#

# PredictInputRequestTypeDef definition

class PredictInputRequestTypeDef(TypedDict):
    MLModelId: str,
    Record: Mapping[str, str],
    PredictEndpoint: str,

PredictionTypeDef#

# PredictionTypeDef definition

class PredictionTypeDef(TypedDict):
    predictedLabel: NotRequired[str],
    predictedValue: NotRequired[float],
    predictedScores: NotRequired[Dict[str, float]],
    details: NotRequired[Dict[DetailsAttributesType, str]],  # (1)
  1. See DetailsAttributesType

RDSDatabaseCredentialsTypeDef#

# RDSDatabaseCredentialsTypeDef definition

class RDSDatabaseCredentialsTypeDef(TypedDict):
    Username: str,
    Password: str,

RDSDatabaseTypeDef#

# RDSDatabaseTypeDef definition

class RDSDatabaseTypeDef(TypedDict):
    InstanceIdentifier: str,
    DatabaseName: str,

RedshiftDatabaseCredentialsTypeDef#

# RedshiftDatabaseCredentialsTypeDef definition

class RedshiftDatabaseCredentialsTypeDef(TypedDict):
    Username: str,
    Password: str,

RedshiftDatabaseTypeDef#

# RedshiftDatabaseTypeDef definition

class RedshiftDatabaseTypeDef(TypedDict):
    DatabaseName: str,
    ClusterIdentifier: str,

UpdateBatchPredictionInputRequestTypeDef#

# UpdateBatchPredictionInputRequestTypeDef definition

class UpdateBatchPredictionInputRequestTypeDef(TypedDict):
    BatchPredictionId: str,
    BatchPredictionName: str,

UpdateDataSourceInputRequestTypeDef#

# UpdateDataSourceInputRequestTypeDef definition

class UpdateDataSourceInputRequestTypeDef(TypedDict):
    DataSourceId: str,
    DataSourceName: str,

UpdateEvaluationInputRequestTypeDef#

# UpdateEvaluationInputRequestTypeDef definition

class UpdateEvaluationInputRequestTypeDef(TypedDict):
    EvaluationId: str,
    EvaluationName: str,

UpdateMLModelInputRequestTypeDef#

# UpdateMLModelInputRequestTypeDef definition

class UpdateMLModelInputRequestTypeDef(TypedDict):
    MLModelId: str,
    MLModelName: NotRequired[str],
    ScoreThreshold: NotRequired[float],

AddTagsInputRequestTypeDef#

# AddTagsInputRequestTypeDef definition

class AddTagsInputRequestTypeDef(TypedDict):
    Tags: Sequence[TagTypeDef],  # (1)
    ResourceId: str,
    ResourceType: TaggableResourceTypeType,  # (2)
  1. See TagTypeDef
  2. See TaggableResourceTypeType

AddTagsOutputTypeDef#

# AddTagsOutputTypeDef definition

class AddTagsOutputTypeDef(TypedDict):
    ResourceId: str,
    ResourceType: TaggableResourceTypeType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TaggableResourceTypeType
  2. See ResponseMetadataTypeDef

CreateBatchPredictionOutputTypeDef#

# CreateBatchPredictionOutputTypeDef definition

class CreateBatchPredictionOutputTypeDef(TypedDict):
    BatchPredictionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateDataSourceFromRDSOutputTypeDef#

# CreateDataSourceFromRDSOutputTypeDef definition

class CreateDataSourceFromRDSOutputTypeDef(TypedDict):
    DataSourceId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateDataSourceFromRedshiftOutputTypeDef#

# CreateDataSourceFromRedshiftOutputTypeDef definition

class CreateDataSourceFromRedshiftOutputTypeDef(TypedDict):
    DataSourceId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateDataSourceFromS3OutputTypeDef#

# CreateDataSourceFromS3OutputTypeDef definition

class CreateDataSourceFromS3OutputTypeDef(TypedDict):
    DataSourceId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateEvaluationOutputTypeDef#

# CreateEvaluationOutputTypeDef definition

class CreateEvaluationOutputTypeDef(TypedDict):
    EvaluationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateMLModelOutputTypeDef#

# CreateMLModelOutputTypeDef definition

class CreateMLModelOutputTypeDef(TypedDict):
    MLModelId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteBatchPredictionOutputTypeDef#

# DeleteBatchPredictionOutputTypeDef definition

class DeleteBatchPredictionOutputTypeDef(TypedDict):
    BatchPredictionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteDataSourceOutputTypeDef#

# DeleteDataSourceOutputTypeDef definition

class DeleteDataSourceOutputTypeDef(TypedDict):
    DataSourceId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteEvaluationOutputTypeDef#

# DeleteEvaluationOutputTypeDef definition

class DeleteEvaluationOutputTypeDef(TypedDict):
    EvaluationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteMLModelOutputTypeDef#

# DeleteMLModelOutputTypeDef definition

class DeleteMLModelOutputTypeDef(TypedDict):
    MLModelId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteTagsOutputTypeDef#

# DeleteTagsOutputTypeDef definition

class DeleteTagsOutputTypeDef(TypedDict):
    ResourceId: str,
    ResourceType: TaggableResourceTypeType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TaggableResourceTypeType
  2. See ResponseMetadataTypeDef

DescribeTagsOutputTypeDef#