SageMakerClient
Auto-generated documentation for SageMaker type annotations stubs module mypy-boto3-sagemaker.
SageMakerClient
Type annotations and code completion for boto3.client("sagemaker")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_sagemaker.client import SageMakerClient
def get_sagemaker_client() -> SageMakerClient:
return Session().client("sagemaker")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("sagemaker").exceptions
structure.
client = boto3.client("sagemaker")
try:
do_something(client)
except (
client.ClientError,
client.ConflictException,
client.ResourceInUse,
client.ResourceLimitExceeded,
client.ResourceNotFound,
) as e:
print(e)
from mypy_boto3_sagemaker.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
...
Methods
add_association
Creates an association between the source and the destination.
Type annotations and code completion for boto3.client("sagemaker").add_association
method.
boto3 documentation
def add_association(
self,
*,
SourceArn: str,
DestinationArn: str,
AssociationType: AssociationEdgeTypeType = ..., # (1)
) -> AddAssociationResponseTypeDef: # (2)
...
kwargs: AddAssociationRequestRequestTypeDef = { # (1)
"SourceArn": ...,
"DestinationArn": ...,
}
parent.add_association(**kwargs)
add_tags
Adds or overwrites one or more tags for the specified SageMaker resource.
Type annotations and code completion for boto3.client("sagemaker").add_tags
method.
boto3 documentation
def add_tags(
self,
*,
ResourceArn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> AddTagsOutputTypeDef: # (2)
...
- See TagTypeDef
- See AddTagsOutputTypeDef
kwargs: AddTagsInputRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.add_tags(**kwargs)
associate_trial_component
Associates a trial component with a trial.
Type annotations and code completion for boto3.client("sagemaker").associate_trial_component
method.
boto3 documentation
def associate_trial_component(
self,
*,
TrialComponentName: str,
TrialName: str,
) -> AssociateTrialComponentResponseTypeDef: # (1)
...
kwargs: AssociateTrialComponentRequestRequestTypeDef = { # (1)
"TrialComponentName": ...,
"TrialName": ...,
}
parent.associate_trial_component(**kwargs)
batch_describe_model_package
This action batch describes a list of versioned model packages See also: AWS API Documentation.
Type annotations and code completion for boto3.client("sagemaker").batch_describe_model_package
method.
boto3 documentation
def batch_describe_model_package(
self,
*,
ModelPackageArnList: Sequence[str],
) -> BatchDescribeModelPackageOutputTypeDef: # (1)
...
kwargs: BatchDescribeModelPackageInputRequestTypeDef = { # (1)
"ModelPackageArnList": ...,
}
parent.batch_describe_model_package(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("sagemaker").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("sagemaker").close
method.
boto3 documentation
create_action
Creates an action.
Type annotations and code completion for boto3.client("sagemaker").create_action
method.
boto3 documentation
def create_action(
self,
*,
ActionName: str,
Source: ActionSourceTypeDef, # (1)
ActionType: str,
Description: str = ...,
Status: ActionStatusType = ..., # (2)
Properties: Mapping[str, str] = ...,
MetadataProperties: MetadataPropertiesTypeDef = ..., # (3)
Tags: Sequence[TagTypeDef] = ..., # (4)
) -> CreateActionResponseTypeDef: # (5)
...
- See ActionSourceTypeDef
- See ActionStatusType
- See MetadataPropertiesTypeDef
- See TagTypeDef
- See CreateActionResponseTypeDef
kwargs: CreateActionRequestRequestTypeDef = { # (1)
"ActionName": ...,
"Source": ...,
"ActionType": ...,
}
parent.create_action(**kwargs)
create_algorithm
Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace.
Type annotations and code completion for boto3.client("sagemaker").create_algorithm
method.
boto3 documentation
def create_algorithm(
self,
*,
AlgorithmName: str,
TrainingSpecification: TrainingSpecificationTypeDef, # (1)
AlgorithmDescription: str = ...,
InferenceSpecification: InferenceSpecificationTypeDef = ..., # (2)
ValidationSpecification: AlgorithmValidationSpecificationTypeDef = ..., # (3)
CertifyForMarketplace: bool = ...,
Tags: Sequence[TagTypeDef] = ..., # (4)
) -> CreateAlgorithmOutputTypeDef: # (5)
...
- See TrainingSpecificationTypeDef
- See InferenceSpecificationTypeDef
- See AlgorithmValidationSpecificationTypeDef
- See TagTypeDef
- See CreateAlgorithmOutputTypeDef
kwargs: CreateAlgorithmInputRequestTypeDef = { # (1)
"AlgorithmName": ...,
"TrainingSpecification": ...,
}
parent.create_algorithm(**kwargs)
create_app
Creates a running app for the specified UserProfile.
Type annotations and code completion for boto3.client("sagemaker").create_app
method.
boto3 documentation
def create_app(
self,
*,
DomainId: str,
AppType: AppTypeType, # (1)
AppName: str,
UserProfileName: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
ResourceSpec: ResourceSpecTypeDef = ..., # (3)
SpaceName: str = ...,
) -> CreateAppResponseTypeDef: # (4)
...
- See AppTypeType
- See TagTypeDef
- See ResourceSpecTypeDef
- See CreateAppResponseTypeDef
kwargs: CreateAppRequestRequestTypeDef = { # (1)
"DomainId": ...,
"AppType": ...,
"AppName": ...,
}
parent.create_app(**kwargs)
create_app_image_config
Creates a configuration for running a SageMaker image as a KernelGateway app.
Type annotations and code completion for boto3.client("sagemaker").create_app_image_config
method.
boto3 documentation
def create_app_image_config(
self,
*,
AppImageConfigName: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
KernelGatewayImageConfig: KernelGatewayImageConfigTypeDef = ..., # (2)
) -> CreateAppImageConfigResponseTypeDef: # (3)
...
kwargs: CreateAppImageConfigRequestRequestTypeDef = { # (1)
"AppImageConfigName": ...,
}
parent.create_app_image_config(**kwargs)
create_artifact
Creates an artifact.
Type annotations and code completion for boto3.client("sagemaker").create_artifact
method.
boto3 documentation
def create_artifact(
self,
*,
Source: ArtifactSourceTypeDef, # (1)
ArtifactType: str,
ArtifactName: str = ...,
Properties: Mapping[str, str] = ...,
MetadataProperties: MetadataPropertiesTypeDef = ..., # (2)
Tags: Sequence[TagTypeDef] = ..., # (3)
) -> CreateArtifactResponseTypeDef: # (4)
...
- See ArtifactSourceTypeDef
- See MetadataPropertiesTypeDef
- See TagTypeDef
- See CreateArtifactResponseTypeDef
kwargs: CreateArtifactRequestRequestTypeDef = { # (1)
"Source": ...,
"ArtifactType": ...,
}
parent.create_artifact(**kwargs)
create_auto_ml_job
Creates an Autopilot job.
Type annotations and code completion for boto3.client("sagemaker").create_auto_ml_job
method.
boto3 documentation
def create_auto_ml_job(
self,
*,
AutoMLJobName: str,
InputDataConfig: Sequence[AutoMLChannelTypeDef], # (1)
OutputDataConfig: AutoMLOutputDataConfigTypeDef, # (2)
RoleArn: str,
ProblemType: ProblemTypeType = ..., # (3)
AutoMLJobObjective: AutoMLJobObjectiveTypeDef = ..., # (4)
AutoMLJobConfig: AutoMLJobConfigTypeDef = ..., # (5)
GenerateCandidateDefinitionsOnly: bool = ...,
Tags: Sequence[TagTypeDef] = ..., # (6)
ModelDeployConfig: ModelDeployConfigTypeDef = ..., # (7)
) -> CreateAutoMLJobResponseTypeDef: # (8)
...
- See AutoMLChannelTypeDef
- See AutoMLOutputDataConfigTypeDef
- See ProblemTypeType
- See AutoMLJobObjectiveTypeDef
- See AutoMLJobConfigTypeDef
- See TagTypeDef
- See ModelDeployConfigTypeDef
- See CreateAutoMLJobResponseTypeDef
kwargs: CreateAutoMLJobRequestRequestTypeDef = { # (1)
"AutoMLJobName": ...,
"InputDataConfig": ...,
"OutputDataConfig": ...,
"RoleArn": ...,
}
parent.create_auto_ml_job(**kwargs)
create_code_repository
Creates a Git repository as a resource in your SageMaker account.
Type annotations and code completion for boto3.client("sagemaker").create_code_repository
method.
boto3 documentation
def create_code_repository(
self,
*,
CodeRepositoryName: str,
GitConfig: GitConfigTypeDef, # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateCodeRepositoryOutputTypeDef: # (3)
...
kwargs: CreateCodeRepositoryInputRequestTypeDef = { # (1)
"CodeRepositoryName": ...,
"GitConfig": ...,
}
parent.create_code_repository(**kwargs)
create_compilation_job
Starts a model compilation job.
Type annotations and code completion for boto3.client("sagemaker").create_compilation_job
method.
boto3 documentation
def create_compilation_job(
self,
*,
CompilationJobName: str,
RoleArn: str,
OutputConfig: OutputConfigTypeDef, # (1)
StoppingCondition: StoppingConditionTypeDef, # (2)
ModelPackageVersionArn: str = ...,
InputConfig: InputConfigTypeDef = ..., # (3)
VpcConfig: NeoVpcConfigTypeDef = ..., # (4)
Tags: Sequence[TagTypeDef] = ..., # (5)
) -> CreateCompilationJobResponseTypeDef: # (6)
...
- See OutputConfigTypeDef
- See StoppingConditionTypeDef
- See InputConfigTypeDef
- See NeoVpcConfigTypeDef
- See TagTypeDef
- See CreateCompilationJobResponseTypeDef
kwargs: CreateCompilationJobRequestRequestTypeDef = { # (1)
"CompilationJobName": ...,
"RoleArn": ...,
"OutputConfig": ...,
"StoppingCondition": ...,
}
parent.create_compilation_job(**kwargs)
create_context
Creates a context.
Type annotations and code completion for boto3.client("sagemaker").create_context
method.
boto3 documentation
def create_context(
self,
*,
ContextName: str,
Source: ContextSourceTypeDef, # (1)
ContextType: str,
Description: str = ...,
Properties: Mapping[str, str] = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateContextResponseTypeDef: # (3)
...
kwargs: CreateContextRequestRequestTypeDef = { # (1)
"ContextName": ...,
"Source": ...,
"ContextType": ...,
}
parent.create_context(**kwargs)
create_data_quality_job_definition
Creates a definition for a job that monitors data quality and drift.
Type annotations and code completion for boto3.client("sagemaker").create_data_quality_job_definition
method.
boto3 documentation
def create_data_quality_job_definition(
self,
*,
JobDefinitionName: str,
DataQualityAppSpecification: DataQualityAppSpecificationTypeDef, # (1)
DataQualityJobInput: DataQualityJobInputTypeDef, # (2)
DataQualityJobOutputConfig: MonitoringOutputConfigTypeDef, # (3)
JobResources: MonitoringResourcesTypeDef, # (4)
RoleArn: str,
DataQualityBaselineConfig: DataQualityBaselineConfigTypeDef = ..., # (5)
NetworkConfig: MonitoringNetworkConfigTypeDef = ..., # (6)
StoppingCondition: MonitoringStoppingConditionTypeDef = ..., # (7)
Tags: Sequence[TagTypeDef] = ..., # (8)
) -> CreateDataQualityJobDefinitionResponseTypeDef: # (9)
...
- See DataQualityAppSpecificationTypeDef
- See DataQualityJobInputTypeDef
- See MonitoringOutputConfigTypeDef
- See MonitoringResourcesTypeDef
- See DataQualityBaselineConfigTypeDef
- See MonitoringNetworkConfigTypeDef
- See MonitoringStoppingConditionTypeDef
- See TagTypeDef
- See CreateDataQualityJobDefinitionResponseTypeDef
kwargs: CreateDataQualityJobDefinitionRequestRequestTypeDef = { # (1)
"JobDefinitionName": ...,
"DataQualityAppSpecification": ...,
"DataQualityJobInput": ...,
"DataQualityJobOutputConfig": ...,
"JobResources": ...,
"RoleArn": ...,
}
parent.create_data_quality_job_definition(**kwargs)
create_device_fleet
Creates a device fleet.
Type annotations and code completion for boto3.client("sagemaker").create_device_fleet
method.
boto3 documentation
def create_device_fleet(
self,
*,
DeviceFleetName: str,
OutputConfig: EdgeOutputConfigTypeDef, # (1)
RoleArn: str = ...,
Description: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
EnableIotRoleAlias: bool = ...,
) -> EmptyResponseMetadataTypeDef: # (3)
...
kwargs: CreateDeviceFleetRequestRequestTypeDef = { # (1)
"DeviceFleetName": ...,
"OutputConfig": ...,
}
parent.create_device_fleet(**kwargs)
create_domain
Creates a Domain
used by Amazon SageMaker Studio.
Type annotations and code completion for boto3.client("sagemaker").create_domain
method.
boto3 documentation
def create_domain(
self,
*,
DomainName: str,
AuthMode: AuthModeType, # (1)
DefaultUserSettings: UserSettingsTypeDef, # (2)
SubnetIds: Sequence[str],
VpcId: str,
Tags: Sequence[TagTypeDef] = ..., # (3)
AppNetworkAccessType: AppNetworkAccessTypeType = ..., # (4)
HomeEfsFileSystemKmsKeyId: str = ...,
KmsKeyId: str = ...,
AppSecurityGroupManagement: AppSecurityGroupManagementType = ..., # (5)
DomainSettings: DomainSettingsTypeDef = ..., # (6)
DefaultSpaceSettings: DefaultSpaceSettingsTypeDef = ..., # (7)
) -> CreateDomainResponseTypeDef: # (8)
...
- See AuthModeType
- See UserSettingsTypeDef
- See TagTypeDef
- See AppNetworkAccessTypeType
- See AppSecurityGroupManagementType
- See DomainSettingsTypeDef
- See DefaultSpaceSettingsTypeDef
- See CreateDomainResponseTypeDef
kwargs: CreateDomainRequestRequestTypeDef = { # (1)
"DomainName": ...,
"AuthMode": ...,
"DefaultUserSettings": ...,
"SubnetIds": ...,
"VpcId": ...,
}
parent.create_domain(**kwargs)
create_edge_deployment_plan
Creates an edge deployment plan, consisting of multiple stages.
Type annotations and code completion for boto3.client("sagemaker").create_edge_deployment_plan
method.
boto3 documentation
def create_edge_deployment_plan(
self,
*,
EdgeDeploymentPlanName: str,
ModelConfigs: Sequence[EdgeDeploymentModelConfigTypeDef], # (1)
DeviceFleetName: str,
Stages: Sequence[DeploymentStageTypeDef] = ..., # (2)
Tags: Sequence[TagTypeDef] = ..., # (3)
) -> CreateEdgeDeploymentPlanResponseTypeDef: # (4)
...
- See EdgeDeploymentModelConfigTypeDef
- See DeploymentStageTypeDef
- See TagTypeDef
- See CreateEdgeDeploymentPlanResponseTypeDef
kwargs: CreateEdgeDeploymentPlanRequestRequestTypeDef = { # (1)
"EdgeDeploymentPlanName": ...,
"ModelConfigs": ...,
"DeviceFleetName": ...,
}
parent.create_edge_deployment_plan(**kwargs)
create_edge_deployment_stage
Creates a new stage in an existing edge deployment plan.
Type annotations and code completion for boto3.client("sagemaker").create_edge_deployment_stage
method.
boto3 documentation
def create_edge_deployment_stage(
self,
*,
EdgeDeploymentPlanName: str,
Stages: Sequence[DeploymentStageTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: CreateEdgeDeploymentStageRequestRequestTypeDef = { # (1)
"EdgeDeploymentPlanName": ...,
"Stages": ...,
}
parent.create_edge_deployment_stage(**kwargs)
create_edge_packaging_job
Starts a SageMaker Edge Manager model packaging job.
Type annotations and code completion for boto3.client("sagemaker").create_edge_packaging_job
method.
boto3 documentation
def create_edge_packaging_job(
self,
*,
EdgePackagingJobName: str,
CompilationJobName: str,
ModelName: str,
ModelVersion: str,
RoleArn: str,
OutputConfig: EdgeOutputConfigTypeDef, # (1)
ResourceKey: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> EmptyResponseMetadataTypeDef: # (3)
...
kwargs: CreateEdgePackagingJobRequestRequestTypeDef = { # (1)
"EdgePackagingJobName": ...,
"CompilationJobName": ...,
"ModelName": ...,
"ModelVersion": ...,
"RoleArn": ...,
"OutputConfig": ...,
}
parent.create_edge_packaging_job(**kwargs)
create_endpoint
Creates an endpoint using the endpoint configuration specified in the request.
Type annotations and code completion for boto3.client("sagemaker").create_endpoint
method.
boto3 documentation
def create_endpoint(
self,
*,
EndpointName: str,
EndpointConfigName: str,
DeploymentConfig: DeploymentConfigTypeDef = ..., # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateEndpointOutputTypeDef: # (3)
...
kwargs: CreateEndpointInputRequestTypeDef = { # (1)
"EndpointName": ...,
"EndpointConfigName": ...,
}
parent.create_endpoint(**kwargs)
create_endpoint_config
Creates an endpoint configuration that SageMaker hosting services uses to deploy models.
Type annotations and code completion for boto3.client("sagemaker").create_endpoint_config
method.
boto3 documentation
def create_endpoint_config(
self,
*,
EndpointConfigName: str,
ProductionVariants: Sequence[ProductionVariantTypeDef], # (1)
DataCaptureConfig: DataCaptureConfigTypeDef = ..., # (2)
Tags: Sequence[TagTypeDef] = ..., # (3)
KmsKeyId: str = ...,
AsyncInferenceConfig: AsyncInferenceConfigTypeDef = ..., # (4)
ExplainerConfig: ExplainerConfigTypeDef = ..., # (5)
ShadowProductionVariants: Sequence[ProductionVariantTypeDef] = ..., # (1)
) -> CreateEndpointConfigOutputTypeDef: # (7)
...
- See ProductionVariantTypeDef
- See DataCaptureConfigTypeDef
- See TagTypeDef
- See AsyncInferenceConfigTypeDef
- See ExplainerConfigTypeDef
- See ProductionVariantTypeDef
- See CreateEndpointConfigOutputTypeDef
kwargs: CreateEndpointConfigInputRequestTypeDef = { # (1)
"EndpointConfigName": ...,
"ProductionVariants": ...,
}
parent.create_endpoint_config(**kwargs)
create_experiment
Creates a SageMaker experiment.
Type annotations and code completion for boto3.client("sagemaker").create_experiment
method.
boto3 documentation
def create_experiment(
self,
*,
ExperimentName: str,
DisplayName: str = ...,
Description: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateExperimentResponseTypeDef: # (2)
...
kwargs: CreateExperimentRequestRequestTypeDef = { # (1)
"ExperimentName": ...,
}
parent.create_experiment(**kwargs)
create_feature_group
Create a new FeatureGroup
.
Type annotations and code completion for boto3.client("sagemaker").create_feature_group
method.
boto3 documentation
def create_feature_group(
self,
*,
FeatureGroupName: str,
RecordIdentifierFeatureName: str,
EventTimeFeatureName: str,
FeatureDefinitions: Sequence[FeatureDefinitionTypeDef], # (1)
OnlineStoreConfig: OnlineStoreConfigTypeDef = ..., # (2)
OfflineStoreConfig: OfflineStoreConfigTypeDef = ..., # (3)
RoleArn: str = ...,
Description: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (4)
) -> CreateFeatureGroupResponseTypeDef: # (5)
...
- See FeatureDefinitionTypeDef
- See OnlineStoreConfigTypeDef
- See OfflineStoreConfigTypeDef
- See TagTypeDef
- See CreateFeatureGroupResponseTypeDef
kwargs: CreateFeatureGroupRequestRequestTypeDef = { # (1)
"FeatureGroupName": ...,
"RecordIdentifierFeatureName": ...,
"EventTimeFeatureName": ...,
"FeatureDefinitions": ...,
}
parent.create_feature_group(**kwargs)
create_flow_definition
Creates a flow definition.
Type annotations and code completion for boto3.client("sagemaker").create_flow_definition
method.
boto3 documentation
def create_flow_definition(
self,
*,
FlowDefinitionName: str,
HumanLoopConfig: HumanLoopConfigTypeDef, # (1)
OutputConfig: FlowDefinitionOutputConfigTypeDef, # (2)
RoleArn: str,
HumanLoopRequestSource: HumanLoopRequestSourceTypeDef = ..., # (3)
HumanLoopActivationConfig: HumanLoopActivationConfigTypeDef = ..., # (4)
Tags: Sequence[TagTypeDef] = ..., # (5)
) -> CreateFlowDefinitionResponseTypeDef: # (6)
...
- See HumanLoopConfigTypeDef
- See FlowDefinitionOutputConfigTypeDef
- See HumanLoopRequestSourceTypeDef
- See HumanLoopActivationConfigTypeDef
- See TagTypeDef
- See CreateFlowDefinitionResponseTypeDef
kwargs: CreateFlowDefinitionRequestRequestTypeDef = { # (1)
"FlowDefinitionName": ...,
"HumanLoopConfig": ...,
"OutputConfig": ...,
"RoleArn": ...,
}
parent.create_flow_definition(**kwargs)
create_hub
Create a hub.
Type annotations and code completion for boto3.client("sagemaker").create_hub
method.
boto3 documentation
def create_hub(
self,
*,
HubName: str,
HubDescription: str,
HubDisplayName: str = ...,
HubSearchKeywords: Sequence[str] = ...,
S3StorageConfig: HubS3StorageConfigTypeDef = ..., # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateHubResponseTypeDef: # (3)
...
kwargs: CreateHubRequestRequestTypeDef = { # (1)
"HubName": ...,
"HubDescription": ...,
}
parent.create_hub(**kwargs)
create_human_task_ui
Defines the settings you will use for the human review workflow user interface.
Type annotations and code completion for boto3.client("sagemaker").create_human_task_ui
method.
boto3 documentation