SageMakerClient

Index > SageMaker > 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

# SageMakerClient usage example

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.

# Exceptions.exceptions usage example

client = boto3.client("sagemaker")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.ResourceInUse,
    client.exceptions.ResourceLimitExceeded,
    client.exceptions.ResourceNotFound,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_sagemaker.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("sagemaker").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("sagemaker").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

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

# add_association method definition

def add_association(
    self,
    *,
    SourceArn: str,
    DestinationArn: str,
    AssociationType: AssociationEdgeTypeType = ...,  # (1)
) -> AddAssociationResponseTypeDef:  # (2)
    ...

1. See AssociationEdgeTypeType
2. See AddAssociationResponseTypeDef

# add_association method usage example with argument unpacking

kwargs: AddAssociationRequestTypeDef = {  # (1)
    "SourceArn": ...,
    "DestinationArn": ...,
}

parent.add_association(**kwargs)

1. See AddAssociationRequestTypeDef

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

# add_tags method definition

def add_tags(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> AddTagsOutputTypeDef:  # (2)
    ...

1. See Sequence[TagTypeDef]
2. See AddTagsOutputTypeDef

# add_tags method usage example with argument unpacking

kwargs: AddTagsInputTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.add_tags(**kwargs)

1. See AddTagsInputTypeDef

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

# associate_trial_component method definition

def associate_trial_component(
    self,
    *,
    TrialComponentName: str,
    TrialName: str,
) -> AssociateTrialComponentResponseTypeDef:  # (1)
    ...

1. See AssociateTrialComponentResponseTypeDef

# associate_trial_component method usage example with argument unpacking

kwargs: AssociateTrialComponentRequestTypeDef = {  # (1)
    "TrialComponentName": ...,
    "TrialName": ...,
}

parent.associate_trial_component(**kwargs)

1. See AssociateTrialComponentRequestTypeDef

batch_delete_cluster_nodes

Deletes specific nodes within a SageMaker HyperPod cluster.

Type annotations and code completion for boto3.client("sagemaker").batch_delete_cluster_nodes method. boto3 documentation

# batch_delete_cluster_nodes method definition

def batch_delete_cluster_nodes(
    self,
    *,
    ClusterName: str,
    NodeIds: Sequence[str],
) -> BatchDeleteClusterNodesResponseTypeDef:  # (1)
    ...

1. See BatchDeleteClusterNodesResponseTypeDef

# batch_delete_cluster_nodes method usage example with argument unpacking

kwargs: BatchDeleteClusterNodesRequestTypeDef = {  # (1)
    "ClusterName": ...,
    "NodeIds": ...,
}

parent.batch_delete_cluster_nodes(**kwargs)

1. See BatchDeleteClusterNodesRequestTypeDef

batch_describe_model_package

This action batch describes a list of versioned model packages.

Type annotations and code completion for boto3.client("sagemaker").batch_describe_model_package method. boto3 documentation

# batch_describe_model_package method definition

def batch_describe_model_package(
    self,
    *,
    ModelPackageArnList: Sequence[str],
) -> BatchDescribeModelPackageOutputTypeDef:  # (1)
    ...

1. See BatchDescribeModelPackageOutputTypeDef

# batch_describe_model_package method usage example with argument unpacking

kwargs: BatchDescribeModelPackageInputTypeDef = {  # (1)
    "ModelPackageArnList": ...,
}

parent.batch_describe_model_package(**kwargs)

1. See BatchDescribeModelPackageInputTypeDef

create_action

Creates an action.

Type annotations and code completion for boto3.client("sagemaker").create_action method. boto3 documentation

# create_action method definition

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)
    ...

1. See ActionSourceTypeDef
2. See ActionStatusType
3. See MetadataPropertiesTypeDef
4. See Sequence[TagTypeDef]
5. See CreateActionResponseTypeDef

# create_action method usage example with argument unpacking

kwargs: CreateActionRequestTypeDef = {  # (1)
    "ActionName": ...,
    "Source": ...,
    "ActionType": ...,
}

parent.create_action(**kwargs)

1. See CreateActionRequestTypeDef

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

# create_algorithm method definition

def create_algorithm(
    self,
    *,
    AlgorithmName: str,
    TrainingSpecification: TrainingSpecificationUnionTypeDef,  # (1)
    AlgorithmDescription: str = ...,
    InferenceSpecification: InferenceSpecificationUnionTypeDef = ...,  # (2)
    ValidationSpecification: AlgorithmValidationSpecificationUnionTypeDef = ...,  # (3)
    CertifyForMarketplace: bool = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (4)
) -> CreateAlgorithmOutputTypeDef:  # (5)
    ...

1. See TrainingSpecificationUnionTypeDef
2. See InferenceSpecificationUnionTypeDef
3. See AlgorithmValidationSpecificationUnionTypeDef
4. See Sequence[TagTypeDef]
5. See CreateAlgorithmOutputTypeDef

# create_algorithm method usage example with argument unpacking

kwargs: CreateAlgorithmInputTypeDef = {  # (1)
    "AlgorithmName": ...,
    "TrainingSpecification": ...,
}

parent.create_algorithm(**kwargs)

1. See CreateAlgorithmInputTypeDef

create_app

Creates a running app for the specified UserProfile.

Type annotations and code completion for boto3.client("sagemaker").create_app method. boto3 documentation

# create_app method definition

def create_app(
    self,
    *,
    DomainId: str,
    AppType: AppTypeType,  # (1)
    AppName: str,
    UserProfileName: str = ...,
    SpaceName: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    ResourceSpec: ResourceSpecTypeDef = ...,  # (3)
    RecoveryMode: bool = ...,
) -> CreateAppResponseTypeDef:  # (4)
    ...

1. See AppTypeType
2. See Sequence[TagTypeDef]
3. See ResourceSpecTypeDef
4. See CreateAppResponseTypeDef

# create_app method usage example with argument unpacking

kwargs: CreateAppRequestTypeDef = {  # (1)
    "DomainId": ...,
    "AppType": ...,
    "AppName": ...,
}

parent.create_app(**kwargs)

1. See CreateAppRequestTypeDef

create_app_image_config

Creates a configuration for running a SageMaker AI image as a KernelGateway app.

Type annotations and code completion for boto3.client("sagemaker").create_app_image_config method. boto3 documentation

# create_app_image_config method definition

def create_app_image_config(
    self,
    *,
    AppImageConfigName: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    KernelGatewayImageConfig: KernelGatewayImageConfigUnionTypeDef = ...,  # (2)
    JupyterLabAppImageConfig: JupyterLabAppImageConfigUnionTypeDef = ...,  # (3)
    CodeEditorAppImageConfig: CodeEditorAppImageConfigUnionTypeDef = ...,  # (4)
) -> CreateAppImageConfigResponseTypeDef:  # (5)
    ...

1. See Sequence[TagTypeDef]
2. See KernelGatewayImageConfigUnionTypeDef
3. See JupyterLabAppImageConfigUnionTypeDef
4. See CodeEditorAppImageConfigUnionTypeDef
5. See CreateAppImageConfigResponseTypeDef

# create_app_image_config method usage example with argument unpacking

kwargs: CreateAppImageConfigRequestTypeDef = {  # (1)
    "AppImageConfigName": ...,
}

parent.create_app_image_config(**kwargs)

1. See CreateAppImageConfigRequestTypeDef

create_artifact

Creates an artifact.

Type annotations and code completion for boto3.client("sagemaker").create_artifact method. boto3 documentation

# create_artifact method definition

def create_artifact(
    self,
    *,
    Source: ArtifactSourceUnionTypeDef,  # (1)
    ArtifactType: str,
    ArtifactName: str = ...,
    Properties: Mapping[str, str] = ...,
    MetadataProperties: MetadataPropertiesTypeDef = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateArtifactResponseTypeDef:  # (4)
    ...

1. See ArtifactSourceUnionTypeDef
2. See MetadataPropertiesTypeDef
3. See Sequence[TagTypeDef]
4. See CreateArtifactResponseTypeDef

# create_artifact method usage example with argument unpacking

kwargs: CreateArtifactRequestTypeDef = {  # (1)
    "Source": ...,
    "ArtifactType": ...,
}

parent.create_artifact(**kwargs)

1. See CreateArtifactRequestTypeDef

create_auto_ml_job

Creates an Autopilot job also referred to as Autopilot experiment or AutoML job.

Type annotations and code completion for boto3.client("sagemaker").create_auto_ml_job method. boto3 documentation

# create_auto_ml_job method definition

def create_auto_ml_job(
    self,
    *,
    AutoMLJobName: str,
    InputDataConfig: Sequence[AutoMLChannelTypeDef],  # (1)
    OutputDataConfig: AutoMLOutputDataConfigTypeDef,  # (2)
    RoleArn: str,
    ProblemType: ProblemTypeType = ...,  # (3)
    AutoMLJobObjective: AutoMLJobObjectiveTypeDef = ...,  # (4)
    AutoMLJobConfig: AutoMLJobConfigUnionTypeDef = ...,  # (5)
    GenerateCandidateDefinitionsOnly: bool = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (6)
    ModelDeployConfig: ModelDeployConfigTypeDef = ...,  # (7)
) -> CreateAutoMLJobResponseTypeDef:  # (8)
    ...

1. See Sequence[AutoMLChannelTypeDef]
2. See AutoMLOutputDataConfigTypeDef
3. See ProblemTypeType
4. See AutoMLJobObjectiveTypeDef
5. See AutoMLJobConfigUnionTypeDef
6. See Sequence[TagTypeDef]
7. See ModelDeployConfigTypeDef
8. See CreateAutoMLJobResponseTypeDef

# create_auto_ml_job method usage example with argument unpacking

kwargs: CreateAutoMLJobRequestTypeDef = {  # (1)
    "AutoMLJobName": ...,
    "InputDataConfig": ...,
    "OutputDataConfig": ...,
    "RoleArn": ...,
}

parent.create_auto_ml_job(**kwargs)

1. See CreateAutoMLJobRequestTypeDef

create_auto_ml_job_v2

Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2.

Type annotations and code completion for boto3.client("sagemaker").create_auto_ml_job_v2 method. boto3 documentation

# create_auto_ml_job_v2 method definition

def create_auto_ml_job_v2(
    self,
    *,
    AutoMLJobName: str,
    AutoMLJobInputDataConfig: Sequence[AutoMLJobChannelTypeDef],  # (1)
    OutputDataConfig: AutoMLOutputDataConfigTypeDef,  # (2)
    AutoMLProblemTypeConfig: AutoMLProblemTypeConfigUnionTypeDef,  # (3)
    RoleArn: str,
    Tags: Sequence[TagTypeDef] = ...,  # (4)
    SecurityConfig: AutoMLSecurityConfigUnionTypeDef = ...,  # (5)
    AutoMLJobObjective: AutoMLJobObjectiveTypeDef = ...,  # (6)
    ModelDeployConfig: ModelDeployConfigTypeDef = ...,  # (7)
    DataSplitConfig: AutoMLDataSplitConfigTypeDef = ...,  # (8)
    AutoMLComputeConfig: AutoMLComputeConfigTypeDef = ...,  # (9)
) -> CreateAutoMLJobV2ResponseTypeDef:  # (10)
    ...

1. See Sequence[AutoMLJobChannelTypeDef]
2. See AutoMLOutputDataConfigTypeDef
3. See AutoMLProblemTypeConfigUnionTypeDef
4. See Sequence[TagTypeDef]
5. See AutoMLSecurityConfigUnionTypeDef
6. See AutoMLJobObjectiveTypeDef
7. See ModelDeployConfigTypeDef
8. See AutoMLDataSplitConfigTypeDef
9. See AutoMLComputeConfigTypeDef
10. See CreateAutoMLJobV2ResponseTypeDef

# create_auto_ml_job_v2 method usage example with argument unpacking

kwargs: CreateAutoMLJobV2RequestTypeDef = {  # (1)
    "AutoMLJobName": ...,
    "AutoMLJobInputDataConfig": ...,
    "OutputDataConfig": ...,
    "AutoMLProblemTypeConfig": ...,
    "RoleArn": ...,
}

parent.create_auto_ml_job_v2(**kwargs)

1. See CreateAutoMLJobV2RequestTypeDef

create_cluster

Creates a SageMaker HyperPod cluster.

Type annotations and code completion for boto3.client("sagemaker").create_cluster method. boto3 documentation

# create_cluster method definition

def create_cluster(
    self,
    *,
    ClusterName: str,
    InstanceGroups: Sequence[ClusterInstanceGroupSpecificationTypeDef] = ...,  # (1)
    VpcConfig: VpcConfigUnionTypeDef = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
    Orchestrator: ClusterOrchestratorTypeDef = ...,  # (4)
    NodeRecovery: ClusterNodeRecoveryType = ...,  # (5)
) -> CreateClusterResponseTypeDef:  # (6)
    ...

1. See Sequence[ClusterInstanceGroupSpecificationTypeDef]
2. See VpcConfigUnionTypeDef
3. See Sequence[TagTypeDef]
4. See ClusterOrchestratorTypeDef
5. See ClusterNodeRecoveryType
6. See CreateClusterResponseTypeDef

# create_cluster method usage example with argument unpacking

kwargs: CreateClusterRequestTypeDef = {  # (1)
    "ClusterName": ...,
}

parent.create_cluster(**kwargs)

1. See CreateClusterRequestTypeDef

create_cluster_scheduler_config

Create cluster policy configuration.

Type annotations and code completion for boto3.client("sagemaker").create_cluster_scheduler_config method. boto3 documentation

# create_cluster_scheduler_config method definition

def create_cluster_scheduler_config(
    self,
    *,
    Name: str,
    ClusterArn: str,
    SchedulerConfig: SchedulerConfigUnionTypeDef,  # (1)
    Description: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateClusterSchedulerConfigResponseTypeDef:  # (3)
    ...

1. See SchedulerConfigUnionTypeDef
2. See Sequence[TagTypeDef]
3. See CreateClusterSchedulerConfigResponseTypeDef

# create_cluster_scheduler_config method usage example with argument unpacking

kwargs: CreateClusterSchedulerConfigRequestTypeDef = {  # (1)
    "Name": ...,
    "ClusterArn": ...,
    "SchedulerConfig": ...,
}

parent.create_cluster_scheduler_config(**kwargs)

1. See CreateClusterSchedulerConfigRequestTypeDef

create_code_repository

Creates a Git repository as a resource in your SageMaker AI account.

Type annotations and code completion for boto3.client("sagemaker").create_code_repository method. boto3 documentation

# create_code_repository method definition

def create_code_repository(
    self,
    *,
    CodeRepositoryName: str,
    GitConfig: GitConfigTypeDef,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateCodeRepositoryOutputTypeDef:  # (3)
    ...

1. See GitConfigTypeDef
2. See Sequence[TagTypeDef]
3. See CreateCodeRepositoryOutputTypeDef

# create_code_repository method usage example with argument unpacking

kwargs: CreateCodeRepositoryInputTypeDef = {  # (1)
    "CodeRepositoryName": ...,
    "GitConfig": ...,
}

parent.create_code_repository(**kwargs)

1. See CreateCodeRepositoryInputTypeDef

create_compilation_job

Starts a model compilation job.

Type annotations and code completion for boto3.client("sagemaker").create_compilation_job method. boto3 documentation

# create_compilation_job method definition

def create_compilation_job(
    self,
    *,
    CompilationJobName: str,
    RoleArn: str,
    OutputConfig: OutputConfigTypeDef,  # (1)
    StoppingCondition: StoppingConditionTypeDef,  # (2)
    ModelPackageVersionArn: str = ...,
    InputConfig: InputConfigTypeDef = ...,  # (3)
    VpcConfig: NeoVpcConfigUnionTypeDef = ...,  # (4)
    Tags: Sequence[TagTypeDef] = ...,  # (5)
) -> CreateCompilationJobResponseTypeDef:  # (6)
    ...

1. See OutputConfigTypeDef
2. See StoppingConditionTypeDef
3. See InputConfigTypeDef
4. See NeoVpcConfigUnionTypeDef
5. See Sequence[TagTypeDef]
6. See CreateCompilationJobResponseTypeDef

# create_compilation_job method usage example with argument unpacking

kwargs: CreateCompilationJobRequestTypeDef = {  # (1)
    "CompilationJobName": ...,
    "RoleArn": ...,
    "OutputConfig": ...,
    "StoppingCondition": ...,
}

parent.create_compilation_job(**kwargs)

1. See CreateCompilationJobRequestTypeDef

create_compute_quota

Create compute allocation definition.

Type annotations and code completion for boto3.client("sagemaker").create_compute_quota method. boto3 documentation

# create_compute_quota method definition

def create_compute_quota(
    self,
    *,
    Name: str,
    ClusterArn: str,
    ComputeQuotaConfig: ComputeQuotaConfigUnionTypeDef,  # (1)
    ComputeQuotaTarget: ComputeQuotaTargetTypeDef,  # (2)
    Description: str = ...,
    ActivationState: ActivationStateType = ...,  # (3)
    Tags: Sequence[TagTypeDef] = ...,  # (4)
) -> CreateComputeQuotaResponseTypeDef:  # (5)
    ...

1. See ComputeQuotaConfigUnionTypeDef
2. See ComputeQuotaTargetTypeDef
3. See ActivationStateType
4. See Sequence[TagTypeDef]
5. See CreateComputeQuotaResponseTypeDef

# create_compute_quota method usage example with argument unpacking

kwargs: CreateComputeQuotaRequestTypeDef = {  # (1)
    "Name": ...,
    "ClusterArn": ...,
    "ComputeQuotaConfig": ...,
    "ComputeQuotaTarget": ...,
}

parent.create_compute_quota(**kwargs)

1. See CreateComputeQuotaRequestTypeDef

create_context

Creates a context.

Type annotations and code completion for boto3.client("sagemaker").create_context method. boto3 documentation

# create_context method definition

def create_context(
    self,
    *,
    ContextName: str,
    Source: ContextSourceTypeDef,  # (1)
    ContextType: str,
    Description: str = ...,
    Properties: Mapping[str, str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateContextResponseTypeDef:  # (3)
    ...

1. See ContextSourceTypeDef
2. See Sequence[TagTypeDef]
3. See CreateContextResponseTypeDef

# create_context method usage example with argument unpacking

kwargs: CreateContextRequestTypeDef = {  # (1)
    "ContextName": ...,
    "Source": ...,
    "ContextType": ...,
}

parent.create_context(**kwargs)

1. See CreateContextRequestTypeDef

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

# create_data_quality_job_definition method definition

def create_data_quality_job_definition(
    self,
    *,
    JobDefinitionName: str,
    DataQualityAppSpecification: DataQualityAppSpecificationUnionTypeDef,  # (1)
    DataQualityJobInput: DataQualityJobInputUnionTypeDef,  # (2)
    DataQualityJobOutputConfig: MonitoringOutputConfigUnionTypeDef,  # (3)
    JobResources: MonitoringResourcesTypeDef,  # (4)
    RoleArn: str,
    DataQualityBaselineConfig: DataQualityBaselineConfigTypeDef = ...,  # (5)
    NetworkConfig: MonitoringNetworkConfigUnionTypeDef = ...,  # (6)
    StoppingCondition: MonitoringStoppingConditionTypeDef = ...,  # (7)
    Tags: Sequence[TagTypeDef] = ...,  # (8)
) -> CreateDataQualityJobDefinitionResponseTypeDef:  # (9)
    ...

1. See DataQualityAppSpecificationUnionTypeDef
2. See DataQualityJobInputUnionTypeDef
3. See MonitoringOutputConfigUnionTypeDef
4. See MonitoringResourcesTypeDef
5. See DataQualityBaselineConfigTypeDef
6. See MonitoringNetworkConfigUnionTypeDef
7. See MonitoringStoppingConditionTypeDef
8. See Sequence[TagTypeDef]
9. See CreateDataQualityJobDefinitionResponseTypeDef

# create_data_quality_job_definition method usage example with argument unpacking

kwargs: CreateDataQualityJobDefinitionRequestTypeDef = {  # (1)
    "JobDefinitionName": ...,
    "DataQualityAppSpecification": ...,
    "DataQualityJobInput": ...,
    "DataQualityJobOutputConfig": ...,
    "JobResources": ...,
    "RoleArn": ...,
}

parent.create_data_quality_job_definition(**kwargs)

1. See CreateDataQualityJobDefinitionRequestTypeDef

create_device_fleet

Creates a device fleet.

Type annotations and code completion for boto3.client("sagemaker").create_device_fleet method. boto3 documentation

# create_device_fleet method definition

def create_device_fleet(
    self,
    *,
    DeviceFleetName: str,
    OutputConfig: EdgeOutputConfigTypeDef,  # (1)
    RoleArn: str = ...,
    Description: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    EnableIotRoleAlias: bool = ...,
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...

1. See EdgeOutputConfigTypeDef
2. See Sequence[TagTypeDef]
3. See EmptyResponseMetadataTypeDef

# create_device_fleet method usage example with argument unpacking

kwargs: CreateDeviceFleetRequestTypeDef = {  # (1)
    "DeviceFleetName": ...,
    "OutputConfig": ...,
}

parent.create_device_fleet(**kwargs)

1. See CreateDeviceFleetRequestTypeDef

create_domain

Creates a Domain.

Type annotations and code completion for boto3.client("sagemaker").create_domain method. boto3 documentation

# create_domain method definition

def create_domain(
    self,
    *,
    DomainName: str,
    AuthMode: AuthModeType,  # (1)
    DefaultUserSettings: UserSettingsUnionTypeDef,  # (2)
    DomainSettings: DomainSettingsUnionTypeDef = ...,  # (3)
    SubnetIds: Sequence[str] = ...,
    VpcId: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (4)
    AppNetworkAccessType: AppNetworkAccessTypeType = ...,  # (5)
    HomeEfsFileSystemKmsKeyId: str = ...,
    KmsKeyId: str = ...,
    AppSecurityGroupManagement: AppSecurityGroupManagementType = ...,  # (6)
    TagPropagation: TagPropagationType = ...,  # (7)
    DefaultSpaceSettings: DefaultSpaceSettingsUnionTypeDef = ...,  # (8)
) -> CreateDomainResponseTypeDef:  # (9)
    ...

1. See AuthModeType
2. See UserSettingsUnionTypeDef
3. See DomainSettingsUnionTypeDef
4. See Sequence[TagTypeDef]
5. See AppNetworkAccessTypeType
6. See AppSecurityGroupManagementType
7. See TagPropagationType
8. See DefaultSpaceSettingsUnionTypeDef
9. See CreateDomainResponseTypeDef

# create_domain method usage example with argument unpacking

kwargs: CreateDomainRequestTypeDef = {  # (1)
    "DomainName": ...,
    "AuthMode": ...,
    "DefaultUserSettings": ...,
}

parent.create_domain(**kwargs)

1. See CreateDomainRequestTypeDef

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

# create_edge_deployment_plan method definition

def create_edge_deployment_plan(
    self,
    *,
    EdgeDeploymentPlanName: str,
    ModelConfigs: Sequence[EdgeDeploymentModelConfigTypeDef],  # (1)
    DeviceFleetName: str,
    Stages: Sequence[DeploymentStageTypeDef] = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateEdgeDeploymentPlanResponseTypeDef:  # (4)
    ...

1. See Sequence[EdgeDeploymentModelConfigTypeDef]
2. See Sequence[DeploymentStageTypeDef]
3. See Sequence[TagTypeDef]
4. See CreateEdgeDeploymentPlanResponseTypeDef

# create_edge_deployment_plan method usage example with argument unpacking

kwargs: CreateEdgeDeploymentPlanRequestTypeDef = {  # (1)
    "EdgeDeploymentPlanName": ...,
    "ModelConfigs": ...,
    "DeviceFleetName": ...,
}

parent.create_edge_deployment_plan(**kwargs)

1. See CreateEdgeDeploymentPlanRequestTypeDef

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

# create_edge_deployment_stage method definition

def create_edge_deployment_stage(
    self,
    *,
    EdgeDeploymentPlanName: str,
    Stages: Sequence[DeploymentStageTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See Sequence[DeploymentStageTypeDef]
2. See EmptyResponseMetadataTypeDef

# create_edge_deployment_stage method usage example with argument unpacking

kwargs: CreateEdgeDeploymentStageRequestTypeDef = {  # (1)
    "EdgeDeploymentPlanName": ...,
    "Stages": ...,
}

parent.create_edge_deployment_stage(**kwargs)

1. See CreateEdgeDeploymentStageRequestTypeDef

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

# create_edge_packaging_job method definition

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)
    ...

1. See EdgeOutputConfigTypeDef
2. See Sequence[TagTypeDef]
3. See EmptyResponseMetadataTypeDef

# create_edge_packaging_job method usage example with argument unpacking

kwargs: CreateEdgePackagingJobRequestTypeDef = {  # (1)
    "EdgePackagingJobName": ...,
    "CompilationJobName": ...,
    "ModelName": ...,
    "ModelVersion": ...,
    "RoleArn": ...,
    "OutputConfig": ...,
}

parent.create_edge_packaging_job(**kwargs)

1. See CreateEdgePackagingJobRequestTypeDef

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

# create_endpoint method definition

def create_endpoint(
    self,
    *,
    EndpointName: str,
    EndpointConfigName: str,
    DeploymentConfig: DeploymentConfigUnionTypeDef = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateEndpointOutputTypeDef:  # (3)
    ...

1. See DeploymentConfigUnionTypeDef
2. See Sequence[TagTypeDef]
3. See CreateEndpointOutputTypeDef

# create_endpoint method usage example with argument unpacking

kwargs: CreateEndpointInputTypeDef = {  # (1)
    "EndpointName": ...,
    "EndpointConfigName": ...,
}

parent.create_endpoint(**kwargs)

1. See CreateEndpointInputTypeDef

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

# create_endpoint_config method definition

def create_endpoint_config(
    self,
    *,
    EndpointConfigName: str,
    ProductionVariants: Sequence[ProductionVariantTypeDef],  # (1)
    DataCaptureConfig: DataCaptureConfigUnionTypeDef = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
    KmsKeyId: str = ...,
    AsyncInferenceConfig: AsyncInferenceConfigUnionTypeDef = ...,  # (4)
    ExplainerConfig: ExplainerConfigUnionTypeDef = ...,  # (5)
    ShadowProductionVariants: Sequence[ProductionVariantTypeDef] = ...,  # (1)
    ExecutionRoleArn: str = ...,
    VpcConfig: VpcConfigUnionTypeDef = ...,  # (7)
    EnableNetworkIsolation: bool = ...,
) -> CreateEndpointConfigOutputTypeDef:  # (8)
    ...

1. See Sequence[ProductionVariantTypeDef]
2. See DataCaptureConfigUnionTypeDef
3. See Sequence[TagTypeDef]
4. See AsyncInferenceConfigUnionTypeDef
5. See ExplainerConfigUnionTypeDef
6. See Sequence[ProductionVariantTypeDef]
7. See VpcConfigUnionTypeDef
8. See CreateEndpointConfigOutputTypeDef

# create_endpoint_config method usage example with argument unpacking

kwargs: CreateEndpointConfigInputTypeDef = {  # (1)
    "EndpointConfigName": ...,
    "ProductionVariants": ...,
}

parent.create_endpoint_config(**kwargs)

1. See CreateEndpointConfigInputTypeDef

create_experiment

Creates a SageMaker experiment.

Type annotations and code completion for boto3.client("sagemaker").create_experiment method. boto3 documentation

# create_experiment method definition

def create_experiment(
    self,
    *,
    ExperimentName: str,
    DisplayName: str = ...,
    Description: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateExperimentResponseTypeDef:  # (2)
    ...

1. See Sequence[TagTypeDef]
2. See CreateExperimentResponseTypeDef

# create_experiment method usage example with argument unpacking

kwargs: CreateExperimentRequestTypeDef = {  # (1)
    "ExperimentName": ...,
}

parent.create_experiment(**kwargs)

1. See CreateExperimentRequestTypeDef

create_feature_group

Create a new FeatureGroup.

Type annotations and code completion for boto3.client("sagemaker").create_feature_group method. boto3 documentation

# create_feature_group method definition

def create_feature_group(
    self,
    *,
    FeatureGroupName: str,
    RecordIdentifierFeatureName: str,
    EventTimeFeatureName: str,
    FeatureDefinitions: Sequence[FeatureDefinitionTypeDef],  # (1)
    OnlineStoreConfig: OnlineStoreConfigTypeDef = ...,  # (2)
    OfflineStoreConfig: OfflineStoreConfigTypeDef = ...,  # (3)
    ThroughputConfig: ThroughputConfigTypeDef = ...,  # (4)
    RoleArn: str = ...,
    Description: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (5)
) -> CreateFeatureGroupResponseTypeDef:  # (6)
    ...

1. See Sequence[FeatureDefinitionTypeDef]
2. See OnlineStoreConfigTypeDef
3. See OfflineStoreConfigTypeDef
4. See ThroughputConfigTypeDef
5. See Sequence[TagTypeDef]
6. See CreateFeatureGroupResponseTypeDef

# create_feature_group method usage example with argument unpacking

kwargs: CreateFeatureGroupRequestTypeDef = {  # (1)
    "FeatureGroupName": ...,
    "RecordIdentifierFeatureName": ...,
    "EventTimeFeatureName": ...,
    "FeatureDefinitions": ...,
}

parent.create_feature_group(**kwargs)

1. See CreateFeatureGroupRequestTypeDef

create_flow_definition

Creates a flow definition.

Type annotations and code completion for boto3.client("sagemaker").create_flow_definition method. boto3 documentation

# create_flow_definition method definition

def create_flow_definition(
    self,
    *,
    FlowDefinitionName: str,
    OutputConfig: FlowDefinitionOutputConfigTypeDef,  # (1)
    RoleArn: str,
    HumanLoopRequestSource: HumanLoopRequestSourceTypeDef = ...,  # (2)
    HumanLoopActivationConfig: HumanLoopActivationConfigTypeDef = ...,  # (3)
    HumanLoopConfig: HumanLoopConfigUnionTypeDef = ...,  # (4)
    Tags: Sequence[TagTypeDef] = ...,  # (5)
) -> CreateFlowDefinitionResponseTypeDef:  # (6)
    ...

1. See FlowDefinitionOutputConfigTypeDef
2. See HumanLoopRequestSourceTypeDef
3. See HumanLoopActivationConfigTypeDef
4. See HumanLoopConfigUnionTypeDef
5. See Sequence[TagTypeDef]
6. See CreateFlowDefinitionResponseTypeDef

# create_flow_definition method usage example with argument unpacking

kwargs: CreateFlowDefinitionRequestTypeDef = {  # (1)
    "FlowDefinitionName": ...,
    "OutputConfig": ...,
    "RoleArn": ...,
}

parent.create_flow_definition(**kwargs)

1. See CreateFlowDefinitionRequestTypeDef

create_hub

Create a hub.

Type annotations and code completion for boto3.client("sagemaker").create_hub method. boto3 documentation

# create_hub method definition

def create_hub(
    self,
    *,
    HubName: str,
    HubDescription: str,
    HubDisplayName: str = ...,
    HubSearchKeywords: Sequence[str] = ...,
    S3StorageConfig: HubS3StorageConfigTypeDef = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateHubResponseTypeDef:  # (3)
    ...

1. See HubS3StorageConfigTypeDef
2. See Sequence[TagTypeDef]
3. See CreateHubResponseTypeDef

# create_hub method usage example with argument unpacking

kwargs: CreateHubRequestTypeDef = {  # (1)
    "HubName": ...,
    "HubDescription": ...,
}

parent.create_hub(**kwargs)

1. See CreateHubRequestTypeDef

create_hub_content_presigned_urls

Creates presigned URLs for accessing hub content artifacts.

Type annotations and code completion for boto3.client("sagemaker").create_hub_content_presigned_urls method. boto3 documentation

# create_hub_content_presigned_urls method definition

def create_hub_content_presigned_urls(
    self,
    *,
    HubName: str,
    HubContentType: HubContentTypeType,  # (1)
    HubContentName: str,
    HubContentVersion: str = ...,
    AccessConfig: PresignedUrlAccessConfigTypeDef = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> CreateHubContentPresignedUrlsResponseTypeDef:  # (3)
    ...

1. See HubContentTypeType
2. See PresignedUrlAccessConfigTypeDef
3. See CreateHubContentPresignedUrlsResponseTypeDef

# create_hub_content_presigned_urls method usage example with argument unpacking

kwargs: CreateHubContentPresignedUrlsRequestTypeDef = {  # (1)
    "HubName": ...,
    "HubContentType": ...,
    "HubContentName": ...,
}

parent.create_hub_content_presigned_urls(**kwargs)

1. See CreateHubContentPresignedUrlsRequestTypeDef

create_hub_content_reference

Create a hub content reference in order to add a model in the JumpStart public hub to a private hub.

Type annotations and code completion for boto3.client("sagemaker").create_hub_content_reference method. boto3 documentation

# create_hub_content_reference method definition

def create_hub_content_reference(
    self,
    *,
    HubName: str,
    SageMakerPublicHubContentArn: str,
    HubContentName: str = ...,
    MinVersion: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateHubContentReferenceResponseTypeDef:  # (2)
    ...

1. See Sequence[TagTypeDef]
2. See CreateHubContentReferenceResponseTypeDef

# create_hub_content_reference method usage example with argument unpacking

kwargs: CreateHubContentReferenceRequestTypeDef = {  # (1)
    "HubName": ...,
    "SageMakerPublicHubContentArn": ...,
}

parent.create_hub_content_reference(**kwargs)

1. See CreateHubContentReferenceRequestTypeDef

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

# create_human_task_ui method definition

def create_human_task_ui(
    self,
    *,
    HumanTaskUiName: str,
    UiTemplate: UiTemplateTypeDef,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateHumanTaskUiResponseTypeDef:  # (3)
    ...

1. See UiTemplateTypeDef
2. See Sequence[TagTypeDef]
3. See CreateHumanTaskUiResponseTypeDef

# create_human_task_ui method usage example with argument unpacking

kwargs: CreateHumanTaskUiRequestTypeDef = {  # (1)
    "HumanTaskUiName": ...,
    "UiTemplate": ...,
}

parent.create_human_task_ui(**kwargs)

1. See CreateHumanTaskUiRequestTypeDef

create_hyper_parameter_tuning_job

Starts a hyperparameter tuning job.

Type annotations and code completion for boto3.client("sagemaker").create_hyper_parameter_tuning_job method. boto3 documentation

# create_hyper_parameter_tuning_job method definition

def create_hyper_parameter_tuning_job(
    self,
    *,
    HyperParameterTuningJobName: str,
    HyperParameterTuningJobConfig: HyperParameterTuningJobConfigUnionTypeDef,  # (1)
    TrainingJobDefinition: HyperParameterTrainingJobDefinitionUnionTypeDef = ...,  # (2)
    TrainingJobDefinitions: Sequence[HyperParameterTrainingJobDefinitionUnionTypeDef] = ...,  # (3)
    WarmStartConfig: HyperParameterTuningJobWarmStartConfigUnionTypeDef = ...,  # (4)
    Tags: Sequence[TagTypeDef] = ...,  # (5)
    Autotune: AutotuneTypeDef = ...,  # (6)
) -> CreateHyperParameterTuningJobResponseTypeDef:  # (7)
    ...

1. See HyperParameterTuningJobConfigUnionTypeDef
2. See HyperParameterTrainingJobDefinitionUnionTypeDef
3. See Sequence[HyperParameterTrainingJobDefinitionUnionTypeDef]
4. See HyperParameterTuningJobWarmStartConfigUnionTypeDef
5. See Sequence[TagTypeDef]
6. See AutotuneTypeDef
7. See CreateHyperParameterTuningJobResponseTypeDef

# create_hyper_parameter_tuning_job method usage example with argument unpacking

kwargs: CreateHyperParameterTuningJobRequestTypeDef = {  # (1)
    "HyperParameterTuningJobName": ...,
    "HyperParameterTuningJobConfig": ...,
}

parent.create_hyper_parameter_tuning_job(**kwargs)

1. See CreateHyperParameterTuningJobRequestTypeDef

create_image

Creates a custom SageMaker AI image.

Type annotations and code completion for boto3.client("sagemaker").create_image method. boto3 documentation

# create_image method definition

def create_image(
    self,
    *,
    ImageName: str,
    RoleArn: str,
    Description: str = ...,
    DisplayName: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateImageResponseTypeDef:  # (2)
    ...

1. See Sequence[TagTypeDef]
2. See CreateImageResponseTypeDef

# create_image method usage example with argument unpacking

kwargs: CreateImageRequestTypeDef = {  # (1)
    "ImageName": ...,
    "RoleArn": ...,
}

parent.create_image(**kwargs)

1. See CreateImageRequestTypeDef

create_image_version

Creates a version of the SageMaker AI image specified by ImageName.

Type annotations and code completion for boto3.client("sagemaker").create_image_version method. boto3 documentation

# create_image_version method definition

def create_image_version(
    self,
    *,
    BaseImage: str,
    ClientToken: str,
    ImageName: str,
    Aliases: Sequence[str] = ...,
    VendorGuidance: VendorGuidanceType = ...,  # (1)
    JobType: JobTypeType = ...,  # (2)
    MLFramework: str = ...,
    ProgrammingLang: str = ...,
    Processor: ProcessorType = ...,  # (3)
    Horovod: bool = ...,
    ReleaseNotes: str = ...,
) -> CreateImageVersionResponseTypeDef:  # (4)
    ...

1. See VendorGuidanceType
2. See JobTypeType
3. See ProcessorType
4. See CreateImageVersionResponseTypeDef

# create_image_version method usage example with argument unpacking

kwargs: CreateImageVersionRequestTypeDef = {  # (1)
    "BaseImage": ...,
    "ClientToken": ...,
    "ImageName": ...,
}

parent.create_image_version(**kwargs)

1. See CreateImageVersionRequestTypeDef

create_inference_component

Creates an inference component, which is a SageMaker AI hosting object that you can use to deploy a model to an endpoint.

Type annotations and code completion for boto3.client("sagemaker").create_inference_component method. boto3 documentation

# create_inference_component method definition

def create_inference_component(
    self,
    *,
    InferenceComponentName: str,
    EndpointName: str,
    Specification: InferenceComponentSpecificationTypeDef,  # (1)
    VariantName: str = ...,
    RuntimeConfig: InferenceComponentRuntimeConfigTypeDef = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateInferenceComponentOutputTypeDef:  # (4)
    ...

1. See InferenceComponentSpecificationTypeDef
2. See InferenceComponentRuntimeConfigTypeDef
3. See Sequence[TagTypeDef]
4. See CreateInferenceComponentOutputTypeDef

# create_inference_component method usage example with argument unpacking

kwargs: CreateInferenceComponentInputTypeDef = {  # (1)
    "InferenceComponentName": ...,
    "EndpointName": ...,
    "Specification": ...,
}

parent.create_inference_component(**kwargs)

1. See CreateInferenceComponentInputTypeDef

create_inference_experiment

Creates an inference experiment using the configurations specified in the request.

Type annotations and code completion for boto3.client("sagemaker").create_inference_experiment method. boto3 documentation

# create_inference_experiment method definition

def create_inference_experiment(
    self,
    *,
    Name: str,
    Type: InferenceExperimentTypeType,  # (1)
    RoleArn: str,
    EndpointName: str,
    ModelVariants: Sequence[ModelVariantConfigTypeDef],  # (2)
    ShadowModeConfig: ShadowModeConfigUnionTypeDef,  # (3)
    Schedule: InferenceExperimentScheduleUnionTypeDef = ...,  # (4)
    Description: str = ...,
    DataStorageConfig: InferenceExperimentDataStorageConfigUnionTypeDef = ...,  # (5)
    KmsKey: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (6)
) -> CreateInferenceExperimentResponseTypeDef:  # (7)
    ...

1. See InferenceExperimentTypeType
2. See Sequence[ModelVariantConfigTypeDef]
3. See ShadowModeConfigUnionTypeDef
4. See InferenceExperimentScheduleUnionTypeDef
5. See InferenceExperimentDataStorageConfigUnionTypeDef
6. See Sequence[TagTypeDef]
7. See CreateInferenceExperimentResponseTypeDef

# create_inference_experiment method usage example with argument unpacking

kwargs: CreateInferenceExperimentRequestTypeDef = {  # (1)
    "Name": ...,
    "Type": ...,
    "RoleArn": ...,
    "EndpointName": ...,
    "ModelVariants": ...,
    "ShadowModeConfig": ...,
}

parent.create_inference_experiment(**kwargs)

1. See CreateInferenceExperimentRequestTypeDef

create_inference_recommendations_job

Starts a recommendation job.

Type annotations and code completion for boto3.client("sagemaker").create_inference_recommendations_job method. boto3 documentation

# create_inference_recommendations_job method definition

def create_inference_recommendations_job(
    self,
    *,
    JobName: str,
    JobType: RecommendationJobTypeType,  # (1)
    RoleArn: str,
    InputConfig: RecommendationJobInputConfigUnionTypeDef,  # (2)
    JobDescription: str = ...,
    StoppingConditions: RecommendationJobStoppingConditionsUnionTypeDef = ...,  # (3)
    OutputConfig: RecommendationJobOutputConfigTypeDef = ...,  # (4)
    Tags: Sequence[TagTypeDef] = ...,  # (5)
) -> CreateInferenceRecommendationsJobResponseTypeDef:  # (6)
    ...

1. See RecommendationJobTypeType
2. See RecommendationJobInputConfigUnionTypeDef
3. See RecommendationJobStoppingConditionsUnionTypeDef
4. See RecommendationJobOutputConfigTypeDef
5. See Sequence[TagTypeDef]
6. See CreateInferenceRecommendationsJobResponseTypeDef

# create_inference_recommendations_job method usage example with argument unpacking

kwargs: CreateInferenceRecommendationsJobRequestTypeDef = {  # (1)
    "JobName": ...,
    "JobType": ...,
    "RoleArn": ...,
    "InputConfig": ...,
}

parent.create_inference_recommendations_job(**kwargs)

1. See CreateInferenceRecommendationsJobRequestTypeDef

create_labeling_job

Creates a job that uses workers to label the data objects in your input dataset.

Type annotations and code completion for boto3.client("sagemaker").create_labeling_job method. boto3 documentation

# create_labeling_job method definition

def create_labeling_job(
    self,
    *,
    LabelingJobName: str,
    LabelAttributeName: str,
    InputConfig: LabelingJobInputConfigUnionTypeDef,  # (1)
    OutputConfig: LabelingJobOutputConfigTypeDef,  # (2)
    RoleArn: str,
    HumanTaskConfig: HumanTaskConfigUnionTypeDef,  # (3)
    LabelCategoryConfigS3Uri: str = ...,
    StoppingConditions: LabelingJobStoppingConditionsTypeDef = ...,  # (4)
    LabelingJobAlgorithmsConfig: LabelingJobAlgorithmsConfigUnionTypeDef = ...,  # (5)
    Tags: Sequence[TagTypeDef] = ...,  # (6)
) -> CreateLabelingJobResponseTypeDef:  # (7)
    ...

1. See LabelingJobInputConfigUnionTypeDef
2. See LabelingJobOutputConfigTypeDef
3. See HumanTaskConfigUnionTypeDef
4. See LabelingJobStoppingConditionsTypeDef
5. See LabelingJobAlgorithmsConfigUnionTypeDef
6. See Sequence[TagTypeDef]
7. See CreateLabelingJobResponseTypeDef

# create_labeling_job method usage example with argument unpacking

kwargs: CreateLabelingJobRequestTypeDef = {  # (1)
    "LabelingJobName": ...,
    "LabelAttributeName": ...,
    "InputConfig": ...,
    "OutputConfig": ...,
    "RoleArn": ...,
    "HumanTaskConfig": ...,
}

parent.create_labeling_job(**kwargs)

1. See CreateLabelingJobRequestTypeDef

create_mlflow_tracking_server

Creates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact store.

Type annotations and code completion for boto3.client("sagemaker").create_mlflow_tracking_server method. boto3 documentation

# create_mlflow_tracking_server method definition

def create_mlflow_tracking_server(
    self,
    *,
    TrackingServerName: str,
    ArtifactStoreUri: str,
    RoleArn: str,
    TrackingServerSize: TrackingServerSizeType = ...,  # (1)
    MlflowVersion: str = ...,
    AutomaticModelRegistration: bool = ...,
    WeeklyMaintenanceWindowStart: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateMlflowTrackingServerResponseTypeDef:  # (3)
    ...

1. See TrackingServerSizeType
2. See Sequence[TagTypeDef]
3. See CreateMlflowTrackingServerResponseTypeDef

# create_mlflow_tracking_server method usage example with argument unpacking

kwargs: CreateMlflowTrackingServerRequestTypeDef = {  # (1)
    "TrackingServerName": ...,
    "ArtifactStoreUri": ...,
    "RoleArn": ...,
}

parent.create_mlflow_tracking_server(**kwargs)

1. See CreateMlflowTrackingServerRequestTypeDef

create_model

Creates a model in SageMaker.

Type annotations and code completion for boto3.client("sagemaker").create_model method. boto3 documentation

# create_model method definition

def create_model(
    self,
    *,
    ModelName: str,
    PrimaryContainer: ContainerDefinitionUnionTypeDef = ...,  # (1)
    Containers: Sequence[ContainerDefinitionUnionTypeDef] = ...,  # (2)
    InferenceExecutionConfig: InferenceExecutionConfigTypeDef = ...,  # (3)
    ExecutionRoleArn: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (4)
    VpcConfig: VpcConfigUnionTypeDef = ...,  # (5)
    EnableNetworkIsolation: bool = ...,
) -> CreateModelOutputTypeDef:  # (6)
    ...

1. See ContainerDefinitionUnionTypeDef
2. See Sequence[ContainerDefinitionUnionTypeDef]
3. See InferenceExecutionConfigTypeDef
4. See Sequence[TagTypeDef]
5. See VpcConfigUnionTypeDef
6. See CreateModelOutputTypeDef

# create_model method usage example with argument unpacking

kwargs: CreateModelInputTypeDef = {  # (1)
    "ModelName": ...,
}

parent.create_model(**kwargs)

1. See CreateModelInputTypeDef

create_model_bias_job_definition

Creates the definition for a model bias job.

Type annotations and code completion for boto3.client("sagemaker").create_model_bias_job_definition method. boto3 documentation

# create_model_bias_job_definition method definition

def create_model_bias_job_definition(
    self,
    *,
    JobDefinitionName: str,
    ModelBiasAppSpecification: ModelBiasAppSpecificationUnionTypeDef,  # (1)
    ModelBiasJobInput: ModelBiasJobInputUnionTypeDef,  # (2)
    ModelBiasJobOutputConfig: MonitoringOutputConfigUnionTypeDef,  # (3)
    JobResources: MonitoringResourcesTypeDef,  # (4)
    RoleArn: str,
    ModelBiasBaselineConfig: ModelBiasBaselineConfigTypeDef = ...,  # (5)
    NetworkConfig: MonitoringNetworkConfigUnionTypeDef = ...,  # (6)
    StoppingCondition: MonitoringStoppingConditionTypeDef = ...,  # (7)
    Tags: Sequence[TagTypeDef] = ...,  # (8)
) -> CreateModelBiasJobDefinitionResponseTypeDef:  # (9)
    ...

1. See ModelBiasAppSpecificationUnionTypeDef
2. See ModelBiasJobInputUnionTypeDef
3. See MonitoringOutputConfigUnionTypeDef
4. See MonitoringResourcesTypeDef
5. See ModelBiasBaselineConfigTypeDef
6. See MonitoringNetworkConfigUnionTypeDef
7. See MonitoringStoppingConditionTypeDef
8. See Sequence[TagTypeDef]
9. See CreateModelBiasJobDefinitionResponseTypeDef

# create_model_bias_job_definition method usage example with argument unpacking

kwargs: CreateModelBiasJobDefinitionRequestTypeDef = {  # (1)
    "JobDefinitionName": ...,
    "ModelBiasAppSpecification": ...,
    "ModelBiasJobInput": ...,
    "ModelBiasJobOutputConfig": ...,
    "JobResources": ...,
    "RoleArn": ...,
}

parent.create_model_bias_job_definition(**kwargs)

1. See CreateModelBiasJobDefinitionRequestTypeDef

create_model_card

Creates an Amazon SageMaker Model Card.

Type annotations and code completion for boto3.client("sagemaker").create_model_card method. boto3 documentation

# create_model_card method definition

def create_model_card(
    self,
    *,
    ModelCardName: str,
    Content: str,
    ModelCardStatus: ModelCardStatusType,  # (1)
    SecurityConfig: ModelCardSecurityConfigTypeDef = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateModelCardResponseTypeDef:  # (4)
    ...

1. See ModelCardStatusType
2. See ModelCardSecurityConfigTypeDef
3. See Sequence[TagTypeDef]
4. See CreateModelCardResponseTypeDef

# create_model_card method usage example with argument unpacking

kwargs: CreateModelCardRequestTypeDef = {  # (1)
    "ModelCardName": ...,
    "Content": ...,
    "ModelCardStatus": ...,
}

parent.create_model_card(**kwargs)

1. See CreateModelCardRequestTypeDef

create_model_card_export_job

Creates an Amazon SageMaker Model Card export job.

Type annotations and code completion for boto3.client("sagemaker").create_model_card_export_job method. boto3 documentation

# create_model_card_export_job method definition

def create_model_card_export_job(
    self,
    *,
    ModelCardName: str,
    ModelCardExportJobName: str,
    OutputConfig: ModelCardExportOutputConfigTypeDef,  # (1)
    ModelCardVersion: int = ...,
) -> CreateModelCardExportJobResponseTypeDef:  # (2)
    ...

1. See ModelCardExportOutputConfigTypeDef
2. See CreateModelCardExportJobResponseTypeDef

# create_model_card_export_job method usage example with argument unpacking

kwargs: CreateModelCardExportJobRequestTypeDef = {  # (1)
    "ModelCardName": ...,
    "ModelCardExportJobName": ...,
    "OutputConfig": ...,
}

parent.create_model_card_export_job(**kwargs)

1. See CreateModelCardExportJobRequestTypeDef

create_model_explainability_job_definition

Creates the definition for a model explainability job.

Type annotations and code completion for boto3.client("sagemaker").create_model_explainability_job_definition method. boto3 documentation

# create_model_explainability_job_definition method definition

def create_model_explainability_job_definition(
    self,
    *,
    JobDefinitionName: str,
    ModelExplainabilityAppSpecification: ModelExplainabilityAppSpecificationUnionTypeDef,  # (1)
    ModelExplainabilityJobInput: ModelExplainabilityJobInputUnionTypeDef,  # (2)
    ModelExplainabilityJobOutputConfig: MonitoringOutputConfigUnionTypeDef,  # (3)
    JobResources: MonitoringResourcesTypeDef,  # (4)
    RoleArn: str,
    ModelExplainabilityBaselineConfig: ModelExplainabilityBaselineConfigTypeDef = ...,  # (5)
    NetworkConfig: MonitoringNetworkConfigUnionTypeDef = ...,  # (6)
    StoppingCondition: MonitoringStoppingConditionTypeDef = ...,  # (7)
    Tags: Sequence[TagTypeDef] = ...,  # (8)
) -> CreateModelExplainabilityJobDefinitionResponseTypeDef:  # (9)
    ...

1. See ModelExplainabilityAppSpecificationUnionTypeDef
2. See ModelExplainabilityJobInputUnionTypeDef
3. See MonitoringOutputConfigUnionTypeDef
4. See MonitoringResourcesTypeDef
5. See ModelExplainabilityBaselineConfigTypeDef
6. See MonitoringNetworkConfigUnionTypeDef
7. See MonitoringStoppingConditionTypeDef
8. See Sequence[TagTypeDef]
9. See CreateModelExplainabilityJobDefinitionResponseTypeDef

# create_model_explainability_job_definition method usage example with argument unpacking

kwargs: CreateModelExplainabilityJobDefinitionRequestTypeDef = {  # (1)
    "JobDefinitionName": ...,
    "ModelExplainabilityAppSpecification": ...,
    "ModelExplainabilityJobInput": ...,
    "ModelExplainabilityJobOutputConfig": ...,
    "JobResources": ...,
    "RoleArn": ...,
}

parent.create_model_explainability_job_definition(**kwargs)

1. See CreateModelExplainabilityJobDefinitionRequestTypeDef

create_model_package

Creates a model package that you can use to create SageMaker models or list on Amazon Web Services Marketplace, or a versioned model that is part of a model group.

Type annotations and code completion for boto3.client("sagemaker").create_model_package method. boto3 documentation

# create_model_package method definition

def create_model_package(
    self,
    *,
    ModelPackageName: str = ...,
    ModelPackageGroupName: str = ...,
    ModelPackageDescription: str = ...,
    InferenceSpecification: InferenceSpecificationUnionTypeDef = ...,  # (1)
    ValidationSpecification: ModelPackageValidationSpecificationUnionTypeDef = ...,  # (2)
    SourceAlgorithmSpecification: SourceAlgorithmSpecificationUnionTypeDef = ...,  # (3)
    CertifyForMarketplace: bool = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (4)
    ModelApprovalStatus: ModelApprovalStatusType = ...,  # (5)
    MetadataProperties: MetadataPropertiesTypeDef = ...,  # (6)
    ModelMetrics: ModelMetricsTypeDef = ...,  # (7)
    ClientToken: str = ...,
    Domain: str = ...,
    Task: str = ...,
    SamplePayloadUrl: str = ...,
    CustomerMetadataProperties: Mapping[str, str] = ...,
    DriftCheckBaselines: DriftCheckBaselinesTypeDef = ...,  # (8)
    AdditionalInferenceSpecifications: Sequence[AdditionalInferenceSpecificationDefinitionUnionTypeDef] = ...,  # (9)
    SkipModelValidation: SkipModelValidationType = ...,  # (10)
    SourceUri: str = ...,
    SecurityConfig: ModelPackageSecurityConfigTypeDef = ...,  # (11)
    ModelCard: ModelPackageModelCardTypeDef = ...,  # (12)
    ModelLifeCycle: ModelLifeCycleTypeDef = ...,  # (13)
) -> CreateModelPackageOutputTypeDef:  # (14)
    ...

1. See InferenceSpecificationUnionTypeDef
2. See ModelPackageValidationSpecificationUnionTypeDef
3. See SourceAlgorithmSpecificationUnionTypeDef
4. See Sequence[TagTypeDef]
5. See ModelApprovalStatusType
6. See MetadataPropertiesTypeDef
7. See ModelMetricsTypeDef
8. See DriftCheckBaselinesTypeDef
9. See Sequence[AdditionalInferenceSpecificationDefinitionUnionTypeDef]
10. See SkipModelValidationType
11. See ModelPackageSecurityConfigTypeDef
12. See ModelPackageModelCardTypeDef
13. See ModelLifeCycleTypeDef
14. See CreateModelPackageOutputTypeDef

# create_model_package method usage example with argument unpacking

kwargs: CreateModelPackageInputTypeDef = {  # (1)
    "ModelPackageName": ...,
}

parent.create_model_package(**kwargs)

1. See CreateModelPackageInputTypeDef

create_model_package_group

Creates a model group.

Type annotations and code completion for boto3.client("sagemaker").create_model_package_group method. boto3 documentation

# create_model_package_group method definition

def create_model_package_group(
    self,
    *,
    ModelPackageGroupName: str,
    ModelPackageGroupDescription: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateModelPackageGroupOutputTypeDef:  # (2)
    ...

1. See Sequence[TagTypeDef]
2. See CreateModelPackageGroupOutputTypeDef

# create_model_package_group method usage example with argument unpacking

kwargs: CreateModelPackageGroupInputTypeDef = {  # (1)
    "ModelPackageGroupName": ...,
}

parent.create_model_package_group(**kwargs)

1. See CreateModelPackageGroupInputTypeDef

create_model_quality_job_definition

Creates a definition for a job that monitors model quality and drift.

Type annotations and code completion for boto3.client("sagemaker").create_model_quality_job_definition method. boto3 documentation

# create_model_quality_job_definition method definition

def create_model_quality_job_definition(
    self,
    *,
    JobDefinitionName: str,
    ModelQualityAppSpecification: ModelQualityAppSpecificationUnionTypeDef,  # (1)
    ModelQualityJobInput: ModelQualityJobInputUnionTypeDef,  # (2)
    ModelQualityJobOutputConfig: MonitoringOutputConfigUnionTypeDef,  # (3)
    JobResources: MonitoringResourcesTypeDef,  # (4)
    RoleArn: str,
    ModelQualityBaselineConfig: ModelQualityBaselineConfigTypeDef = ...,  # (5)
    NetworkConfig: MonitoringNetworkConfigUnionTypeDef = ...,  # (6)
    StoppingCondition: MonitoringStoppingConditionTypeDef = ...,  # (7)
    Tags: Sequence[TagTypeDef] = ...,  # (8)
) -> CreateModelQualityJobDefinitionResponseTypeDef:  # (9)
    ...

1. See ModelQualityAppSpecificationUnionTypeDef
2. See ModelQualityJobInputUnionTypeDef
3. See MonitoringOutputConfigUnionTypeDef
4. See MonitoringResourcesTypeDef
5. See ModelQualityBaselineConfigTypeDef
6. See MonitoringNetworkConfigUnionTypeDef
7. See MonitoringStoppingConditionTypeDef
8. See Sequence[TagTypeDef]
9. See CreateModelQualityJobDefinitionResponseTypeDef

# create_model_quality_job_definition method usage example with argument unpacking

kwargs: CreateModelQualityJobDefinitionRequestTypeDef = {  # (1)
    "JobDefinitionName": ...,
    "ModelQualityAppSpecification": ...,
    "ModelQualityJobInput": ...,
    "ModelQualityJobOutputConfig": ...,
    "JobResources": ...,
    "RoleArn": ...,
}

parent.create_model_quality_job_definition(**kwargs)

1. See CreateModelQualityJobDefinitionRequestTypeDef

create_monitoring_schedule

Creates a schedule that regularly starts Amazon SageMaker AI Processing Jobs to monitor the data captured for an Amazon SageMaker AI Endpoint.

Type annotations and code completion for boto3.client("sagemaker").create_monitoring_schedule method. boto3 documentation

# create_monitoring_schedule method definition

def create_monitoring_schedule(
    self,
    *,
    MonitoringScheduleName: str,
    MonitoringScheduleConfig: MonitoringScheduleConfigUnionTypeDef,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateMonitoringScheduleResponseTypeDef:  # (3)
    ...

1. See MonitoringScheduleConfigUnionTypeDef
2. See Sequence[TagTypeDef]
3. See CreateMonitoringScheduleResponseTypeDef

# create_monitoring_schedule method usage example with argument unpacking

kwargs: CreateMonitoringScheduleRequestTypeDef = {  # (1)
    "MonitoringScheduleName": ...,
    "MonitoringScheduleConfig": ...,
}

parent.create_monitoring_schedule(**kwargs)

1. See CreateMonitoringScheduleRequestTypeDef

create_notebook_instance

Creates an SageMaker AI notebook instance.

Type annotations and code completion for boto3.client("sagemaker").create_notebook_instance method. boto3 documentation

# create_notebook_instance method definition

def create_notebook_instance(
    self,
    *,
    NotebookInstanceName: str,
    InstanceType: InstanceTypeType,  # (1)
    RoleArn: str,
    SubnetId: str = ...,
    SecurityGroupIds: Sequence[str] = ...,
    KmsKeyId: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    LifecycleConfigName: str = ...,
    DirectInternetAccess: DirectInternetAccessType = ...,  # (3)
    VolumeSizeInGB: int = ...,
    AcceleratorTypes: Sequence[NotebookInstanceAcceleratorTypeType] = ...,  # (4)
    DefaultCodeRepository: str = ...,
    AdditionalCodeRepositories: Sequence[str] = ...,
    RootAccess: RootAccessType = ...,  # (5)
    PlatformIdentifier: str = ...,
    InstanceMetadataServiceConfiguration: InstanceMetadataServiceConfigurationTypeDef = ...,  # (6)
) -> CreateNotebookInstanceOutputTypeDef:  # (7)
    ...

1. See InstanceTypeType
2. See Sequence[TagTypeDef]
3. See DirectInternetAccessType
4. See Sequence[NotebookInstanceAcceleratorTypeType]
5. See RootAccessType
6. See InstanceMetadataServiceConfigurationTypeDef
7. See CreateNotebookInstanceOutputTypeDef

# create_notebook_instance method usage example with argument unpacking

kwargs: CreateNotebookInstanceInputTypeDef = {  # (1)
    "NotebookInstanceName": ...,
    "InstanceType": ...,
    "RoleArn": ...,
}

parent.create_notebook_instance(**kwargs)

1. See CreateNotebookInstanceInputTypeDef

create_notebook_instance_lifecycle_config

Creates a lifecycle configuration that you can associate with a notebook instance.

Type annotations and code completion for boto3.client("sagemaker").create_notebook_instance_lifecycle_config method. boto3 documentation

# create_notebook_instance_lifecycle_config method definition

def create_notebook_instance_lifecycle_config(
    self,
    *,
    NotebookInstanceLifecycleConfigName: str,
    OnCreate: Sequence[NotebookInstanceLifecycleHookTypeDef] = ...,  # (1)
    OnStart: Sequence[NotebookInstanceLifecycleHookTypeDef] = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateNotebookInstanceLifecycleConfigOutputTypeDef:  # (4)
    ...

1. See Sequence[NotebookInstanceLifecycleHookTypeDef]
2. See Sequence[NotebookInstanceLifecycleHookTypeDef]
3. See Sequence[TagTypeDef]
4. See CreateNotebookInstanceLifecycleConfigOutputTypeDef

# create_notebook_instance_lifecycle_config method usage example with argument unpacking

kwargs: CreateNotebookInstanceLifecycleConfigInputTypeDef = {  # (1)
    "NotebookInstanceLifecycleConfigName": ...,
}

parent.create_notebook_instance_lifecycle_config(**kwargs)

1. See CreateNotebookInstanceLifecycleConfigInputTypeDef

create_optimization_job

Creates a job that optimizes a model for inference performance.

Type annotations and code completion for boto3.client("sagemaker").create_optimization_job method. boto3 documentation

# create_optimization_job method definition

def create_optimization_job(
    self,
    *,
    OptimizationJobName: str,
    RoleArn: str,
    ModelSource: OptimizationJobModelSourceTypeDef,  # (1)
    DeploymentInstanceType: OptimizationJobDeploymentInstanceTypeType,  # (2)
    OptimizationConfigs: Sequence[OptimizationConfigUnionTypeDef],  # (3)
    OutputConfig: OptimizationJobOutputConfigTypeDef,  # (4)
    StoppingCondition: StoppingConditionTypeDef,  # (5)
    OptimizationEnvironment: Mapping[str, str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (6)
    VpcConfig: OptimizationVpcConfigUnionTypeDef = ...,  # (7)
) -> CreateOptimizationJobResponseTypeDef:  # (8)
    ...

1. See OptimizationJobModelSourceTypeDef
2. See OptimizationJobDeploymentInstanceTypeType
3. See Sequence[OptimizationConfigUnionTypeDef]
4. See OptimizationJobOutputConfigTypeDef
5. See StoppingConditionTypeDef
6. See Sequence[TagTypeDef]
7. See OptimizationVpcConfigUnionTypeDef
8. See CreateOptimizationJobResponseTypeDef

# create_optimization_job method usage example with argument unpacking

kwargs: CreateOptimizationJobRequestTypeDef = {  # (1)
    "OptimizationJobName": ...,
    "RoleArn": ...,
    "ModelSource": ...,
    "DeploymentInstanceType": ...,
    "OptimizationConfigs": ...,
    "OutputConfig": ...,
    "StoppingCondition": ...,
}

parent.create_optimization_job(**kwargs)

1. See CreateOptimizationJobRequestTypeDef

create_partner_app

Creates an Amazon SageMaker Partner AI App.

Type annotations and code completion for boto3.client("sagemaker").create_partner_app method. boto3 documentation

# create_partner_app method definition

def create_partner_app(
    self,
    *,
    Name: str,
    Type: PartnerAppTypeType,  # (1)
    ExecutionRoleArn: str,
    Tier: str,
    AuthType: PartnerAppAuthTypeType,  # (2)
    KmsKeyId: str = ...,
    MaintenanceConfig: PartnerAppMaintenanceConfigTypeDef = ...,  # (3)
    ApplicationConfig: PartnerAppConfigUnionTypeDef = ...,  # (4)
    EnableIamSessionBasedIdentity: bool = ...,
    ClientToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (5)
) -> CreatePartnerAppResponseTypeDef:  # (6)
    ...

1. See PartnerAppTypeType
2. See PartnerAppAuthTypeType
3. See PartnerAppMaintenanceConfigTypeDef
4. See PartnerAppConfigUnionTypeDef
5. See Sequence[TagTypeDef]
6. See CreatePartnerAppResponseTypeDef

# create_partner_app method usage example with argument unpacking

kwargs: CreatePartnerAppRequestTypeDef = {  # (1)
    "Name": ...,
    "Type": ...,
    "ExecutionRoleArn": ...,
    "Tier": ...,
    "AuthType": ...,
}

parent.create_partner_app(**kwargs)

1. See CreatePartnerAppRequestTypeDef

create_partner_app_presigned_url

Creates a presigned URL to access an Amazon SageMaker Partner AI App.

Type annotations and code completion for boto3.client("sagemaker").create_partner_app_presigned_url method. boto3 documentation

# create_partner_app_presigned_url method definition

def create_partner_app_presigned_url(
    self,
    *,
    Arn: str,
    ExpiresInSeconds: int = ...,
    SessionExpirationDurationInSeconds: int = ...,
) -> CreatePartnerAppPresignedUrlResponseTypeDef:  # (1)
    ...

1. See CreatePartnerAppPresignedUrlResponseTypeDef

# create_partner_app_presigned_url method usage example with argument unpacking

kwargs: CreatePartnerAppPresignedUrlRequestTypeDef = {  # (1)
    "Arn": ...,
}

parent.create_partner_app_presigned_url(**kwargs)

1. See CreatePartnerAppPresignedUrlRequestTypeDef

create_pipeline

Creates a pipeline using a JSON pipeline definition.

Type annotations and code completion for boto3.client("sagemaker").create_pipeline method. boto3 documentation

# create_pipeline method definition

def create_pipeline(
    self,
    *,
    PipelineName: str,
    ClientRequestToken: str,
    RoleArn: str,
    PipelineDisplayName: str = ...,
    PipelineDefinition: str = ...,
    PipelineDefinitionS3Location: PipelineDefinitionS3LocationTypeDef = ...,  # (1)
    PipelineDescription: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    ParallelismConfiguration: ParallelismConfigurationTypeDef = ...,  # (3)
) -> CreatePipelineResponseTypeDef:  # (4)
    ...

1. See PipelineDefinitionS3LocationTypeDef
2. See Sequence[TagTypeDef]
3. See ParallelismConfigurationTypeDef
4. See CreatePipelineResponseTypeDef

# create_pipeline method usage example with argument unpacking

kwargs: CreatePipelineRequestTypeDef = {  # (1)
    "PipelineName": ...,
    "ClientRequestToken": ...,
    "RoleArn": ...,
}

parent.create_pipeline(**kwargs)

1. See CreatePipelineRequestTypeDef

create_presigned_domain_url

Creates a URL for a specified UserProfile in a Domain.

Type annotations and code completion for boto3.client("sagemaker").create_presigned_domain_url method. boto3 documentation

# create_presigned_domain_url method definition

def create_presigned_domain_url(
    self,
    *,
    DomainId: str,
    UserProfileName: str,
    SessionExpirationDurationInSeconds: int = ...,
    ExpiresInSeconds: int = ...,
    SpaceName: str = ...,
    LandingUri: str = ...,
) -> CreatePresignedDomainUrlResponseTypeDef:  # (1)
    ...

1. See CreatePresignedDomainUrlResponseTypeDef

# create_presigned_domain_url method usage example with argument unpacking

kwargs: CreatePresignedDomainUrlRequestTypeDef = {  # (1)
    "DomainId": ...,
    "UserProfileName": ...,
}

parent.create_presigned_domain_url(**kwargs)

1. See CreatePresignedDomainUrlRequestTypeDef

create_presigned_mlflow_tracking_server_url

Returns a presigned URL that you can use to connect to the MLflow UI attached to your tracking server.

Type annotations and code completion for boto3.client("sagemaker").create_presigned_mlflow_tracking_server_url method. boto3 documentation

# create_presigned_mlflow_tracking_server_url method definition

def create_presigned_mlflow_tracking_server_url(
    self,
    *,
    TrackingServerName: str,
    ExpiresInSeconds: int = ...,
    SessionExpirationDurationInSeconds: int = ...,
) -> CreatePresignedMlflowTrackingServerUrlResponseTypeDef:  # (1)
    ...

1. See CreatePresignedMlflowTrackingServerUrlResponseTypeDef

# create_presigned_mlflow_tracking_server_url method usage example with argument unpacking

kwargs: CreatePresignedMlflowTrackingServerUrlRequestTypeDef = {  # (1)
    "TrackingServerName": ...,
}

parent.create_presigned_mlflow_tracking_server_url(**kwargs)

1. See CreatePresignedMlflowTrackingServerUrlRequestTypeDef

create_presigned_notebook_instance_url

Returns a URL that you can use to connect to the Jupyter server from a notebook instance.

Type annotations and code completion for boto3.client("sagemaker").create_presigned_notebook_instance_url method. boto3 documentation

# create_presigned_notebook_instance_url method definition

def create_presigned_notebook_instance_url(
    self,
    *,
    NotebookInstanceName: str,
    SessionExpirationDurationInSeconds: int = ...,
) -> CreatePresignedNotebookInstanceUrlOutputTypeDef:  # (1)
    ...

1. See CreatePresignedNotebookInstanceUrlOutputTypeDef

# create_presigned_notebook_instance_url method usage example with argument unpacking

kwargs: CreatePresignedNotebookInstanceUrlInputTypeDef = {  # (1)
    "NotebookInstanceName": ...,
}

parent.create_presigned_notebook_instance_url(**kwargs)

1. See CreatePresignedNotebookInstanceUrlInputTypeDef

create_processing_job

Creates a processing job.

Type annotations and code completion for boto3.client("sagemaker").create_processing_job method. boto3 documentation

# create_processing_job method definition

def create_processing_job(
    self,
    *,
    ProcessingJobName: str,
    ProcessingResources: ProcessingResourcesTypeDef,  # (1)
    AppSpecification: AppSpecificationUnionTypeDef,  # (2)
    RoleArn: str,
    ProcessingInputs: Sequence[ProcessingInputTypeDef] = ...,  # (3)
    ProcessingOutputConfig: ProcessingOutputConfigUnionTypeDef = ...,  # (4)
    StoppingCondition: ProcessingStoppingConditionTypeDef = ...,  # (5)
    Environment: Mapping[str, str] = ...,
    NetworkConfig: NetworkConfigUnionTypeDef = ...,  # (6)
    Tags: Sequence[TagTypeDef] = ...,  # (7)
    ExperimentConfig: ExperimentConfigTypeDef = ...,  # (8)
) -> CreateProcessingJobResponseTypeDef:  # (9)
    ...

1. See ProcessingResourcesTypeDef
2. See AppSpecificationUnionTypeDef
3. See Sequence[ProcessingInputTypeDef]
4. See ProcessingOutputConfigUnionTypeDef
5. See ProcessingStoppingConditionTypeDef
6. See NetworkConfigUnionTypeDef
7. See Sequence[TagTypeDef]
8. See ExperimentConfigTypeDef
9. See CreateProcessingJobResponseTypeDef

# create_processing_job method usage example with argument unpacking

kwargs: CreateProcessingJobRequestTypeDef = {  # (1)
    "ProcessingJobName": ...,
    "ProcessingResources": ...,
    "AppSpecification": ...,
    "RoleArn": ...,
}

parent.create_processing_job(**kwargs)

1. See CreateProcessingJobRequestTypeDef

create_project

Creates a machine learning (ML) project that can contain one or more templates that set up an ML pipeline from training to deploying an approved model.

Type annotations and code completion for boto3.client("sagemaker").create_project method. boto3 documentation

# create_project method definition

def create_project(
    self,
    *,
    ProjectName: str,
    ProjectDescription: str = ...,
    ServiceCatalogProvisioningDetails: ServiceCatalogProvisioningDetailsUnionTypeDef = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    TemplateProviders: Sequence[CreateTemplateProviderTypeDef] = ...,  # (3)
) -> CreateProjectOutputTypeDef:  # (4)
    ...

1. See ServiceCatalogProvisioningDetailsUnionTypeDef
2. See Sequence[TagTypeDef]
3. See Sequence[CreateTemplateProviderTypeDef]
4. See CreateProjectOutputTypeDef

# create_project method usage example with argument unpacking

kwargs: CreateProjectInputTypeDef = {  # (1)
    "ProjectName": ...,
}

parent.create_project(**kwargs)

1. See CreateProjectInputTypeDef

create_space

Creates a private space or a space used for real time collaboration in a domain.

Type annotations and code completion for boto3.client("sagemaker").create_space method. boto3 documentation

# create_space method definition

def create_space(
    self,
    *,
    DomainId: str,
    SpaceName: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    SpaceSettings: SpaceSettingsUnionTypeDef = ...,  # (2)
    OwnershipSettings: OwnershipSettingsTypeDef = ...,  # (3)
    SpaceSharingSettings: SpaceSharingSettingsTypeDef = ...,  # (4)
    SpaceDisplayName: str = ...,
) -> CreateSpaceResponseTypeDef:  # (5)
    ...

1. See Sequence[TagTypeDef]
2. See SpaceSettingsUnionTypeDef
3. See OwnershipSettingsTypeDef
4. See SpaceSharingSettingsTypeDef
5. See CreateSpaceResponseTypeDef

# create_space method usage example with argument unpacking

kwargs: CreateSpaceRequestTypeDef = {  # (1)
    "DomainId": ...,
    "SpaceName": ...,
}

parent.create_space(**kwargs)

1. See CreateSpaceRequestTypeDef

create_studio_lifecycle_config

Creates a new Amazon SageMaker AI Studio Lifecycle Configuration.

Type annotations and code completion for boto3.client("sagemaker").create_studio_lifecycle_config method. boto3 documentation

# create_studio_lifecycle_config method definition

def create_studio_lifecycle_config(
    self,
    *,
    StudioLifecycleConfigName: str,
    StudioLifecycleConfigContent: str,
    StudioLifecycleConfigAppType: StudioLifecycleConfigAppTypeType,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateStudioLifecycleConfigResponseTypeDef:  # (3)
    ...

1. See StudioLifecycleConfigAppTypeType
2. See Sequence[TagTypeDef]
3. See CreateStudioLifecycleConfigResponseTypeDef

# create_studio_lifecycle_config method usage example with argument unpacking

kwargs: CreateStudioLifecycleConfigRequestTypeDef = {  # (1)
    "StudioLifecycleConfigName": ...,
    "StudioLifecycleConfigContent": ...,
    "StudioLifecycleConfigAppType": ...,
}

parent.create_studio_lifecycle_config(**kwargs)

1. See CreateStudioLifecycleConfigRequestTypeDef

create_training_job

Starts a model training job.

Type annotations and code completion for boto3.client("sagemaker").create_training_job method. boto3 documentation

# create_training_job method definition

def create_training_job(
    self,
    *,
    TrainingJobName: str,
    AlgorithmSpecification: AlgorithmSpecificationUnionTypeDef,  # (1)
    RoleArn: str,
    OutputDataConfig: OutputDataConfigTypeDef,  # (2)
    ResourceConfig: ResourceConfigUnionTypeDef,  # (3)
    StoppingCondition: StoppingConditionTypeDef,  # (4)
    HyperParameters: Mapping[str, str] = ...,
    InputDataConfig: Sequence[ChannelUnionTypeDef] = ...,  # (5)
    VpcConfig: VpcConfigUnionTypeDef = ...,  # (6)
    Tags: Sequence[TagTypeDef] = ...,  # (7)
    EnableNetworkIsolation: bool = ...,
    EnableInterContainerTrafficEncryption: bool = ...,
    EnableManagedSpotTraining: bool = ...,
    CheckpointConfig: CheckpointConfigTypeDef = ...,  # (8)
    DebugHookConfig: DebugHookConfigUnionTypeDef = ...,  # (9)
    DebugRuleConfigurations: Sequence[DebugRuleConfigurationUnionTypeDef] = ...,  # (10)
    TensorBoardOutputConfig: TensorBoardOutputConfigTypeDef = ...,  # (11)
    ExperimentConfig: ExperimentConfigTypeDef = ...,  # (12)
    ProfilerConfig: ProfilerConfigUnionTypeDef = ...,  # (13)
    ProfilerRuleConfigurations: Sequence[ProfilerRuleConfigurationUnionTypeDef] = ...,  # (14)
    Environment: Mapping[str, str] = ...,
    RetryStrategy: RetryStrategyTypeDef = ...,  # (15)
    RemoteDebugConfig: RemoteDebugConfigTypeDef = ...,  # (16)
    InfraCheckConfig: InfraCheckConfigTypeDef = ...,  # (17)
    SessionChainingConfig: SessionChainingConfigTypeDef = ...,  # (18)
) -> CreateTrainingJobResponseTypeDef:  # (19)
    ...

1. See AlgorithmSpecificationUnionTypeDef
2. See OutputDataConfigTypeDef
3. See ResourceConfigUnionTypeDef
4. See StoppingConditionTypeDef
5. See Sequence[ChannelUnionTypeDef]
6. See VpcConfigUnionTypeDef
7. See Sequence[TagTypeDef]
8. See CheckpointConfigTypeDef
9. See DebugHookConfigUnionTypeDef
10. See Sequence[DebugRuleConfigurationUnionTypeDef]
11. See TensorBoardOutputConfigTypeDef
12. See ExperimentConfigTypeDef
13. See ProfilerConfigUnionTypeDef
14. See Sequence[ProfilerRuleConfigurationUnionTypeDef]
15. See RetryStrategyTypeDef
16. See RemoteDebugConfigTypeDef
17. See InfraCheckConfigTypeDef
18. See SessionChainingConfigTypeDef
19. See CreateTrainingJobResponseTypeDef

# create_training_job method usage example with argument unpacking

kwargs: CreateTrainingJobRequestTypeDef = {  # (1)
    "TrainingJobName": ...,
    "AlgorithmSpecification": ...,
    "RoleArn": ...,
    "OutputDataConfig": ...,
    "ResourceConfig": ...,
    "StoppingCondition": ...,
}

parent.create_training_job(**kwargs)

1. See CreateTrainingJobRequestTypeDef

create_training_plan

Creates a new training plan in SageMaker to reserve compute capacity.

Type annotations and code completion for boto3.client("sagemaker").create_training_plan method. boto3 documentation

# create_training_plan method definition

def create_training_plan(
    self,
    *,
    TrainingPlanName: str,
    TrainingPlanOfferingId: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateTrainingPlanResponseTypeDef:  # (2)
    ...

1. See Sequence[TagTypeDef]
2. See CreateTrainingPlanResponseTypeDef

# create_training_plan method usage example with argument unpacking

kwargs: CreateTrainingPlanRequestTypeDef = {  # (1)
    "TrainingPlanName": ...,
    "TrainingPlanOfferingId": ...,
}

parent.create_training_plan(**kwargs)

1. See CreateTrainingPlanRequestTypeDef

create_transform_job

Starts a transform job.

Type annotations and code completion for boto3.client("sagemaker").create_transform_job method. boto3 documentation

# create_transform_job method definition

def create_transform_job(
    self,
    *,
    TransformJobName: str,
    ModelName: str,
    TransformInput: TransformInputTypeDef,  # (1)
    TransformOutput: TransformOutputTypeDef,  # (2)
    TransformResources: TransformResourcesTypeDef,  # (3)
    MaxConcurrentTransforms: int = ...,
    ModelClientConfig: ModelClientConfigTypeDef = ...,  # (4)
    MaxPayloadInMB: int = ...,
    BatchStrategy: BatchStrategyType = ...,  # (5)
    Environment: Mapping[str, str] = ...,
    DataCaptureConfig: BatchDataCaptureConfigTypeDef = ...,  # (6)
    DataProcessing: DataProcessingTypeDef = ...,  # (7)
    Tags: Sequence[TagTypeDef] = ...,  # (8)
    ExperimentConfig: ExperimentConfigTypeDef = ...,  # (9)
) -> CreateTransformJobResponseTypeDef:  # (10)
    ...

1. See TransformInputTypeDef
2. See TransformOutputTypeDef
3. See TransformResourcesTypeDef
4. See ModelClientConfigTypeDef
5. See BatchStrategyType
6. See BatchDataCaptureConfigTypeDef
7. See DataProcessingTypeDef
8. See Sequence[TagTypeDef]
9. See ExperimentConfigTypeDef
10. See CreateTransformJobResponseTypeDef

# create_transform_job method usage example with argument unpacking

kwargs: CreateTransformJobRequestTypeDef = {  # (1)
    "TransformJobName": ...,
    "ModelName": ...,
    "TransformInput": ...,
    "TransformOutput": ...,
    "TransformResources": ...,
}

parent.create_transform_job(**kwargs)

1. See CreateTransformJobRequestTypeDef

create_trial

Creates an SageMaker trial.

Type annotations and code completion for boto3.client("sagemaker").create_trial method. boto3 documentation

# create_trial method definition

def create_trial(
    self,
    *,
    TrialName: str,
    ExperimentName: str,
    DisplayName: str = ...,
    MetadataProperties: MetadataPropertiesTypeDef = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateTrialResponseTypeDef:  # (3)
    ...

1. See MetadataPropertiesTypeDef
2. See Sequence[TagTypeDef]
3. See CreateTrialResponseTypeDef

# create_trial method usage example with argument unpacking

kwargs: CreateTrialRequestTypeDef = {  # (1)
    "TrialName": ...,
    "ExperimentName": ...,
}

parent.create_trial(**kwargs)

1. See CreateTrialRequestTypeDef

create_trial_component

Creates a trial component, which is a stage of a machine learning trial.

Type annotations and code completion for boto3.client("sagemaker").create_trial_component method. boto3 documentation

# create_trial_component method definition

def create_trial_component(
    self,
    *,
    TrialComponentName: str,
    DisplayName: str = ...,
    Status: TrialComponentStatusTypeDef = ...,  # (1)
    StartTime: TimestampTypeDef = ...,
    EndTime: TimestampTypeDef = ...,
    Parameters: Mapping[str, TrialComponentParameterValueTypeDef] = ...,  # (2)
    InputArtifacts: Mapping[str, TrialComponentArtifactTypeDef] = ...,  # (3)
    OutputArtifacts: Mapping[str, TrialComponentArtifactTypeDef] = ...,  # (3)
    MetadataProperties: MetadataPropertiesTypeDef = ...,  # (5)
    Tags: Sequence[TagTypeDef] = ...,  # (6)
) -> CreateTrialComponentResponseTypeDef:  # (7)
    ...

1. See TrialComponentStatusTypeDef
2. See Mapping[str, TrialComponentParameterValueTypeDef]
3. See Mapping[str, TrialComponentArtifactTypeDef]
4. See Mapping[str, TrialComponentArtifactTypeDef]
5. See MetadataPropertiesTypeDef
6. See Sequence[TagTypeDef]
7. See CreateTrialComponentResponseTypeDef

# create_trial_component method usage example with argument unpacking

kwargs: CreateTrialComponentRequestTypeDef = {  # (1)
    "TrialComponentName": ...,
}

parent.create_trial_component(**kwargs)

1. See CreateTrialComponentRequestTypeDef

create_user_profile

Creates a user profile.

Type annotations and code completion for boto3.client("sagemaker").create_user_profile method. boto3 documentation

# create_user_profile method definition

def create_user_profile(
    self,
    *,
    DomainId: str,
    UserProfileName: str,
    SingleSignOnUserIdentifier: str = ...,
    SingleSignOnUserValue: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    UserSettings: UserSettingsUnionTypeDef = ...,  # (2)
) -> CreateUserProfileResponseTypeDef:  # (3)
    ...

1. See Sequence[TagTypeDef]
2. See UserSettingsUnionTypeDef
3. See CreateUserProfileResponseTypeDef

# create_user_profile method usage example with argument unpacking

kwargs: CreateUserProfileRequestTypeDef = {  # (1)
    "DomainId": ...,
    "UserProfileName": ...,
}

parent.create_user_profile(**kwargs)

1. See CreateUserProfileRequestTypeDef

create_workforce

Use this operation to create a workforce.

Type annotations and code completion for boto3.client("sagemaker").create_workforce method. boto3 documentation

# create_workforce method definition

def create_workforce(
    self,
    *,
    WorkforceName: str,
    CognitoConfig: CognitoConfigTypeDef = ...,  # (1)
    OidcConfig: OidcConfigTypeDef = ...,  # (2)
    SourceIpConfig: SourceIpConfigUnionTypeDef = ...,  # (3)
    Tags: Sequence[TagTypeDef] = ...,  # (4)
    WorkforceVpcConfig: WorkforceVpcConfigRequestTypeDef = ...,  # (5)
) -> CreateWorkforceResponseTypeDef:  # (6)
    ...

1. See CognitoConfigTypeDef
2. See OidcConfigTypeDef
3. See SourceIpConfigUnionTypeDef
4. See Sequence[TagTypeDef]
5. See WorkforceVpcConfigRequestTypeDef
6. See CreateWorkforceResponseTypeDef

# create_workforce method usage example with argument unpacking

kwargs: CreateWorkforceRequestTypeDef = {  # (1)
    "WorkforceName": ...,
}

parent.create_workforce(**kwargs)

1. See CreateWorkforceRequestTypeDef

create_workteam

Creates a new work team for labeling your data.

Type annotations and code completion for boto3.client("sagemaker").create_workteam method. boto3 documentation

# create_workteam method definition

def create_workteam(
    self,
    *,
    WorkteamName: str,
    MemberDefinitions: Sequence[MemberDefinitionUnionTypeDef],  # (1)
    Description: str,
    WorkforceName: str = ...,
    NotificationConfiguration: NotificationConfigurationTypeDef = ...,  # (2)
    WorkerAccessConfiguration: WorkerAccessConfigurationTypeDef = ...,  # (3)
    Tags: Sequence[TagTypeDef] = ...,  # (4)
) -> CreateWorkteamResponseTypeDef:  # (5)
    ...

1. See Sequence[MemberDefinitionUnionTypeDef]
2. See NotificationConfigurationTypeDef
3. See WorkerAccessConfigurationTypeDef
4. See Sequence[TagTypeDef]
5. See CreateWorkteamResponseTypeDef

# create_workteam method usage example with argument unpacking

kwargs: CreateWorkteamRequestTypeDef = {  # (1)
    "WorkteamName": ...,
    "MemberDefinitions": ...,
    "Description": ...,
}

parent.create_workteam(**kwargs)

1. See CreateWorkteamRequestTypeDef

delete_action

Deletes an action.

Type annotations and code completion for boto3.client("sagemaker").delete_action method. boto3 documentation

# delete_action method definition

def delete_action(
    self,
    *,
    ActionName: str,
) -> DeleteActionResponseTypeDef:  # (1)
    ...

1. See DeleteActionResponseTypeDef

# delete_action method usage example with argument unpacking

kwargs: DeleteActionRequestTypeDef = {  # (1)
    "ActionName": ...,
}

parent.delete_action(**kwargs)

1. See DeleteActionRequestTypeDef

delete_algorithm

Removes the specified algorithm from your account.

Type annotations and code completion for boto3.client("sagemaker").delete_algorithm method. boto3 documentation

# delete_algorithm method definition

def delete_algorithm(
    self,
    *,
    AlgorithmName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_algorithm method usage example with argument unpacking

kwargs: DeleteAlgorithmInputTypeDef = {  # (1)
    "AlgorithmName": ...,
}

parent.delete_algorithm(**kwargs)

1. See DeleteAlgorithmInputTypeDef

delete_app

Used to stop and delete an app.

Type annotations and code completion for boto3.client("sagemaker").delete_app method. boto3 documentation

# delete_app method definition

def delete_app(
    self,
    *,
    DomainId: str,
    AppType: AppTypeType,  # (1)
    AppName: str,
    UserProfileName: str = ...,
    SpaceName: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See AppTypeType
2. See EmptyResponseMetadataTypeDef

# delete_app method usage example with argument unpacking

kwargs: DeleteAppRequestTypeDef = {  # (1)
    "DomainId": ...,
    "AppType": ...,
    "AppName": ...,
}

parent.delete_app(**kwargs)

1. See DeleteAppRequestTypeDef

delete_app_image_config

Deletes an AppImageConfig.

Type annotations and code completion for boto3.client("sagemaker").delete_app_image_config method. boto3 documentation

# delete_app_image_config method definition

def delete_app_image_config(
    self,
    *,
    AppImageConfigName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_app_image_config method usage example with argument unpacking

kwargs: DeleteAppImageConfigRequestTypeDef = {  # (1)
    "AppImageConfigName": ...,
}

parent.delete_app_image_config(**kwargs)

1. See DeleteAppImageConfigRequestTypeDef

delete_artifact

Deletes an artifact.

Type annotations and code completion for boto3.client("sagemaker").delete_artifact method. boto3 documentation

# delete_artifact method definition

def delete_artifact(
    self,
    *,
    ArtifactArn: str = ...,
    Source: ArtifactSourceUnionTypeDef = ...,  # (1)
) -> DeleteArtifactResponseTypeDef:  # (2)
    ...

1. See ArtifactSourceUnionTypeDef
2. See DeleteArtifactResponseTypeDef

# delete_artifact method usage example with argument unpacking

kwargs: DeleteArtifactRequestTypeDef = {  # (1)
    "ArtifactArn": ...,
}

parent.delete_artifact(**kwargs)

1. See DeleteArtifactRequestTypeDef

delete_association

Deletes an association.

Type annotations and code completion for boto3.client("sagemaker").delete_association method. boto3 documentation

# delete_association method definition

def delete_association(
    self,
    *,
    SourceArn: str,
    DestinationArn: str,
) -> DeleteAssociationResponseTypeDef:  # (1)
    ...

1. See DeleteAssociationResponseTypeDef

# delete_association method usage example with argument unpacking

kwargs: DeleteAssociationRequestTypeDef = {  # (1)
    "SourceArn": ...,
    "DestinationArn": ...,
}

parent.delete_association(**kwargs)

1. See DeleteAssociationRequestTypeDef

delete_cluster

Delete a SageMaker HyperPod cluster.

Type annotations and code completion for boto3.client("sagemaker").delete_cluster method. boto3 documentation

# delete_cluster method definition

def delete_cluster(
    self,
    *,
    ClusterName: str,
) -> DeleteClusterResponseTypeDef:  # (1)
    ...

1. See DeleteClusterResponseTypeDef

# delete_cluster method usage example with argument unpacking

kwargs: DeleteClusterRequestTypeDef = {  # (1)
    "ClusterName": ...,
}

parent.delete_cluster(**kwargs)

1. See DeleteClusterRequestTypeDef

delete_cluster_scheduler_config

Deletes the cluster policy of the cluster.

Type annotations and code completion for boto3.client("sagemaker").delete_cluster_scheduler_config method. boto3 documentation

# delete_cluster_scheduler_config method definition

def delete_cluster_scheduler_config(
    self,
    *,
    ClusterSchedulerConfigId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_cluster_scheduler_config method usage example with argument unpacking

kwargs: DeleteClusterSchedulerConfigRequestTypeDef = {  # (1)
    "ClusterSchedulerConfigId": ...,
}

parent.delete_cluster_scheduler_config(**kwargs)

1. See DeleteClusterSchedulerConfigRequestTypeDef

delete_code_repository

Deletes the specified Git repository from your account.

Type annotations and code completion for boto3.client("sagemaker").delete_code_repository method. boto3 documentation

# delete_code_repository method definition

def delete_code_repository(
    self,
    *,
    CodeRepositoryName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_code_repository method usage example with argument unpacking

kwargs: DeleteCodeRepositoryInputTypeDef = {  # (1)
    "CodeRepositoryName": ...,
}

parent.delete_code_repository(**kwargs)

1. See DeleteCodeRepositoryInputTypeDef

delete_compilation_job

Deletes the specified compilation job.

Type annotations and code completion for boto3.client("sagemaker").delete_compilation_job method. boto3 documentation

# delete_compilation_job method definition

def delete_compilation_job(
    self,
    *,
    CompilationJobName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_compilation_job method usage example with argument unpacking

kwargs: DeleteCompilationJobRequestTypeDef = {  # (1)
    "CompilationJobName": ...,
}

parent.delete_compilation_job(**kwargs)

1. See DeleteCompilationJobRequestTypeDef

delete_compute_quota

Deletes the compute allocation from the cluster.

Type annotations and code completion for boto3.client("sagemaker").delete_compute_quota method. boto3 documentation

# delete_compute_quota method definition

def delete_compute_quota(
    self,
    *,
    ComputeQuotaId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_compute_quota method usage example with argument unpacking

kwargs: DeleteComputeQuotaRequestTypeDef = {  # (1)
    "ComputeQuotaId": ...,
}

parent.delete_compute_quota(**kwargs)

1. See DeleteComputeQuotaRequestTypeDef

delete_context

Deletes an context.

Type annotations and code completion for boto3.client("sagemaker").delete_context method. boto3 documentation

# delete_context method definition

def delete_context(
    self,
    *,
    ContextName: str,
) -> DeleteContextResponseTypeDef:  # (1)
    ...

1. See DeleteContextResponseTypeDef

# delete_context method usage example with argument unpacking

kwargs: DeleteContextRequestTypeDef = {  # (1)
    "ContextName": ...,
}

parent.delete_context(**kwargs)

1. See DeleteContextRequestTypeDef

delete_data_quality_job_definition

Deletes a data quality monitoring job definition.

Type annotations and code completion for boto3.client("sagemaker").delete_data_quality_job_definition method. boto3 documentation

# delete_data_quality_job_definition method definition

def delete_data_quality_job_definition(
    self,
    *,
    JobDefinitionName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_data_quality_job_definition method usage example with argument unpacking

kwargs: DeleteDataQualityJobDefinitionRequestTypeDef = {  # (1)
    "JobDefinitionName": ...,
}

parent.delete_data_quality_job_definition(**kwargs)

1. See DeleteDataQualityJobDefinitionRequestTypeDef

delete_device_fleet

Deletes a fleet.

Type annotations and code completion for boto3.client("sagemaker").delete_device_fleet method. boto3 documentation

# delete_device_fleet method definition

def delete_device_fleet(
    self,
    *,
    DeviceFleetName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_device_fleet method usage example with argument unpacking

kwargs: DeleteDeviceFleetRequestTypeDef = {  # (1)
    "DeviceFleetName": ...,
}

parent.delete_device_fleet(**kwargs)

1. See DeleteDeviceFleetRequestTypeDef

delete_domain

Used to delete a domain.

Type annotations and code completion for boto3.client("sagemaker").delete_domain method. boto3 documentation

# delete_domain method definition

def delete_domain(
    self,
    *,
    DomainId: str,
    RetentionPolicy: RetentionPolicyTypeDef = ...,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See RetentionPolicyTypeDef
2. See EmptyResponseMetadataTypeDef

# delete_domain method usage example with argument unpacking

kwargs: DeleteDomainRequestTypeDef = {  # (1)
    "DomainId": ...,
}

parent.delete_domain(**kwargs)

1. See DeleteDomainRequestTypeDef

delete_edge_deployment_plan

Deletes an edge deployment plan if (and only if) all the stages in the plan are inactive or there are no stages in the plan.

Type annotations and code completion for boto3.client("sagemaker").delete_edge_deployment_plan method. boto3 documentation

# delete_edge_deployment_plan method definition

def delete_edge_deployment_plan(
    self,
    *,
    EdgeDeploymentPlanName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_edge_deployment_plan method usage example with argument unpacking

kwargs: DeleteEdgeDeploymentPlanRequestTypeDef = {  # (1)
    "EdgeDeploymentPlanName": ...,
}

parent.delete_edge_deployment_plan(**kwargs)

1. See DeleteEdgeDeploymentPlanRequestTypeDef

delete_edge_deployment_stage

Delete a stage in an edge deployment plan if (and only if) the stage is inactive.

Type annotations and code completion for boto3.client("sagemaker").delete_edge_deployment_stage method. boto3 documentation

# delete_edge_deployment_stage method definition

def delete_edge_deployment_stage(
    self,
    *,
    EdgeDeploymentPlanName: str,
    StageName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_edge_deployment_stage method usage example with argument unpacking

kwargs: DeleteEdgeDeploymentStageRequestTypeDef = {  # (1)
    "EdgeDeploymentPlanName": ...,
    "StageName": ...,
}

parent.delete_edge_deployment_stage(**kwargs)

1. See DeleteEdgeDeploymentStageRequestTypeDef

delete_endpoint

Deletes an endpoint.

Type annotations and code completion for boto3.client("sagemaker").delete_endpoint method. boto3 documentation

# delete_endpoint method definition

def delete_endpoint(
    self,
    *,
    EndpointName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_endpoint method usage example with argument unpacking

kwargs: DeleteEndpointInputTypeDef = {  # (1)
    "EndpointName": ...,
}

parent.delete_endpoint(**kwargs)

1. See DeleteEndpointInputTypeDef

delete_endpoint_config

Deletes an endpoint configuration.

Type annotations and code completion for boto3.client("sagemaker").delete_endpoint_config method. boto3 documentation

# delete_endpoint_config method definition

def delete_endpoint_config(
    self,
    *,
    EndpointConfigName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_endpoint_config method usage example with argument unpacking

kwargs: DeleteEndpointConfigInputTypeDef = {  # (1)
    "EndpointConfigName": ...,
}

parent.delete_endpoint_config(**kwargs)

1. See DeleteEndpointConfigInputTypeDef

delete_experiment

Deletes an SageMaker experiment.

Type annotations and code completion for boto3.client("sagemaker").delete_experiment method. boto3 documentation

# delete_experiment method definition

def delete_experiment(
    self,
    *,
    ExperimentName: str,
) -> DeleteExperimentResponseTypeDef:  # (1)
    ...

1. See DeleteExperimentResponseTypeDef

# delete_experiment method usage example with argument unpacking

kwargs: DeleteExperimentRequestTypeDef = {  # (1)
    "ExperimentName": ...,
}

parent.delete_experiment(**kwargs)

1. See DeleteExperimentRequestTypeDef

delete_feature_group

Delete the FeatureGroup and any data that was written to the OnlineStore of the FeatureGroup.

Type annotations and code completion for boto3.client("sagemaker").delete_feature_group method. boto3 documentation

# delete_feature_group method definition

def delete_feature_group(
    self,
    *,
    FeatureGroupName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_feature_group method usage example with argument unpacking

kwargs: DeleteFeatureGroupRequestTypeDef = {  # (1)
    "FeatureGroupName": ...,
}

parent.delete_feature_group(**kwargs)

1. See DeleteFeatureGroupRequestTypeDef

delete_flow_definition

Deletes the specified flow definition.

Type annotations and code completion for boto3.client("sagemaker").delete_flow_definition method. boto3 documentation

# delete_flow_definition method definition

def delete_flow_definition(
    self,
    *,
    FlowDefinitionName: str,
) -> Dict[str, Any]:
    ...

# delete_flow_definition method usage example with argument unpacking

kwargs: DeleteFlowDefinitionRequestTypeDef = {  # (1)
    "FlowDefinitionName": ...,
}

parent.delete_flow_definition(**kwargs)

1. See DeleteFlowDefinitionRequestTypeDef

delete_hub

Delete a hub.

Type annotations and code completion for boto3.client("sagemaker").delete_hub method. boto3 documentation

# delete_hub method definition

def delete_hub(
    self,
    *,
    HubName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_hub method usage example with argument unpacking

kwargs: DeleteHubRequestTypeDef = {  # (1)
    "HubName": ...,
}

parent.delete_hub(**kwargs)

1. See DeleteHubRequestTypeDef

delete_hub_content

Delete the contents of a hub.

Type annotations and code completion for boto3.client("sagemaker").delete_hub_content method. boto3 documentation

# delete_hub_content method definition

def delete_hub_content(
    self,
    *,
    HubName: str,
    HubContentType: HubContentTypeType,  # (1)
    HubContentName: str,
    HubContentVersion: str,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See HubContentTypeType
2. See EmptyResponseMetadataTypeDef

# delete_hub_content method usage example with argument unpacking

kwargs: DeleteHubContentRequestTypeDef = {  # (1)
    "HubName": ...,
    "HubContentType": ...,
    "HubContentName": ...,
    "HubContentVersion": ...,
}

parent.delete_hub_content(**kwargs)

1. See DeleteHubContentRequestTypeDef

delete_hub_content_reference

Delete a hub content reference in order to remove a model from a private hub.

Type annotations and code completion for boto3.client("sagemaker").delete_hub_content_reference method. boto3 documentation

# delete_hub_content_reference method definition

def delete_hub_content_reference(
    self,
    *,
    HubName: str,
    HubContentType: HubContentTypeType,  # (1)
    HubContentName: str,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See HubContentTypeType
2. See EmptyResponseMetadataTypeDef

# delete_hub_content_reference method usage example with argument unpacking

kwargs: DeleteHubContentReferenceRequestTypeDef = {  # (1)
    "HubName": ...,
    "HubContentType": ...,
    "HubContentName": ...,
}

parent.delete_hub_content_reference(**kwargs)

1. See DeleteHubContentReferenceRequestTypeDef

delete_human_task_ui

Use this operation to delete a human task user interface (worker task template).

Type annotations and code completion for boto3.client("sagemaker").delete_human_task_ui method. boto3 documentation

# delete_human_task_ui method definition

def delete_human_task_ui(
    self,
    *,
    HumanTaskUiName: str,
) -> Dict[str, Any]:
    ...

# delete_human_task_ui method usage example with argument unpacking

kwargs: DeleteHumanTaskUiRequestTypeDef = {  # (1)
    "HumanTaskUiName": ...,
}

parent.delete_human_task_ui(**kwargs)

1. See DeleteHumanTaskUiRequestTypeDef

delete_hyper_parameter_tuning_job

Deletes a hyperparameter tuning job.

Type annotations and code completion for boto3.client("sagemaker").delete_hyper_parameter_tuning_job method. boto3 documentation

# delete_hyper_parameter_tuning_job method definition

def delete_hyper_parameter_tuning_job(
    self,
    *,
    HyperParameterTuningJobName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_hyper_parameter_tuning_job method usage example with argument unpacking

kwargs: DeleteHyperParameterTuningJobRequestTypeDef = {  # (1)
    "HyperParameterTuningJobName": ...,
}

parent.delete_hyper_parameter_tuning_job(**kwargs)

1. See DeleteHyperParameterTuningJobRequestTypeDef

delete_image

Deletes a SageMaker AI image and all versions of the image.

Type annotations and code completion for boto3.client("sagemaker").delete_image method. boto3 documentation

# delete_image method definition

def delete_image(
    self,
    *,
    ImageName: str,
) -> Dict[str, Any]:
    ...

# delete_image method usage example with argument unpacking

kwargs: DeleteImageRequestTypeDef = {  # (1)
    "ImageName": ...,
}

parent.delete_image(**kwargs)

1. See DeleteImageRequestTypeDef

delete_image_version

Deletes a version of a SageMaker AI image.

Type annotations and code completion for boto3.client("sagemaker").delete_image_version method. boto3 documentation

# delete_image_version method definition

def delete_image_version(
    self,
    *,
    ImageName: str,
    Version: int = ...,
    Alias: str = ...,
) -> Dict[str, Any]:
    ...

# delete_image_version method usage example with argument unpacking

kwargs: DeleteImageVersionRequestTypeDef = {  # (1)
    "ImageName": ...,
}

parent.delete_image_version(**kwargs)

1. See DeleteImageVersionRequestTypeDef

delete_inference_component

Deletes an inference component.

Type annotations and code completion for boto3.client("sagemaker").delete_inference_component method. boto3 documentation

# delete_inference_component method definition

def delete_inference_component(
    self,
    *,
    InferenceComponentName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_inference_component method usage example with argument unpacking

kwargs: DeleteInferenceComponentInputTypeDef = {  # (1)
    "InferenceComponentName": ...,
}

parent.delete_inference_component(**kwargs)

1. See DeleteInferenceComponentInputTypeDef

delete_inference_experiment

Deletes an inference experiment.

Type annotations and code completion for boto3.client("sagemaker").delete_inference_experiment method. boto3 documentation

# delete_inference_experiment method definition

def delete_inference_experiment(
    self,
    *,
    Name: str,
) -> DeleteInferenceExperimentResponseTypeDef:  # (1)
    ...

1. See DeleteInferenceExperimentResponseTypeDef

# delete_inference_experiment method usage example with argument unpacking

kwargs: DeleteInferenceExperimentRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_inference_experiment(**kwargs)

1. See DeleteInferenceExperimentRequestTypeDef

delete_mlflow_tracking_server

Deletes an MLflow Tracking Server.

Type annotations and code completion for boto3.client("sagemaker").delete_mlflow_tracking_server method. boto3 documentation

# delete_mlflow_tracking_server method definition

def delete_mlflow_tracking_server(
    self,
    *,
    TrackingServerName: str,
) -> DeleteMlflowTrackingServerResponseTypeDef:  # (1)
    ...

1. See DeleteMlflowTrackingServerResponseTypeDef

# delete_mlflow_tracking_server method usage example with argument unpacking

kwargs: DeleteMlflowTrackingServerRequestTypeDef = {  # (1)
    "TrackingServerName": ...,
}

parent.delete_mlflow_tracking_server(**kwargs)

1. See DeleteMlflowTrackingServerRequestTypeDef

delete_model

Deletes a model.

Type annotations and code completion for boto3.client("sagemaker").delete_model method. boto3 documentation

# delete_model method definition

def delete_model(
    self,
    *,
    ModelName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_model method usage example with argument unpacking

kwargs: DeleteModelInputTypeDef = {  # (1)
    "ModelName": ...,
}

parent.delete_model(**kwargs)

1. See DeleteModelInputTypeDef

delete_model_bias_job_definition

Deletes an Amazon SageMaker AI model bias job definition.

Type annotations and code completion for boto3.client("sagemaker").delete_model_bias_job_definition method. boto3 documentation

# delete_model_bias_job_definition method definition

def delete_model_bias_job_definition(
    self,
    *,
    JobDefinitionName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_model_bias_job_definition method usage example with argument unpacking

kwargs: DeleteModelBiasJobDefinitionRequestTypeDef = {  # (1)
    "JobDefinitionName": ...,
}

parent.delete_model_bias_job_definition(**kwargs)

1. See DeleteModelBiasJobDefinitionRequestTypeDef

delete_model_card

Deletes an Amazon SageMaker Model Card.

Type annotations and code completion for boto3.client("sagemaker").delete_model_card method. boto3 documentation

# delete_model_card method definition

def delete_model_card(
    self,
    *,
    ModelCardName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_model_card method usage example with argument unpacking

kwargs: DeleteModelCardRequestTypeDef = {  # (1)
    "ModelCardName": ...,
}

parent.delete_model_card(**kwargs)

1. See DeleteModelCardRequestTypeDef

delete_model_explainability_job_definition

Deletes an Amazon SageMaker AI model explainability job definition.

Type annotations and code completion for boto3.client("sagemaker").delete_model_explainability_job_definition method. boto3 documentation

# delete_model_explainability_job_definition method definition

def delete_model_explainability_job_definition(
    self,
    *,
    JobDefinitionName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_model_explainability_job_definition method usage example with argument unpacking

kwargs: DeleteModelExplainabilityJobDefinitionRequestTypeDef = {  # (1)
    "JobDefinitionName": ...,
}

parent.delete_model_explainability_job_definition(**kwargs)

1. See DeleteModelExplainabilityJobDefinitionRequestTypeDef

delete_model_package

Deletes a model package.

Type annotations and code completion for boto3.client("sagemaker").delete_model_package method. boto3 documentation

# delete_model_package method definition

def delete_model_package(
    self,
    *,
    ModelPackageName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_model_package method usage example with argument unpacking

kwargs: DeleteModelPackageInputTypeDef = {  # (1)
    "ModelPackageName": ...,
}

parent.delete_model_package(**kwargs)

1. See DeleteModelPackageInputTypeDef

delete_model_package_group

Deletes the specified model group.

Type annotations and code completion for boto3.client("sagemaker").delete_model_package_group method. boto3 documentation

# delete_model_package_group method definition

def delete_model_package_group(
    self,
    *,
    ModelPackageGroupName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_model_package_group method usage example with argument unpacking

kwargs: DeleteModelPackageGroupInputTypeDef = {  # (1)
    "ModelPackageGroupName": ...,
}

parent.delete_model_package_group(**kwargs)

1. See DeleteModelPackageGroupInputTypeDef

delete_model_package_group_policy

Deletes a model group resource policy.

Type annotations and code completion for boto3.client("sagemaker").delete_model_package_group_policy method. boto3 documentation

# delete_model_package_group_policy method definition

def delete_model_package_group_policy(
    self,
    *,
    ModelPackageGroupName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_model_package_group_policy method usage example with argument unpacking

kwargs: DeleteModelPackageGroupPolicyInputTypeDef = {  # (1)
    "ModelPackageGroupName": ...,
}

parent.delete_model_package_group_policy(**kwargs)

1. See DeleteModelPackageGroupPolicyInputTypeDef

delete_model_quality_job_definition

Deletes the secified model quality monitoring job definition.

Type annotations and code completion for boto3.client("sagemaker").delete_model_quality_job_definition method. boto3 documentation

# delete_model_quality_job_definition method definition

def delete_model_quality_job_definition(
    self,
    *,
    JobDefinitionName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_model_quality_job_definition method usage example with argument unpacking

kwargs: DeleteModelQualityJobDefinitionRequestTypeDef = {  # (1)
    "JobDefinitionName": ...,
}

parent.delete_model_quality_job_definition(**kwargs)

1. See DeleteModelQualityJobDefinitionRequestTypeDef

delete_monitoring_schedule

Deletes a monitoring schedule.

Type annotations and code completion for boto3.client("sagemaker").delete_monitoring_schedule method. boto3 documentation

# delete_monitoring_schedule method definition

def delete_monitoring_schedule(
    self,
    *,
    MonitoringScheduleName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_monitoring_schedule method usage example with argument unpacking

kwargs: DeleteMonitoringScheduleRequestTypeDef = {  # (1)
    "MonitoringScheduleName": ...,
}

parent.delete_monitoring_schedule(**kwargs)

1. See DeleteMonitoringScheduleRequestTypeDef

delete_notebook_instance

Deletes an SageMaker AI notebook instance.

Type annotations and code completion for boto3.client("sagemaker").delete_notebook_instance method. boto3 documentation

# delete_notebook_instance method definition

def delete_notebook_instance(
    self,
    *,
    NotebookInstanceName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_notebook_instance method usage example with argument unpacking

kwargs: DeleteNotebookInstanceInputTypeDef = {  # (1)
    "NotebookInstanceName": ...,
}

parent.delete_notebook_instance(**kwargs)

1. See DeleteNotebookInstanceInputTypeDef

delete_notebook_instance_lifecycle_config

Deletes a notebook instance lifecycle configuration.

Type annotations and code completion for boto3.client("sagemaker").delete_notebook_instance_lifecycle_config method. boto3 documentation

# delete_notebook_instance_lifecycle_config method definition

def delete_notebook_instance_lifecycle_config(
    self,
    *,
    NotebookInstanceLifecycleConfigName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_notebook_instance_lifecycle_config method usage example with argument unpacking

kwargs: DeleteNotebookInstanceLifecycleConfigInputTypeDef = {  # (1)
    "NotebookInstanceLifecycleConfigName": ...,
}

parent.delete_notebook_instance_lifecycle_config(**kwargs)

1. See DeleteNotebookInstanceLifecycleConfigInputTypeDef

delete_optimization_job

Deletes an optimization job.

Type annotations and code completion for boto3.client("sagemaker").delete_optimization_job method. boto3 documentation

# delete_optimization_job method definition

def delete_optimization_job(
    self,
    *,
    OptimizationJobName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_optimization_job method usage example with argument unpacking

kwargs: DeleteOptimizationJobRequestTypeDef = {  # (1)
    "OptimizationJobName": ...,
}

parent.delete_optimization_job(**kwargs)

1. See DeleteOptimizationJobRequestTypeDef

delete_partner_app

Deletes a SageMaker Partner AI App.

Type annotations and code completion for boto3.client("sagemaker").delete_partner_app method. boto3 documentation

# delete_partner_app method definition

def delete_partner_app(
    self,
    *,
    Arn: str,
    ClientToken: str = ...,
) -> DeletePartnerAppResponseTypeDef:  # (1)
    ...

1. See DeletePartnerAppResponseTypeDef

# delete_partner_app method usage example with argument unpacking

kwargs: DeletePartnerAppRequestTypeDef = {  # (1)
    "Arn": ...,
}

parent.delete_partner_app(**kwargs)

1. See DeletePartnerAppRequestTypeDef

delete_pipeline

Deletes a pipeline if there are no running instances of the pipeline.

Type annotations and code completion for boto3.client("sagemaker").delete_pipeline method. boto3 documentation

# delete_pipeline method definition

def delete_pipeline(
    self,
    *,
    PipelineName: str,
    ClientRequestToken: str,
) -> DeletePipelineResponseTypeDef:  # (1)
    ...

1. See DeletePipelineResponseTypeDef

# delete_pipeline method usage example with argument unpacking

kwargs: DeletePipelineRequestTypeDef = {  # (1)
    "PipelineName": ...,
    "ClientRequestToken": ...,
}

parent.delete_pipeline(**kwargs)

1. See DeletePipelineRequestTypeDef

delete_project

Delete the specified project.

Type annotations and code completion for boto3.client("sagemaker").delete_project method. boto3 documentation

# delete_project method definition

def delete_project(
    self,
    *,
    ProjectName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_project method usage example with argument unpacking

kwargs: DeleteProjectInputTypeDef = {  # (1)
    "ProjectName": ...,
}

parent.delete_project(**kwargs)

1. See DeleteProjectInputTypeDef

delete_space

Used to delete a space.

Type annotations and code completion for boto3.client("sagemaker").delete_space method. boto3 documentation

# delete_space method definition

def delete_space(
    self,
    *,
    DomainId: str,
    SpaceName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_space method usage example with argument unpacking

kwargs: DeleteSpaceRequestTypeDef = {  # (1)
    "DomainId": ...,
    "SpaceName": ...,
}

parent.delete_space(**kwargs)

1. See DeleteSpaceRequestTypeDef

delete_studio_lifecycle_config

Deletes the Amazon SageMaker AI Studio Lifecycle Configuration.

Type annotations and code completion for boto3.client("sagemaker").delete_studio_lifecycle_config method. boto3 documentation

# delete_studio_lifecycle_config method definition

def delete_studio_lifecycle_config(
    self,
    *,
    StudioLifecycleConfigName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_studio_lifecycle_config method usage example with argument unpacking

kwargs: DeleteStudioLifecycleConfigRequestTypeDef = {  # (1)
    "StudioLifecycleConfigName": ...,
}

parent.delete_studio_lifecycle_config(**kwargs)

1. See DeleteStudioLifecycleConfigRequestTypeDef

delete_tags

Deletes the specified tags from an SageMaker resource.

Type annotations and code completion for boto3.client("sagemaker").delete_tags method. boto3 documentation

# delete_tags method definition

def delete_tags(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# delete_tags method usage example with argument unpacking

kwargs: DeleteTagsInputTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.delete_tags(**kwargs)

1. See DeleteTagsInputTypeDef

delete_trial

Deletes the specified trial.

Type annotations and code completion for boto3.client("sagemaker").delete_trial method. boto3 documentation

# delete_trial method definition

def delete_trial(
    self,
    *,
    TrialName: str,
) -> DeleteTrialResponseTypeDef:  # (1)
    ...

1. See DeleteTrialResponseTypeDef

# delete_trial method usage example with argument unpacking

kwargs: DeleteTrialRequestTypeDef = {  # (1)
    "TrialName": ...,
}

parent.delete_trial(**kwargs)

1. See DeleteTrialRequestTypeDef

delete_trial_component

Deletes the specified trial component.

Type annotations and code completion for boto3.client("sagemaker").delete_trial_component method. boto3 documentation

# delete_trial_component method definition

def delete_trial_component(
    self,
    *,
    TrialComponentName: str,
) -> DeleteTrialComponentResponseTypeDef:  # (1)
    ...

1. See DeleteTrialComponentResponseTypeDef

# delete_trial_component method usage example with argument unpacking

kwargs: DeleteTrialComponentRequestTypeDef = {  # (1)
    "TrialComponentName": ...,
}

parent.delete_trial_component(**kwargs)

1. See DeleteTrialComponentRequestTypeDef

delete_user_profile

Deletes a user profile.

Type annotations and code completion for boto3.client("sagemaker").delete_user_profile method. boto3 documentation

# delete_user_profile method definition

def delete_user_profile(
    self,
    *,
    DomainId: str,
    UserProfileName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_user_profile method usage example with argument unpacking

kwargs: DeleteUserProfileRequestTypeDef = {  # (1)
    "DomainId": ...,
    "UserProfileName": ...,
}

parent.delete_user_profile(**kwargs)

1. See DeleteUserProfileRequestTypeDef

delete_workforce

Use this operation to delete a workforce.

Type annotations and code completion for boto3.client("sagemaker").delete_workforce method. boto3 documentation

# delete_workforce method definition

def delete_workforce(
    self,
    *,
    WorkforceName: str,
) -> Dict[str, Any]:
    ...

# delete_workforce method usage example with argument unpacking

kwargs: DeleteWorkforceRequestTypeDef = {  # (1)
    "WorkforceName": ...,
}

parent.delete_workforce(**kwargs)

1. See DeleteWorkforceRequestTypeDef

delete_workteam

Deletes an existing work team.

Type annotations and code completion for boto3.client("sagemaker").delete_workteam method. boto3 documentation

# delete_workteam method definition

def delete_workteam(
    self,
    *,
    WorkteamName: str,
) -> DeleteWorkteamResponseTypeDef:  # (1)
    ...

1. See DeleteWorkteamResponseTypeDef

# delete_workteam method usage example with argument unpacking

kwargs: DeleteWorkteamRequestTypeDef = {  # (1)
    "WorkteamName": ...,
}

parent.delete_workteam(**kwargs)

1. See DeleteWorkteamRequestTypeDef

deregister_devices

Deregisters the specified devices.

Type annotations and code completion for boto3.client("sagemaker").deregister_devices method. boto3 documentation

# deregister_devices method definition

def deregister_devices(
    self,
    *,
    DeviceFleetName: str,
    DeviceNames: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# deregister_devices method usage example with argument unpacking

kwargs: DeregisterDevicesRequestTypeDef = {  # (1)
    "DeviceFleetName": ...,
    "DeviceNames": ...,
}

parent.deregister_devices(**kwargs)

1. See DeregisterDevicesRequestTypeDef

describe_action

Describes an action.

Type annotations and code completion for boto3.client("sagemaker").describe_action method. boto3 documentation

# describe_action method definition

def describe_action(
    self,
    *,
    ActionName: str,
) -> DescribeActionResponseTypeDef:  # (1)
    ...

1. See DescribeActionResponseTypeDef

# describe_action method usage example with argument unpacking

kwargs: DescribeActionRequestTypeDef = {  # (1)
    "ActionName": ...,
}

parent.describe_action(**kwargs)

1. See DescribeActionRequestTypeDef

describe_algorithm

Returns a description of the specified algorithm that is in your account.

Type annotations and code completion for boto3.client("sagemaker").describe_algorithm method. boto3 documentation

# describe_algorithm method definition

def describe_algorithm(
    self,
    *,
    AlgorithmName: str,
) -> DescribeAlgorithmOutputTypeDef:  # (1)
    ...

1. See DescribeAlgorithmOutputTypeDef

# describe_algorithm method usage example with argument unpacking

kwargs: DescribeAlgorithmInputTypeDef = {  # (1)
    "AlgorithmName": ...,
}

parent.describe_algorithm(**kwargs)

1. See DescribeAlgorithmInputTypeDef

describe_app

Describes the app.

Type annotations and code completion for boto3.client("sagemaker").describe_app method. boto3 documentation

# describe_app method definition

def describe_app(
    self,
    *,
    DomainId: str,
    AppType: AppTypeType,  # (1)
    AppName: str,
    UserProfileName: str = ...,
    SpaceName: str = ...,
) -> DescribeAppResponseTypeDef:  # (2)
    ...

1. See AppTypeType
2. See DescribeAppResponseTypeDef

# describe_app method usage example with argument unpacking

kwargs: DescribeAppRequestTypeDef = {  # (1)
    "DomainId": ...,
    "AppType": ...,
    "AppName": ...,
}

parent.describe_app(**kwargs)

1. See DescribeAppRequestTypeDef

describe_app_image_config

Describes an AppImageConfig.

Type annotations and code completion for boto3.client("sagemaker").describe_app_image_config method. boto3 documentation

# describe_app_image_config method definition

def describe_app_image_config(
    self,
    *,
    AppImageConfigName: str,
) -> DescribeAppImageConfigResponseTypeDef:  # (1)
    ...

1. See DescribeAppImageConfigResponseTypeDef

# describe_app_image_config method usage example with argument unpacking

kwargs: DescribeAppImageConfigRequestTypeDef = {  # (1)
    "AppImageConfigName": ...,
}

parent.describe_app_image_config(**kwargs)

1. See DescribeAppImageConfigRequestTypeDef

describe_artifact

Describes an artifact.

Type annotations and code completion for boto3.client("sagemaker").describe_artifact method. boto3 documentation

# describe_artifact method definition

def describe_artifact(
    self,
    *,
    ArtifactArn: str,
) -> DescribeArtifactResponseTypeDef:  # (1)
    ...

1. See DescribeArtifactResponseTypeDef

# describe_artifact method usage example with argument unpacking

kwargs: DescribeArtifactRequestTypeDef = {  # (1)
    "ArtifactArn": ...,
}

parent.describe_artifact(**kwargs)

1. See DescribeArtifactRequestTypeDef

describe_auto_ml_job

Returns information about an AutoML job created by calling CreateAutoMLJob.

Type annotations and code completion for boto3.client("sagemaker").describe_auto_ml_job method. boto3 documentation

# describe_auto_ml_job method definition

def describe_auto_ml_job(
    self,
    *,
    AutoMLJobName: str,
) -> DescribeAutoMLJobResponseTypeDef:  # (1)
    ...

1. See DescribeAutoMLJobResponseTypeDef

# describe_auto_ml_job method usage example with argument unpacking

kwargs: DescribeAutoMLJobRequestTypeDef = {  # (1)
    "AutoMLJobName": ...,
}

parent.describe_auto_ml_job(**kwargs)

1. See DescribeAutoMLJobRequestTypeDef

describe_auto_ml_job_v2

Returns information about an AutoML job created by calling CreateAutoMLJobV2 or CreateAutoMLJob.

Type annotations and code completion for boto3.client("sagemaker").describe_auto_ml_job_v2 method. boto3 documentation

# describe_auto_ml_job_v2 method definition

def describe_auto_ml_job_v2(
    self,
    *,
    AutoMLJobName: str,
) -> DescribeAutoMLJobV2ResponseTypeDef:  # (1)
    ...

1. See DescribeAutoMLJobV2ResponseTypeDef

# describe_auto_ml_job_v2 method usage example with argument unpacking

kwargs: DescribeAutoMLJobV2RequestTypeDef = {  # (1)
    "AutoMLJobName": ...,
}

parent.describe_auto_ml_job_v2(**kwargs)

1. See DescribeAutoMLJobV2RequestTypeDef

describe_cluster

Retrieves information of a SageMaker HyperPod cluster.

Type annotations and code completion for boto3.client("sagemaker").describe_cluster method. boto3 documentation

# describe_cluster method definition

def describe_cluster(
    self,
    *,
    ClusterName: str,
) -> DescribeClusterResponseTypeDef:  # (1)
    ...

1. See DescribeClusterResponseTypeDef

# describe_cluster method usage example with argument unpacking

kwargs: DescribeClusterRequestTypeDef = {  # (1)
    "ClusterName": ...,
}

parent.describe_cluster(**kwargs)

1. See DescribeClusterRequestTypeDef

describe_cluster_node

Retrieves information of a node (also called a instance interchangeably) of a SageMaker HyperPod cluster.

Type annotations and code completion for boto3.client("sagemaker").describe_cluster_node method. boto3 documentation

# describe_cluster_node method definition

def describe_cluster_node(
    self,
    *,
    ClusterName: str,
    NodeId: str,
) -> DescribeClusterNodeResponseTypeDef:  # (1)
    ...

1. See DescribeClusterNodeResponseTypeDef

# describe_cluster_node method usage example with argument unpacking

kwargs: DescribeClusterNodeRequestTypeDef = {  # (1)
    "ClusterName": ...,
    "NodeId": ...,
}

parent.describe_cluster_node(**kwargs)

1. See DescribeClusterNodeRequestTypeDef

describe_cluster_scheduler_config

Description of the cluster policy.

Type annotations and code completion for boto3.client("sagemaker").describe_cluster_scheduler_config method. boto3 documentation

# describe_cluster_scheduler_config method definition

def describe_cluster_scheduler_config(
    self,
    *,
    ClusterSchedulerConfigId: str,
    ClusterSchedulerConfigVersion: int = ...,
) -> DescribeClusterSchedulerConfigResponseTypeDef:  # (1)
    ...

1. See DescribeClusterSchedulerConfigResponseTypeDef

# describe_cluster_scheduler_config method usage example with argument unpacking

kwargs: DescribeClusterSchedulerConfigRequestTypeDef = {  # (1)
    "ClusterSchedulerConfigId": ...,
}

parent.describe_cluster_scheduler_config(**kwargs)

1. See DescribeClusterSchedulerConfigRequestTypeDef

describe_code_repository

Gets details about the specified Git repository.

Type annotations and code completion for boto3.client("sagemaker").describe_code_repository method. boto3 documentation

# describe_code_repository method definition

def describe_code_repository(
    self,
    *,
    CodeRepositoryName: str,
) -> DescribeCodeRepositoryOutputTypeDef:  # (1)
    ...

1. See DescribeCodeRepositoryOutputTypeDef

# describe_code_repository method usage example with argument unpacking

kwargs: DescribeCodeRepositoryInputTypeDef = {  # (1)
    "CodeRepositoryName": ...,
}

parent.describe_code_repository(**kwargs)

1. See DescribeCodeRepositoryInputTypeDef

describe_compilation_job

Returns information about a model compilation job.

Type annotations and code completion for boto3.client("sagemaker").describe_compilation_job method. boto3 documentation

# describe_compilation_job method definition

def describe_compilation_job(
    self,
    *,
    CompilationJobName: str,
) -> DescribeCompilationJobResponseTypeDef:  # (1)
    ...

1. See DescribeCompilationJobResponseTypeDef

# describe_compilation_job method usage example with argument unpacking

kwargs: DescribeCompilationJobRequestTypeDef = {  # (1)
    "CompilationJobName": ...,
}

parent.describe_compilation_job(**kwargs)

1. See DescribeCompilationJobRequestTypeDef

describe_compute_quota

Description of the compute allocation definition.

Type annotations and code completion for boto3.client("sagemaker").describe_compute_quota method. boto3 documentation

# describe_compute_quota method definition

def describe_compute_quota(
    self,
    *,
    ComputeQuotaId: str,
    ComputeQuotaVersion: int = ...,
) -> DescribeComputeQuotaResponseTypeDef:  # (1)
    ...

1. See DescribeComputeQuotaResponseTypeDef

# describe_compute_quota method usage example with argument unpacking

kwargs: DescribeComputeQuotaRequestTypeDef = {  # (1)
    "ComputeQuotaId": ...,
}

parent.describe_compute_quota(**kwargs)

1. See DescribeComputeQuotaRequestTypeDef

describe_context

Describes a context.

Type annotations and code completion for boto3.client("sagemaker").describe_context method. boto3 documentation

# describe_context method definition

def describe_context(
    self,
    *,
    ContextName: str,
) -> DescribeContextResponseTypeDef:  # (1)
    ...

1. See DescribeContextResponseTypeDef

# describe_context method usage example with argument unpacking

kwargs: DescribeContextRequestTypeDef = {  # (1)
    "ContextName": ...,
}

parent.describe_context(**kwargs)

1. See DescribeContextRequestTypeDef

describe_data_quality_job_definition

Gets the details of a data quality monitoring job definition.

Type annotations and code completion for boto3.client("sagemaker").describe_data_quality_job_definition method. boto3 documentation

# describe_data_quality_job_definition method definition

def describe_data_quality_job_definition(
    self,
    *,
    JobDefinitionName: str,
) -> DescribeDataQualityJobDefinitionResponseTypeDef:  # (1)
    ...

1. See DescribeDataQualityJobDefinitionResponseTypeDef

# describe_data_quality_job_definition method usage example with argument unpacking

kwargs: DescribeDataQualityJobDefinitionRequestTypeDef = {  # (1)
    "JobDefinitionName": ...,
}

parent.describe_data_quality_job_definition(**kwargs)

1. See DescribeDataQualityJobDefinitionRequestTypeDef

describe_device

Describes the device.

Type annotations and code completion for boto3.client("sagemaker").describe_device method. boto3 documentation

# describe_device method definition

def describe_device(
    self,
    *,
    DeviceName: str,
    DeviceFleetName: str,
    NextToken: str = ...,
) -> DescribeDeviceResponseTypeDef:  # (1)
    ...

1. See DescribeDeviceResponseTypeDef

# describe_device method usage example with argument unpacking

kwargs: DescribeDeviceRequestTypeDef = {  # (1)
    "DeviceName": ...,
    "DeviceFleetName": ...,
}

parent.describe_device(**kwargs)

1. See DescribeDeviceRequestTypeDef

describe_device_fleet

A description of the fleet the device belongs to.

Type annotations and code completion for boto3.client("sagemaker").describe_device_fleet method. boto3 documentation

# describe_device_fleet method definition

def describe_device_fleet(
    self,
    *,
    DeviceFleetName: str,
) -> DescribeDeviceFleetResponseTypeDef:  # (1)
    ...

1. See DescribeDeviceFleetResponseTypeDef

# describe_device_fleet method usage example with argument unpacking

kwargs: DescribeDeviceFleetRequestTypeDef = {  # (1)
    "DeviceFleetName": ...,
}

parent.describe_device_fleet(**kwargs)

1. See DescribeDeviceFleetRequestTypeDef

describe_domain

The description of the domain.

Type annotations and code completion for boto3.client("sagemaker").describe_domain method. boto3 documentation

# describe_domain method definition

def describe_domain(
    self,
    *,
    DomainId: str,
) -> DescribeDomainResponseTypeDef:  # (1)
    ...

1. See DescribeDomainResponseTypeDef

# describe_domain method usage example with argument unpacking

kwargs: DescribeDomainRequestTypeDef = {  # (1)
    "DomainId": ...,
}

parent.describe_domain(**kwargs)

1. See DescribeDomainRequestTypeDef

describe_edge_deployment_plan

Describes an edge deployment plan with deployment status per stage.

Type annotations and code completion for boto3.client("sagemaker").describe_edge_deployment_plan method. boto3 documentation

# describe_edge_deployment_plan method definition

def describe_edge_deployment_plan(
    self,
    *,
    EdgeDeploymentPlanName: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeEdgeDeploymentPlanResponseTypeDef:  # (1)
    ...

1. See DescribeEdgeDeploymentPlanResponseTypeDef

# describe_edge_deployment_plan method usage example with argument unpacking

kwargs: DescribeEdgeDeploymentPlanRequestTypeDef = {  # (1)
    "EdgeDeploymentPlanName": ...,
}

parent.describe_edge_deployment_plan(**kwargs)

1. See DescribeEdgeDeploymentPlanRequestTypeDef

describe_edge_packaging_job

A description of edge packaging jobs.

Type annotations and code completion for boto3.client("sagemaker").describe_edge_packaging_job method. boto3 documentation

# describe_edge_packaging_job method definition

def describe_edge_packaging_job(
    self,
    *,
    EdgePackagingJobName: str,
) -> DescribeEdgePackagingJobResponseTypeDef:  # (1)
    ...

1. See DescribeEdgePackagingJobResponseTypeDef

# describe_edge_packaging_job method usage example with argument unpacking

kwargs: DescribeEdgePackagingJobRequestTypeDef = {  # (1)
    "EdgePackagingJobName": ...,
}

parent.describe_edge_packaging_job(**kwargs)

1. See DescribeEdgePackagingJobRequestTypeDef

describe_endpoint

Returns the description of an endpoint.

Type annotations and code completion for boto3.client("sagemaker").describe_endpoint method. boto3 documentation

# describe_endpoint method definition

def describe_endpoint(
    self,
    *,
    EndpointName: str,
) -> DescribeEndpointOutputTypeDef:  # (1)
    ...

1. See DescribeEndpointOutputTypeDef

# describe_endpoint method usage example with argument unpacking

kwargs: DescribeEndpointInputTypeDef = {  # (1)
    "EndpointName": ...,
}

parent.describe_endpoint(**kwargs)

1. See DescribeEndpointInputTypeDef

describe_endpoint_config

Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

Type annotations and code completion for boto3.client("sagemaker").describe_endpoint_config method. boto3 documentation

# describe_endpoint_config method definition

def describe_endpoint_config(
    self,
    *,
    EndpointConfigName: str,
) -> DescribeEndpointConfigOutputTypeDef:  # (1)
    ...

1. See DescribeEndpointConfigOutputTypeDef

# describe_endpoint_config method usage example with argument unpacking

kwargs: DescribeEndpointConfigInputTypeDef = {  # (1)
    "EndpointConfigName": ...,
}

parent.describe_endpoint_config(**kwargs)

1. See DescribeEndpointConfigInputTypeDef

describe_experiment

Provides a list of an experiment's properties.

Type annotations and code completion for boto3.client("sagemaker").describe_experiment method. boto3 documentation

# describe_experiment method definition

def describe_experiment(
    self,
    *,
    ExperimentName: str,
) -> DescribeExperimentResponseTypeDef:  # (1)
    ...

1. See DescribeExperimentResponseTypeDef

# describe_experiment method usage example with argument unpacking

kwargs: DescribeExperimentRequestTypeDef = {  # (1)
    "ExperimentName": ...,
}

parent.describe_experiment(**kwargs)

1. See DescribeExperimentRequestTypeDef

describe_feature_group

Use this operation to describe a FeatureGroup.

Type annotations and code completion for boto3.client("sagemaker").describe_feature_group method. boto3 documentation

# describe_feature_group method definition

def describe_feature_group(
    self,
    *,
    FeatureGroupName: str,
    NextToken: str = ...,
) -> DescribeFeatureGroupResponseTypeDef:  # (1)
    ...

1. See DescribeFeatureGroupResponseTypeDef

# describe_feature_group method usage example with argument unpacking

kwargs: DescribeFeatureGroupRequestTypeDef = {  # (1)
    "FeatureGroupName": ...,
}

parent.describe_feature_group(**kwargs)

1. See DescribeFeatureGroupRequestTypeDef

describe_feature_metadata

Shows the metadata for a feature within a feature group.

Type annotations and code completion for boto3.client("sagemaker").describe_feature_metadata method. boto3 documentation

# describe_feature_metadata method definition

def describe_feature_metadata(
    self,
    *,
    FeatureGroupName: str,
    FeatureName: str,
) -> DescribeFeatureMetadataResponseTypeDef:  # (1)
    ...

1. See DescribeFeatureMetadataResponseTypeDef

# describe_feature_metadata method usage example with argument unpacking

kwargs: DescribeFeatureMetadataRequestTypeDef = {  # (1)
    "FeatureGroupName": ...,
    "FeatureName": ...,
}

parent.describe_feature_metadata(**kwargs)

1. See DescribeFeatureMetadataRequestTypeDef

describe_flow_definition

Returns information about the specified flow definition.

Type annotations and code completion for boto3.client("sagemaker").describe_flow_definition method. boto3 documentation

# describe_flow_definition method definition

def describe_flow_definition(
    self,
    *,
    FlowDefinitionName: str,
) -> DescribeFlowDefinitionResponseTypeDef:  # (1)
    ...

1. See DescribeFlowDefinitionResponseTypeDef

# describe_flow_definition method usage example with argument unpacking

kwargs: DescribeFlowDefinitionRequestTypeDef = {  # (1)
    "FlowDefinitionName": ...,
}

parent.describe_flow_definition(**kwargs)

1. See DescribeFlowDefinitionRequestTypeDef

describe_hub

Describes a hub.

Type annotations and code completion for boto3.client("sagemaker").describe_hub method. boto3 documentation

# describe_hub method definition

def describe_hub(
    self,
    *,
    HubName: str,
) -> DescribeHubResponseTypeDef:  # (1)
    ...

1. See DescribeHubResponseTypeDef

# describe_hub method usage example with argument unpacking

kwargs: DescribeHubRequestTypeDef = {  # (1)
    "HubName": ...,
}

parent.describe_hub(**kwargs)

1. See DescribeHubRequestTypeDef

describe_hub_content

Describe the content of a hub.

Type annotations and code completion for boto3.client("sagemaker").describe_hub_content method. boto3 documentation

# describe_hub_content method definition

def describe_hub_content(
    self,
    *,
    HubName: str,
    HubContentType: HubContentTypeType,  # (1)
    HubContentName: str,
    HubContentVersion: str = ...,
) -> DescribeHubContentResponseTypeDef:  # (2)
    ...

1. See HubContentTypeType
2. See DescribeHubContentResponseTypeDef

# describe_hub_content method usage example with argument unpacking

kwargs: DescribeHubContentRequestTypeDef = {  # (1)
    "HubName": ...,
    "HubContentType": ...,
    "HubContentName": ...,
}

parent.describe_hub_content(**kwargs)

1. See DescribeHubContentRequestTypeDef

describe_human_task_ui

Returns information about the requested human task user interface (worker task template).

Type annotations and code completion for boto3.client("sagemaker").describe_human_task_ui method. boto3 documentation

# describe_human_task_ui method definition

def describe_human_task_ui(
    self,
    *,
    HumanTaskUiName: str,
) -> DescribeHumanTaskUiResponseTypeDef:  # (1)
    ...

1. See DescribeHumanTaskUiResponseTypeDef

# describe_human_task_ui method usage example with argument unpacking

kwargs: DescribeHumanTaskUiRequestTypeDef = {  # (1)
    "HumanTaskUiName": ...,
}

parent.describe_human_task_ui(**kwargs)

1. See DescribeHumanTaskUiRequestTypeDef

describe_hyper_parameter_tuning_job

Returns a description of a hyperparameter tuning job, depending on the fields selected.

Type annotations and code completion for boto3.client("sagemaker").describe_hyper_parameter_tuning_job method. boto3 documentation

# describe_hyper_parameter_tuning_job method definition

def describe_hyper_parameter_tuning_job(
    self,
    *,
    HyperParameterTuningJobName: str,
) -> DescribeHyperParameterTuningJobResponseTypeDef:  # (1)
    ...

1. See DescribeHyperParameterTuningJobResponseTypeDef

# describe_hyper_parameter_tuning_job method usage example with argument unpacking

kwargs: DescribeHyperParameterTuningJobRequestTypeDef = {  # (1)
    "HyperParameterTuningJobName": ...,
}

parent.describe_hyper_parameter_tuning_job(**kwargs)

1. See DescribeHyperParameterTuningJobRequestTypeDef

describe_image

Describes a SageMaker AI image.

Type annotations and code completion for boto3.client("sagemaker").describe_image method. boto3 documentation

# describe_image method definition

def describe_image(
    self,
    *,
    ImageName: str,
) -> DescribeImageResponseTypeDef:  # (1)
    ...

1. See DescribeImageResponseTypeDef

# describe_image method usage example with argument unpacking

kwargs: DescribeImageRequestTypeDef = {  # (1)
    "ImageName": ...,
}

parent.describe_image(**kwargs)

1. See DescribeImageRequestTypeDef

describe_image_version

Describes a version of a SageMaker AI image.

Type annotations and code completion for boto3.client("sagemaker").describe_image_version method. boto3 documentation

# describe_image_version method definition

def describe_image_version(
    self,
    *,
    ImageName: str,
    Version: int = ...,
    Alias: str = ...,
) -> DescribeImageVersionResponseTypeDef:  # (1)
    ...

1. See DescribeImageVersionResponseTypeDef

# describe_image_version method usage example with argument unpacking

kwargs: DescribeImageVersionRequestTypeDef = {  # (1)
    "ImageName": ...,
}

parent.describe_image_version(**kwargs)

1. See DescribeImageVersionRequestTypeDef

describe_inference_component

Returns information about an inference component.

Type annotations and code completion for boto3.client("sagemaker").describe_inference_component method. boto3 documentation

# describe_inference_component method definition

def describe_inference_component(
    self,
    *,
    InferenceComponentName: str,
) -> DescribeInferenceComponentOutputTypeDef:  # (1)
    ...

1. See DescribeInferenceComponentOutputTypeDef

# describe_inference_component method usage example with argument unpacking

kwargs: DescribeInferenceComponentInputTypeDef = {  # (1)
    "InferenceComponentName": ...,
}

parent.describe_inference_component(**kwargs)

1. See DescribeInferenceComponentInputTypeDef

describe_inference_experiment

Returns details about an inference experiment.

Type annotations and code completion for boto3.client("sagemaker").describe_inference_experiment method. boto3 documentation

# describe_inference_experiment method definition

def describe_inference_experiment(
    self,
    *,
    Name: str,
) -> DescribeInferenceExperimentResponseTypeDef:  # (1)
    ...

1. See DescribeInferenceExperimentResponseTypeDef

# describe_inference_experiment method usage example with argument unpacking

kwargs: DescribeInferenceExperimentRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.describe_inference_experiment(**kwargs)

1. See DescribeInferenceExperimentRequestTypeDef

describe_inference_recommendations_job

Provides the results of the Inference Recommender job.

Type annotations and code completion for boto3.client("sagemaker").describe_inference_recommendations_job method. boto3 documentation

# describe_inference_recommendations_job method definition

def describe_inference_recommendations_job(
    self,
    *,
    JobName: str,
) -> DescribeInferenceRecommendationsJobResponseTypeDef:  # (1)
    ...

1. See DescribeInferenceRecommendationsJobResponseTypeDef

# describe_inference_recommendations_job method usage example with argument unpacking

kwargs: DescribeInferenceRecommendationsJobRequestTypeDef = {  # (1)
    "JobName": ...,
}

parent.describe_inference_recommendations_job(**kwargs)

1. See DescribeInferenceRecommendationsJobRequestTypeDef

describe_labeling_job

Gets information about a labeling job.

Type annotations and code completion for boto3.client("sagemaker").describe_labeling_job method. boto3 documentation

# describe_labeling_job method definition

def describe_labeling_job(
    self,
    *,
    LabelingJobName: str,
) -> DescribeLabelingJobResponseTypeDef:  # (1)
    ...

1. See DescribeLabelingJobResponseTypeDef

# describe_labeling_job method usage example with argument unpacking

kwargs: DescribeLabelingJobRequestTypeDef = {  # (1)
    "LabelingJobName": ...,
}

parent.describe_labeling_job(**kwargs)

1. See DescribeLabelingJobRequestTypeDef

describe_lineage_group

Provides a list of properties for the requested lineage group.

Type annotations and code completion for boto3.client("sagemaker").describe_lineage_group method. boto3 documentation

# describe_lineage_group method definition

def describe_lineage_group(
    self,
    *,
    LineageGroupName: str,
) -> DescribeLineageGroupResponseTypeDef:  # (1)
    ...

1. See DescribeLineageGroupResponseTypeDef

# describe_lineage_group method usage example with argument unpacking

kwargs: DescribeLineageGroupRequestTypeDef = {  # (1)
    "LineageGroupName": ...,
}

parent.describe_lineage_group(**kwargs)

1. See DescribeLineageGroupRequestTypeDef

describe_mlflow_tracking_server

Returns information about an MLflow Tracking Server.

Type annotations and code completion for boto3.client("sagemaker").describe_mlflow_tracking_server method. boto3 documentation

# describe_mlflow_tracking_server method definition

def describe_mlflow_tracking_server(
    self,
    *,
    TrackingServerName: str,
) -> DescribeMlflowTrackingServerResponseTypeDef:  # (1)
    ...

1. See DescribeMlflowTrackingServerResponseTypeDef

# describe_mlflow_tracking_server method usage example with argument unpacking

kwargs: DescribeMlflowTrackingServerRequestTypeDef = {  # (1)
    "TrackingServerName": ...,
}

parent.describe_mlflow_tracking_server(**kwargs)

1. See DescribeMlflowTrackingServerRequestTypeDef

describe_model

Describes a model that you created using the CreateModel API.

Type annotations and code completion for boto3.client("sagemaker").describe_model method. boto3 documentation

# describe_model method definition

def describe_model(
    self,
    *,
    ModelName: str,
) -> DescribeModelOutputTypeDef:  # (1)
    ...

1. See DescribeModelOutputTypeDef

# describe_model method usage example with argument unpacking

kwargs: DescribeModelInputTypeDef = {  # (1)
    "ModelName": ...,
}

parent.describe_model(**kwargs)

1. See DescribeModelInputTypeDef

describe_model_bias_job_definition

Returns a description of a model bias job definition.

Type annotations and code completion for boto3.client("sagemaker").describe_model_bias_job_definition method. boto3 documentation

# describe_model_bias_job_definition method definition

def describe_model_bias_job_definition(
    self,
    *,
    JobDefinitionName: str,
) -> DescribeModelBiasJobDefinitionResponseTypeDef:  # (1)
    ...

1. See DescribeModelBiasJobDefinitionResponseTypeDef

# describe_model_bias_job_definition method usage example with argument unpacking

kwargs: DescribeModelBiasJobDefinitionRequestTypeDef = {  # (1)
    "JobDefinitionName": ...,
}

parent.describe_model_bias_job_definition(**kwargs)

1. See DescribeModelBiasJobDefinitionRequestTypeDef

describe_model_card

Describes the content, creation time, and security configuration of an Amazon SageMaker Model Card.

Type annotations and code completion for boto3.client("sagemaker").describe_model_card method. boto3 documentation

# describe_model_card method definition

def describe_model_card(
    self,
    *,
    ModelCardName: str,
    ModelCardVersion: int = ...,
) -> DescribeModelCardResponseTypeDef:  # (1)
    ...

1. See DescribeModelCardResponseTypeDef

# describe_model_card method usage example with argument unpacking

kwargs: DescribeModelCardRequestTypeDef = {  # (1)
    "ModelCardName": ...,
}

parent.describe_model_card(**kwargs)

1. See DescribeModelCardRequestTypeDef

describe_model_card_export_job

Describes an Amazon SageMaker Model Card export job.

Type annotations and code completion for boto3.client("sagemaker").describe_model_card_export_job method. boto3 documentation

# describe_model_card_export_job method definition

def describe_model_card_export_job(
    self,
    *,
    ModelCardExportJobArn: str,
) -> DescribeModelCardExportJobResponseTypeDef:  # (1)
    ...

1. See DescribeModelCardExportJobResponseTypeDef

# describe_model_card_export_job method usage example with argument unpacking

kwargs: DescribeModelCardExportJobRequestTypeDef = {  # (1)
    "ModelCardExportJobArn": ...,
}

parent.describe_model_card_export_job(**kwargs)

1. See DescribeModelCardExportJobRequestTypeDef

describe_model_explainability_job_definition

Returns a description of a model explainability job definition.

Type annotations and code completion for boto3.client("sagemaker").describe_model_explainability_job_definition method. boto3 documentation

# describe_model_explainability_job_definition method definition

def describe_model_explainability_job_definition(
    self,
    *,
    JobDefinitionName: str,
) -> DescribeModelExplainabilityJobDefinitionResponseTypeDef:  # (1)
    ...

1. See DescribeModelExplainabilityJobDefinitionResponseTypeDef

# describe_model_explainability_job_definition method usage example with argument unpacking

kwargs: DescribeModelExplainabilityJobDefinitionRequestTypeDef = {  # (1)
    "JobDefinitionName": ...,
}

parent.describe_model_explainability_job_definition(**kwargs)

1. See DescribeModelExplainabilityJobDefinitionRequestTypeDef

describe_model_package

Returns a description of the specified model package, which is used to create SageMaker models or list them on Amazon Web Services Marketplace.

Type annotations and code completion for boto3.client("sagemaker").describe_model_package method. boto3 documentation

# describe_model_package method definition

def describe_model_package(
    self,
    *,
    ModelPackageName: str,
) -> DescribeModelPackageOutputTypeDef:  # (1)
    ...

1. See DescribeModelPackageOutputTypeDef

# describe_model_package method usage example with argument unpacking

kwargs: DescribeModelPackageInputTypeDef = {  # (1)
    "ModelPackageName": ...,
}

parent.describe_model_package(**kwargs)

1. See DescribeModelPackageInputTypeDef

describe_model_package_group

Gets a description for the specified model group.

Type annotations and code completion for boto3.client("sagemaker").describe_model_package_group method. boto3 documentation

# describe_model_package_group method definition

def describe_model_package_group(
    self,
    *,
    ModelPackageGroupName: str,
) -> DescribeModelPackageGroupOutputTypeDef:  # (1)
    ...

1. See DescribeModelPackageGroupOutputTypeDef

# describe_model_package_group method usage example with argument unpacking

kwargs: DescribeModelPackageGroupInputTypeDef = {  # (1)
    "ModelPackageGroupName": ...,
}

parent.describe_model_package_group(**kwargs)

1. See DescribeModelPackageGroupInputTypeDef

describe_model_quality_job_definition

Returns a description of a model quality job definition.

Type annotations and code completion for boto3.client("sagemaker").describe_model_quality_job_definition method. boto3 documentation

# describe_model_quality_job_definition method definition

def describe_model_quality_job_definition(
    self,
    *,
    JobDefinitionName: str,
) -> DescribeModelQualityJobDefinitionResponseTypeDef:  # (1)
    ...

1. See DescribeModelQualityJobDefinitionResponseTypeDef

# describe_model_quality_job_definition method usage example with argument unpacking

kwargs: DescribeModelQualityJobDefinitionRequestTypeDef = {  # (1)
    "JobDefinitionName": ...,
}

parent.describe_model_quality_job_definition(**kwargs)

1. See DescribeModelQualityJobDefinitionRequestTypeDef

describe_monitoring_schedule

Describes the schedule for a monitoring job.

Type annotations and code completion for boto3.client("sagemaker").describe_monitoring_schedule method. boto3 documentation

# describe_monitoring_schedule method definition

def describe_monitoring_schedule(
    self,
    *,
    MonitoringScheduleName: str,
) -> DescribeMonitoringScheduleResponseTypeDef:  # (1)
    ...

1. See DescribeMonitoringScheduleResponseTypeDef

# describe_monitoring_schedule method usage example with argument unpacking

kwargs: DescribeMonitoringScheduleRequestTypeDef = {  # (1)
    "MonitoringScheduleName": ...,
}

parent.describe_monitoring_schedule(**kwargs)

1. See DescribeMonitoringScheduleRequestTypeDef

describe_notebook_instance

Returns information about a notebook instance.

Type annotations and code completion for boto3.client("sagemaker").describe_notebook_instance method. boto3 documentation

# describe_notebook_instance method definition

def describe_notebook_instance(
    self,
    *,
    NotebookInstanceName: str,
) -> DescribeNotebookInstanceOutputTypeDef:  # (1)
    ...

1. See DescribeNotebookInstanceOutputTypeDef

# describe_notebook_instance method usage example with argument unpacking

kwargs: DescribeNotebookInstanceInputTypeDef = {  # (1)
    "NotebookInstanceName": ...,
}

parent.describe_notebook_instance(**kwargs)

1. See DescribeNotebookInstanceInputTypeDef

describe_notebook_instance_lifecycle_config

Returns a description of a notebook instance lifecycle configuration.

Type annotations and code completion for boto3.client("sagemaker").describe_notebook_instance_lifecycle_config method. boto3 documentation

# describe_notebook_instance_lifecycle_config method definition

def describe_notebook_instance_lifecycle_config(
    self,
    *,
    NotebookInstanceLifecycleConfigName: str,
) -> DescribeNotebookInstanceLifecycleConfigOutputTypeDef:  # (1)
    ...

1. See DescribeNotebookInstanceLifecycleConfigOutputTypeDef

# describe_notebook_instance_lifecycle_config method usage example with argument unpacking

kwargs: DescribeNotebookInstanceLifecycleConfigInputTypeDef = {  # (1)
    "NotebookInstanceLifecycleConfigName": ...,
}

parent.describe_notebook_instance_lifecycle_config(**kwargs)

1. See DescribeNotebookInstanceLifecycleConfigInputTypeDef

describe_optimization_job

Provides the properties of the specified optimization job.

Type annotations and code completion for boto3.client("sagemaker").describe_optimization_job method. boto3 documentation

# describe_optimization_job method definition

def describe_optimization_job(
    self,
    *,
    OptimizationJobName: str,
) -> DescribeOptimizationJobResponseTypeDef:  # (1)
    ...

1. See DescribeOptimizationJobResponseTypeDef

# describe_optimization_job method usage example with argument unpacking

kwargs: DescribeOptimizationJobRequestTypeDef = {  # (1)
    "OptimizationJobName": ...,
}

parent.describe_optimization_job(**kwargs)

1. See DescribeOptimizationJobRequestTypeDef

describe_partner_app

Gets information about a SageMaker Partner AI App.

Type annotations and code completion for boto3.client("sagemaker").describe_partner_app method. boto3 documentation

# describe_partner_app method definition

def describe_partner_app(
    self,
    *,
    Arn: str,
) -> DescribePartnerAppResponseTypeDef:  # (1)
    ...

1. See DescribePartnerAppResponseTypeDef

# describe_partner_app method usage example with argument unpacking

kwargs: DescribePartnerAppRequestTypeDef = {  # (1)
    "Arn": ...,
}

parent.describe_partner_app(**kwargs)

1. See DescribePartnerAppRequestTypeDef

describe_pipeline

Describes the details of a pipeline.

Type annotations and code completion for boto3.client("sagemaker").describe_pipeline method. boto3 documentation

# describe_pipeline method definition

def describe_pipeline(
    self,
    *,
    PipelineName: str,
) -> DescribePipelineResponseTypeDef:  # (1)
    ...

1. See DescribePipelineResponseTypeDef

# describe_pipeline method usage example with argument unpacking

kwargs: DescribePipelineRequestTypeDef = {  # (1)
    "PipelineName": ...,
}

parent.describe_pipeline(**kwargs)

1. See DescribePipelineRequestTypeDef

describe_pipeline_definition_for_execution

Describes the details of an execution's pipeline definition.

Type annotations and code completion for boto3.client("sagemaker").describe_pipeline_definition_for_execution method. boto3 documentation

# describe_pipeline_definition_for_execution method definition

def describe_pipeline_definition_for_execution(
    self,
    *,
    PipelineExecutionArn: str,
) -> DescribePipelineDefinitionForExecutionResponseTypeDef:  # (1)
    ...

1. See DescribePipelineDefinitionForExecutionResponseTypeDef

# describe_pipeline_definition_for_execution method usage example with argument unpacking

kwargs: DescribePipelineDefinitionForExecutionRequestTypeDef = {  # (1)
    "PipelineExecutionArn": ...,
}

parent.describe_pipeline_definition_for_execution(**kwargs)

1. See DescribePipelineDefinitionForExecutionRequestTypeDef

describe_pipeline_execution

Describes the details of a pipeline execution.

Type annotations and code completion for boto3.client("sagemaker").describe_pipeline_execution method. boto3 documentation

# describe_pipeline_execution method definition

def describe_pipeline_execution(
    self,
    *,
    PipelineExecutionArn: str,
) -> DescribePipelineExecutionResponseTypeDef:  # (1)
    ...

1. See DescribePipelineExecutionResponseTypeDef

# describe_pipeline_execution method usage example with argument unpacking

kwargs: DescribePipelineExecutionRequestTypeDef = {  # (1)
    "PipelineExecutionArn": ...,
}

parent.describe_pipeline_execution(**kwargs)

1. See DescribePipelineExecutionRequestTypeDef

describe_processing_job

Returns a description of a processing job.

Type annotations and code completion for boto3.client("sagemaker").describe_processing_job method. boto3 documentation

# describe_processing_job method definition

def describe_processing_job(
    self,
    *,
    ProcessingJobName: str,
) -> DescribeProcessingJobResponseTypeDef:  # (1)
    ...

1. See DescribeProcessingJobResponseTypeDef

# describe_processing_job method usage example with argument unpacking

kwargs: DescribeProcessingJobRequestTypeDef = {  # (1)
    "ProcessingJobName": ...,
}

parent.describe_processing_job(**kwargs)

1. See DescribeProcessingJobRequestTypeDef

describe_project

Describes the details of a project.

Type annotations and code completion for boto3.client("sagemaker").describe_project method. boto3 documentation

# describe_project method definition

def describe_project(
    self,
    *,
    ProjectName: str,
) -> DescribeProjectOutputTypeDef:  # (1)
    ...

1. See DescribeProjectOutputTypeDef

# describe_project method usage example with argument unpacking

kwargs: DescribeProjectInputTypeDef = {  # (1)
    "ProjectName": ...,
}

parent.describe_project(**kwargs)

1. See DescribeProjectInputTypeDef

describe_space

Describes the space.

Type annotations and code completion for boto3.client("sagemaker").describe_space method. boto3 documentation

# describe_space method definition

def describe_space(
    self,
    *,
    DomainId: str,
    SpaceName: str,
) -> DescribeSpaceResponseTypeDef:  # (1)
    ...

1. See DescribeSpaceResponseTypeDef

# describe_space method usage example with argument unpacking

kwargs: DescribeSpaceRequestTypeDef = {  # (1)
    "DomainId": ...,
    "SpaceName": ...,
}

parent.describe_space(**kwargs)

1. See DescribeSpaceRequestTypeDef

describe_studio_lifecycle_config

Describes the Amazon SageMaker AI Studio Lifecycle Configuration.

Type annotations and code completion for boto3.client("sagemaker").describe_studio_lifecycle_config method. boto3 documentation

# describe_studio_lifecycle_config method definition

def describe_studio_lifecycle_config(
    self,
    *,
    StudioLifecycleConfigName: str,
) -> DescribeStudioLifecycleConfigResponseTypeDef:  # (1)
    ...

1. See DescribeStudioLifecycleConfigResponseTypeDef

# describe_studio_lifecycle_config method usage example with argument unpacking

kwargs: DescribeStudioLifecycleConfigRequestTypeDef = {  # (1)
    "StudioLifecycleConfigName": ...,
}

parent.describe_studio_lifecycle_config(**kwargs)

1. See DescribeStudioLifecycleConfigRequestTypeDef

describe_subscribed_workteam

Gets information about a work team provided by a vendor.

Type annotations and code completion for boto3.client("sagemaker").describe_subscribed_workteam method. boto3 documentation

# describe_subscribed_workteam method definition

def describe_subscribed_workteam(
    self,
    *,
    WorkteamArn: str,
) -> DescribeSubscribedWorkteamResponseTypeDef:  # (1)
    ...

1. See DescribeSubscribedWorkteamResponseTypeDef

# describe_subscribed_workteam method usage example with argument unpacking

kwargs: DescribeSubscribedWorkteamRequestTypeDef = {  # (1)
    "WorkteamArn": ...,
}

parent.describe_subscribed_workteam(**kwargs)

1. See DescribeSubscribedWorkteamRequestTypeDef

describe_training_job

Returns information about a training job.

Type annotations and code completion for boto3.client("sagemaker").describe_training_job method. boto3 documentation

# describe_training_job method definition

def describe_training_job(
    self,
    *,
    TrainingJobName: str,
) -> DescribeTrainingJobResponseTypeDef:  # (1)
    ...

1. See DescribeTrainingJobResponseTypeDef

# describe_training_job method usage example with argument unpacking

kwargs: DescribeTrainingJobRequestTypeDef = {  # (1)
    "TrainingJobName": ...,
}

parent.describe_training_job(**kwargs)

1. See DescribeTrainingJobRequestTypeDef

describe_training_plan

Retrieves detailed information about a specific training plan.

Type annotations and code completion for boto3.client("sagemaker").describe_training_plan method. boto3 documentation

# describe_training_plan method definition

def describe_training_plan(
    self,
    *,
    TrainingPlanName: str,
) -> DescribeTrainingPlanResponseTypeDef:  # (1)
    ...

1. See DescribeTrainingPlanResponseTypeDef

# describe_training_plan method usage example with argument unpacking

kwargs: DescribeTrainingPlanRequestTypeDef = {  # (1)
    "TrainingPlanName": ...,
}

parent.describe_training_plan(**kwargs)

1. See DescribeTrainingPlanRequestTypeDef

describe_transform_job

Returns information about a transform job.

Type annotations and code completion for boto3.client("sagemaker").describe_transform_job method. boto3 documentation

# describe_transform_job method definition

def describe_transform_job(
    self,
    *,
    TransformJobName: str,
) -> DescribeTransformJobResponseTypeDef:  # (1)
    ...

1. See DescribeTransformJobResponseTypeDef

# describe_transform_job method usage example with argument unpacking

kwargs: DescribeTransformJobRequestTypeDef = {  # (1)
    "TransformJobName": ...,
}

parent.describe_transform_job(**kwargs)

1. See DescribeTransformJobRequestTypeDef

describe_trial

Provides a list of a trial's properties.

Type annotations and code completion for boto3.client("sagemaker").describe_trial method. boto3 documentation

# describe_trial method definition

def describe_trial(
    self,
    *,
    TrialName: str,
) -> DescribeTrialResponseTypeDef:  # (1)
    ...

1. See DescribeTrialResponseTypeDef

# describe_trial method usage example with argument unpacking

kwargs: DescribeTrialRequestTypeDef = {  # (1)
    "TrialName": ...,
}

parent.describe_trial(**kwargs)

1. See DescribeTrialRequestTypeDef

describe_trial_component

Provides a list of a trials component's properties.

Type annotations and code completion for boto3.client("sagemaker").describe_trial_component method. boto3 documentation

# describe_trial_component method definition

def describe_trial_component(
    self,
    *,
    TrialComponentName: str,
) -> DescribeTrialComponentResponseTypeDef:  # (1)
    ...

1. See DescribeTrialComponentResponseTypeDef

# describe_trial_component method usage example with argument unpacking

kwargs: DescribeTrialComponentRequestTypeDef = {  # (1)
    "TrialComponentName": ...,
}

parent.describe_trial_component(**kwargs)

1. See DescribeTrialComponentRequestTypeDef

describe_user_profile

Describes a user profile.

Type annotations and code completion for boto3.client("sagemaker").describe_user_profile method. boto3 documentation

# describe_user_profile method definition

def describe_user_profile(
    self,
    *,
    DomainId: str,
    UserProfileName: str,
) -> DescribeUserProfileResponseTypeDef:  # (1)
    ...

1. See DescribeUserProfileResponseTypeDef

# describe_user_profile method usage example with argument unpacking

kwargs: DescribeUserProfileRequestTypeDef = {  # (1)
    "DomainId": ...,
    "UserProfileName": ...,
}

parent.describe_user_profile(**kwargs)

1. See DescribeUserProfileRequestTypeDef

describe_workforce

Lists private workforce information, including workforce name, Amazon Resource Name (ARN), and, if applicable, allowed IP address ranges (CIDRs).

Type annotations and code completion for boto3.client("sagemaker").describe_workforce method. boto3 documentation

# describe_workforce method definition

def describe_workforce(
    self,
    *,
    WorkforceName: str,
) -> DescribeWorkforceResponseTypeDef:  # (1)
    ...

1. See DescribeWorkforceResponseTypeDef

# describe_workforce method usage example with argument unpacking

kwargs: DescribeWorkforceRequestTypeDef = {  # (1)
    "WorkforceName": ...,
}

parent.describe_workforce(**kwargs)

1. See DescribeWorkforceRequestTypeDef

describe_workteam

Gets information about a specific work team.

Type annotations and code completion for boto3.client("sagemaker").describe_workteam method. boto3 documentation

# describe_workteam method definition

def describe_workteam(
    self,
    *,
    WorkteamName: str,
) -> DescribeWorkteamResponseTypeDef:  # (1)
    ...

1. See DescribeWorkteamResponseTypeDef

# describe_workteam method usage example with argument unpacking

kwargs: DescribeWorkteamRequestTypeDef = {  # (1)
    "WorkteamName": ...,
}

parent.describe_workteam(**kwargs)

1. See DescribeWorkteamRequestTypeDef

disable_sagemaker_servicecatalog_portfolio

Disables using Service Catalog in SageMaker.

Type annotations and code completion for boto3.client("sagemaker").disable_sagemaker_servicecatalog_portfolio method. boto3 documentation

# disable_sagemaker_servicecatalog_portfolio method definition

def disable_sagemaker_servicecatalog_portfolio(
    self,
) -> Dict[str, Any]:
    ...

disassociate_trial_component

Disassociates a trial component from a trial.

Type annotations and code completion for boto3.client("sagemaker").disassociate_trial_component method. boto3 documentation

# disassociate_trial_component method definition

def disassociate_trial_component(
    self,
    *,
    TrialComponentName: str,
    TrialName: str,
) -> DisassociateTrialComponentResponseTypeDef:  # (1)
    ...

1. See DisassociateTrialComponentResponseTypeDef

# disassociate_trial_component method usage example with argument unpacking

kwargs: DisassociateTrialComponentRequestTypeDef = {  # (1)
    "TrialComponentName": ...,
    "TrialName": ...,
}

parent.disassociate_trial_component(**kwargs)

1. See DisassociateTrialComponentRequestTypeDef

enable_sagemaker_servicecatalog_portfolio

Enables using Service Catalog in SageMaker.

Type annotations and code completion for boto3.client("sagemaker").enable_sagemaker_servicecatalog_portfolio method. boto3 documentation

# enable_sagemaker_servicecatalog_portfolio method definition

def enable_sagemaker_servicecatalog_portfolio(
    self,
) -> Dict[str, Any]:
    ...

get_device_fleet_report

Describes a fleet.

Type annotations and code completion for boto3.client("sagemaker").get_device_fleet_report method. boto3 documentation

# get_device_fleet_report method definition

def get_device_fleet_report(
    self,
    *,
    DeviceFleetName: str,
) -> GetDeviceFleetReportResponseTypeDef:  # (1)
    ...

1. See GetDeviceFleetReportResponseTypeDef

# get_device_fleet_report method usage example with argument unpacking

kwargs: GetDeviceFleetReportRequestTypeDef = {  # (1)
    "DeviceFleetName": ...,
}

parent.get_device_fleet_report(**kwargs)

1. See GetDeviceFleetReportRequestTypeDef

get_lineage_group_policy

The resource policy for the lineage group.

Type annotations and code completion for boto3.client("sagemaker").get_lineage_group_policy method. boto3 documentation

# get_lineage_group_policy method definition

def get_lineage_group_policy(
    self,
    *,
    LineageGroupName: str,
) -> GetLineageGroupPolicyResponseTypeDef:  # (1)
    ...

1. See GetLineageGroupPolicyResponseTypeDef

# get_lineage_group_policy method usage example with argument unpacking

kwargs: GetLineageGroupPolicyRequestTypeDef = {  # (1)
    "LineageGroupName": ...,
}

parent.get_lineage_group_policy(**kwargs)

1. See GetLineageGroupPolicyRequestTypeDef

get_model_package_group_policy

Gets a resource policy that manages access for a model group.

Type annotations and code completion for boto3.client("sagemaker").get_model_package_group_policy method. boto3 documentation

# get_model_package_group_policy method definition

def get_model_package_group_policy(
    self,
    *,
    ModelPackageGroupName: str,
) -> GetModelPackageGroupPolicyOutputTypeDef:  # (1)
    ...

1. See GetModelPackageGroupPolicyOutputTypeDef

# get_model_package_group_policy method usage example with argument unpacking

kwargs: GetModelPackageGroupPolicyInputTypeDef = {  # (1)
    "ModelPackageGroupName": ...,
}

parent.get_model_package_group_policy(**kwargs)

1. See GetModelPackageGroupPolicyInputTypeDef

get_sagemaker_servicecatalog_portfolio_status

Gets the status of Service Catalog in SageMaker.

Type annotations and code completion for boto3.client("sagemaker").get_sagemaker_servicecatalog_portfolio_status method. boto3 documentation

# get_sagemaker_servicecatalog_portfolio_status method definition

def get_sagemaker_servicecatalog_portfolio_status(
    self,
) -> GetSagemakerServicecatalogPortfolioStatusOutputTypeDef:  # (1)
    ...

1. See GetSagemakerServicecatalogPortfolioStatusOutputTypeDef

get_scaling_configuration_recommendation

Starts an Amazon SageMaker Inference Recommender autoscaling recommendation job.

Type annotations and code completion for boto3.client("sagemaker").get_scaling_configuration_recommendation method. boto3 documentation

# get_scaling_configuration_recommendation method definition

def get_scaling_configuration_recommendation(
    self,
    *,
    InferenceRecommendationsJobName: str,
    RecommendationId: str = ...,
    EndpointName: str = ...,
    TargetCpuUtilizationPerCore: int = ...,
    ScalingPolicyObjective: ScalingPolicyObjectiveTypeDef = ...,  # (1)
) -> GetScalingConfigurationRecommendationResponseTypeDef:  # (2)
    ...

1. See ScalingPolicyObjectiveTypeDef
2. See GetScalingConfigurationRecommendationResponseTypeDef

# get_scaling_configuration_recommendation method usage example with argument unpacking

kwargs: GetScalingConfigurationRecommendationRequestTypeDef = {  # (1)
    "InferenceRecommendationsJobName": ...,
}

parent.get_scaling_configuration_recommendation(**kwargs)

1. See GetScalingConfigurationRecommendationRequestTypeDef

get_search_suggestions

An auto-complete API for the search functionality in the SageMaker console.

Type annotations and code completion for boto3.client("sagemaker").get_search_suggestions method. boto3 documentation

# get_search_suggestions method definition

def get_search_suggestions(
    self,
    *,
    Resource: ResourceTypeType,  # (1)
    SuggestionQuery: SuggestionQueryTypeDef = ...,  # (2)
) -> GetSearchSuggestionsResponseTypeDef:  # (3)
    ...

1. See ResourceTypeType
2. See SuggestionQueryTypeDef
3. See GetSearchSuggestionsResponseTypeDef

# get_search_suggestions method usage example with argument unpacking

kwargs: GetSearchSuggestionsRequestTypeDef = {  # (1)
    "Resource": ...,
}

parent.get_search_suggestions(**kwargs)

1. See GetSearchSuggestionsRequestTypeDef

import_hub_content

Import hub content.

Type annotations and code completion for boto3.client("sagemaker").import_hub_content method. boto3 documentation

# import_hub_content method definition

def import_hub_content(
    self,
    *,
    HubContentName: str,
    HubContentType: HubContentTypeType,  # (1)
    DocumentSchemaVersion: str,
    HubName: str,
    HubContentDocument: str,
    HubContentVersion: str = ...,
    HubContentDisplayName: str = ...,
    HubContentDescription: str = ...,
    HubContentMarkdown: str = ...,
    SupportStatus: HubContentSupportStatusType = ...,  # (2)
    HubContentSearchKeywords: Sequence[str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> ImportHubContentResponseTypeDef:  # (4)
    ...

1. See HubContentTypeType
2. See HubContentSupportStatusType
3. See Sequence[TagTypeDef]
4. See ImportHubContentResponseTypeDef

# import_hub_content method usage example with argument unpacking

kwargs: ImportHubContentRequestTypeDef = {  # (1)
    "HubContentName": ...,
    "HubContentType": ...,
    "DocumentSchemaVersion": ...,
    "HubName": ...,
    "HubContentDocument": ...,
}

parent.import_hub_content(**kwargs)

1. See ImportHubContentRequestTypeDef

list_actions

Lists the actions in your account and their properties.

Type annotations and code completion for boto3.client("sagemaker").list_actions method. boto3 documentation

# list_actions method definition

def list_actions(
    self,
    *,
    SourceUri: str = ...,
    ActionType: str = ...,
    CreatedAfter: TimestampTypeDef = ...,
    CreatedBefore: TimestampTypeDef = ...,
    SortBy: SortActionsByType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListActionsResponseTypeDef:  # (3)
    ...

1. See SortActionsByType
2. See SortOrderType
3. See ListActionsResponseTypeDef

# list_actions method usage example with argument unpacking

kwargs: ListActionsRequestTypeDef = {  # (1)
    "SourceUri": ...,
}

parent.list_actions(**kwargs)

1. See ListActionsRequestTypeDef

list_algorithms

Lists the machine learning algorithms that have been created.

Type annotations and code completion for boto3.client("sagemaker").list_algorithms method. boto3 documentation

# list_algorithms method definition

def list_algorithms(
    self,
    *,
    CreationTimeAfter: TimestampTypeDef = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    MaxResults: int = ...,
    NameContains: str = ...,
    NextToken: str = ...,
    SortBy: AlgorithmSortByType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
) -> ListAlgorithmsOutputTypeDef:  # (3)
    ...

1. See AlgorithmSortByType
2. See SortOrderType
3. See ListAlgorithmsOutputTypeDef

# list_algorithms method usage example with argument unpacking

kwargs: ListAlgorithmsInputTypeDef = {  # (1)
    "CreationTimeAfter": ...,
}

parent.list_algorithms(**kwargs)

1. See ListAlgorithmsInputTypeDef

list_aliases

Lists the aliases of a specified image or image version.

Type annotations and code completion for boto3.client("sagemaker").list_aliases method. boto3 documentation

# list_aliases method definition

def list_aliases(
    self,
    *,
    ImageName: str,
    Alias: str = ...,
    Version: int = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListAliasesResponseTypeDef:  # (1)
    ...

1. See ListAliasesResponseTypeDef

# list_aliases method usage example with argument unpacking

kwargs: ListAliasesRequestTypeDef = {  # (1)
    "ImageName": ...,
}

parent.list_aliases(**kwargs)

1. See ListAliasesRequestTypeDef

list_app_image_configs

Lists the AppImageConfigs in your account and their properties.

Type annotations and code completion for boto3.client("sagemaker").list_app_image_configs method. boto3 documentation

# list_app_image_configs method definition

def list_app_image_configs(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
    NameContains: str = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    CreationTimeAfter: TimestampTypeDef = ...,
    ModifiedTimeBefore: TimestampTypeDef = ...,
    ModifiedTimeAfter: TimestampTypeDef = ...,
    SortBy: AppImageConfigSortKeyType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
) -> ListAppImageConfigsResponseTypeDef:  # (3)
    ...

1. See AppImageConfigSortKeyType
2. See SortOrderType
3. See ListAppImageConfigsResponseTypeDef

# list_app_image_configs method usage example with argument unpacking

kwargs: ListAppImageConfigsRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_app_image_configs(**kwargs)

1. See ListAppImageConfigsRequestTypeDef

list_apps

Lists apps.

Type annotations and code completion for boto3.client("sagemaker").list_apps method. boto3 documentation

# list_apps method definition

def list_apps(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    SortOrder: SortOrderType = ...,  # (1)
    SortBy: AppSortKeyType = ...,  # (2)
    DomainIdEquals: str = ...,
    UserProfileNameEquals: str = ...,
    SpaceNameEquals: str = ...,
) -> ListAppsResponseTypeDef:  # (3)
    ...

1. See SortOrderType
2. See AppSortKeyType
3. See ListAppsResponseTypeDef

# list_apps method usage example with argument unpacking

kwargs: ListAppsRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_apps(**kwargs)

1. See ListAppsRequestTypeDef

list_artifacts

Lists the artifacts in your account and their properties.

Type annotations and code completion for boto3.client("sagemaker").list_artifacts method. boto3 documentation

# list_artifacts method definition

def list_artifacts(
    self,
    *,
    SourceUri: str = ...,
    ArtifactType: str = ...,
    CreatedAfter: TimestampTypeDef = ...,
    CreatedBefore: TimestampTypeDef = ...,
    SortBy: SortArtifactsByType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListArtifactsResponseTypeDef:  # (3)
    ...

1. See SortArtifactsByType
2. See SortOrderType
3. See ListArtifactsResponseTypeDef

# list_artifacts method usage example with argument unpacking

kwargs: ListArtifactsRequestTypeDef = {  # (1)
    "SourceUri": ...,
}

parent.list_artifacts(**kwargs)

1. See ListArtifactsRequestTypeDef

list_associations

Lists the associations in your account and their properties.

Type annotations and code completion for boto3.client("sagemaker").list_associations method. boto3 documentation

# list_associations method definition

def list_associations(
    self,
    *,
    SourceArn: str = ...,
    DestinationArn: str = ...,
    SourceType: str = ...,
    DestinationType: str = ...,
    AssociationType: AssociationEdgeTypeType = ...,  # (1)
    CreatedAfter: TimestampTypeDef = ...,
    CreatedBefore: TimestampTypeDef = ...,
    SortBy: SortAssociationsByType = ...,  # (2)
    SortOrder: SortOrderType = ...,  # (3)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListAssociationsResponseTypeDef:  # (4)
    ...

1. See AssociationEdgeTypeType
2. See SortAssociationsByType
3. See SortOrderType
4. See ListAssociationsResponseTypeDef

# list_associations method usage example with argument unpacking

kwargs: ListAssociationsRequestTypeDef = {  # (1)
    "SourceArn": ...,
}

parent.list_associations(**kwargs)

1. See ListAssociationsRequestTypeDef

list_auto_ml_jobs

Request a list of jobs.

Type annotations and code completion for boto3.client("sagemaker").list_auto_ml_jobs method. boto3 documentation

# list_auto_ml_jobs method definition

def list_auto_ml_jobs(
    self,
    *,
    CreationTimeAfter: TimestampTypeDef = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    LastModifiedTimeAfter: TimestampTypeDef = ...,
    LastModifiedTimeBefore: TimestampTypeDef = ...,
    NameContains: str = ...,
    StatusEquals: AutoMLJobStatusType = ...,  # (1)
    SortOrder: AutoMLSortOrderType = ...,  # (2)
    SortBy: AutoMLSortByType = ...,  # (3)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListAutoMLJobsResponseTypeDef:  # (4)
    ...

1. See AutoMLJobStatusType
2. See AutoMLSortOrderType
3. See AutoMLSortByType
4. See ListAutoMLJobsResponseTypeDef

# list_auto_ml_jobs method usage example with argument unpacking

kwargs: ListAutoMLJobsRequestTypeDef = {  # (1)
    "CreationTimeAfter": ...,
}

parent.list_auto_ml_jobs(**kwargs)

1. See ListAutoMLJobsRequestTypeDef

list_candidates_for_auto_ml_job

List the candidates created for the job.

Type annotations and code completion for boto3.client("sagemaker").list_candidates_for_auto_ml_job method. boto3 documentation

# list_candidates_for_auto_ml_job method definition

def list_candidates_for_auto_ml_job(
    self,
    *,
    AutoMLJobName: str,
    StatusEquals: CandidateStatusType = ...,  # (1)
    CandidateNameEquals: str = ...,
    SortOrder: AutoMLSortOrderType = ...,  # (2)
    SortBy: CandidateSortByType = ...,  # (3)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListCandidatesForAutoMLJobResponseTypeDef:  # (4)
    ...

1. See CandidateStatusType
2. See AutoMLSortOrderType
3. See CandidateSortByType
4. See ListCandidatesForAutoMLJobResponseTypeDef

# list_candidates_for_auto_ml_job method usage example with argument unpacking

kwargs: ListCandidatesForAutoMLJobRequestTypeDef = {  # (1)
    "AutoMLJobName": ...,
}

parent.list_candidates_for_auto_ml_job(**kwargs)

1. See ListCandidatesForAutoMLJobRequestTypeDef

list_cluster_nodes

Retrieves the list of instances (also called nodes interchangeably) in a SageMaker HyperPod cluster.

Type annotations and code completion for boto3.client("sagemaker").list_cluster_nodes method. boto3 documentation

# list_cluster_nodes method definition

def list_cluster_nodes(
    self,
    *,
    ClusterName: str,
    CreationTimeAfter: TimestampTypeDef = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    InstanceGroupNameContains: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
    SortBy: ClusterSortByType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
) -> ListClusterNodesResponseTypeDef:  # (3)
    ...

1. See ClusterSortByType
2. See SortOrderType
3. See ListClusterNodesResponseTypeDef

# list_cluster_nodes method usage example with argument unpacking

kwargs: ListClusterNodesRequestTypeDef = {  # (1)
    "ClusterName": ...,
}

parent.list_cluster_nodes(**kwargs)

1. See ListClusterNodesRequestTypeDef

list_cluster_scheduler_configs

List the cluster policy configurations.

Type annotations and code completion for boto3.client("sagemaker").list_cluster_scheduler_configs method. boto3 documentation

# list_cluster_scheduler_configs method definition

def list_cluster_scheduler_configs(
    self,
    *,
    CreatedAfter: TimestampTypeDef = ...,
    CreatedBefore: TimestampTypeDef = ...,
    NameContains: str = ...,
    ClusterArn: str = ...,
    Status: SchedulerResourceStatusType = ...,  # (1)
    SortBy: SortClusterSchedulerConfigByType = ...,  # (2)
    SortOrder: SortOrderType = ...,  # (3)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListClusterSchedulerConfigsResponseTypeDef:  # (4)
    ...

1. See SchedulerResourceStatusType
2. See SortClusterSchedulerConfigByType
3. See SortOrderType
4. See ListClusterSchedulerConfigsResponseTypeDef

# list_cluster_scheduler_configs method usage example with argument unpacking

kwargs: ListClusterSchedulerConfigsRequestTypeDef = {  # (1)
    "CreatedAfter": ...,
}

parent.list_cluster_scheduler_configs(**kwargs)

1. See ListClusterSchedulerConfigsRequestTypeDef

list_clusters

Retrieves the list of SageMaker HyperPod clusters.

Type annotations and code completion for boto3.client("sagemaker").list_clusters method. boto3 documentation

# list_clusters method definition

def list_clusters(
    self,
    *,
    CreationTimeAfter: TimestampTypeDef = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    MaxResults: int = ...,
    NameContains: str = ...,
    NextToken: str = ...,
    SortBy: ClusterSortByType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    TrainingPlanArn: str = ...,
) -> ListClustersResponseTypeDef:  # (3)
    ...

1. See ClusterSortByType
2. See SortOrderType
3. See ListClustersResponseTypeDef

# list_clusters method usage example with argument unpacking

kwargs: ListClustersRequestTypeDef = {  # (1)
    "CreationTimeAfter": ...,
}

parent.list_clusters(**kwargs)

1. See ListClustersRequestTypeDef

list_code_repositories

Gets a list of the Git repositories in your account.

Type annotations and code completion for boto3.client("sagemaker").list_code_repositories method. boto3 documentation

# list_code_repositories method definition

def list_code_repositories(
    self,
    *,
    CreationTimeAfter: TimestampTypeDef = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    LastModifiedTimeAfter: TimestampTypeDef = ...,
    LastModifiedTimeBefore: TimestampTypeDef = ...,
    MaxResults: int = ...,
    NameContains: str = ...,
    NextToken: str = ...,
    SortBy: CodeRepositorySortByType = ...,  # (1)
    SortOrder: CodeRepositorySortOrderType = ...,  # (2)
) -> ListCodeRepositoriesOutputTypeDef:  # (3)
    ...

1. See CodeRepositorySortByType
2. See CodeRepositorySortOrderType
3. See ListCodeRepositoriesOutputTypeDef

# list_code_repositories method usage example with argument unpacking

kwargs: ListCodeRepositoriesInputTypeDef = {  # (1)
    "CreationTimeAfter": ...,
}

parent.list_code_repositories(**kwargs)

1. See ListCodeRepositoriesInputTypeDef

list_compilation_jobs

Lists model compilation jobs that satisfy various filters.

Type annotations and code completion for boto3.client("sagemaker").list_compilation_jobs method. boto3 documentation

# list_compilation_jobs method definition

def list_compilation_jobs(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    CreationTimeAfter: TimestampTypeDef = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    LastModifiedTimeAfter: TimestampTypeDef = ...,
    LastModifiedTimeBefore: TimestampTypeDef = ...,
    NameContains: str = ...,
    StatusEquals: CompilationJobStatusType = ...,  # (1)
    SortBy: ListCompilationJobsSortByType = ...,  # (2)
    SortOrder: SortOrderType = ...,  # (3)
) -> ListCompilationJobsResponseTypeDef:  # (4)
    ...

1. See CompilationJobStatusType
2. See ListCompilationJobsSortByType
3. See SortOrderType
4. See ListCompilationJobsResponseTypeDef

# list_compilation_jobs method usage example with argument unpacking

kwargs: ListCompilationJobsRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_compilation_jobs(**kwargs)

1. See ListCompilationJobsRequestTypeDef

list_compute_quotas

List the resource allocation definitions.

Type annotations and code completion for boto3.client("sagemaker").list_compute_quotas method. boto3 documentation

# list_compute_quotas method definition

def list_compute_quotas(
    self,
    *,
    CreatedAfter: TimestampTypeDef = ...,
    CreatedBefore: TimestampTypeDef = ...,
    NameContains: str = ...,
    Status: SchedulerResourceStatusType = ...,  # (1)
    ClusterArn: str = ...,
    SortBy: SortQuotaByType = ...,  # (2)
    SortOrder: SortOrderType = ...,  # (3)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListComputeQuotasResponseTypeDef:  # (4)
    ...

1. See SchedulerResourceStatusType
2. See SortQuotaByType
3. See SortOrderType
4. See ListComputeQuotasResponseTypeDef

# list_compute_quotas method usage example with argument unpacking

kwargs: ListComputeQuotasRequestTypeDef = {  # (1)
    "CreatedAfter": ...,
}

parent.list_compute_quotas(**kwargs)

1. See ListComputeQuotasRequestTypeDef

list_contexts

Lists the contexts in your account and their properties.

Type annotations and code completion for boto3.client("sagemaker").list_contexts method. boto3 documentation

# list_contexts method definition

def list_contexts(
    self,
    *,
    SourceUri: str = ...,
    ContextType: str = ...,
    CreatedAfter: TimestampTypeDef = ...,
    CreatedBefore: TimestampTypeDef = ...,
    SortBy: SortContextsByType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListContextsResponseTypeDef:  # (3)
    ...

1. See SortContextsByType
2. See SortOrderType
3. See ListContextsResponseTypeDef

# list_contexts method usage example with argument unpacking

kwargs: ListContextsRequestTypeDef = {  # (1)
    "SourceUri": ...,
}

parent.list_contexts(**kwargs)

1. See ListContextsRequestTypeDef

list_data_quality_job_definitions

Lists the data quality job definitions in your account.

Type annotations and code completion for boto3.client("sagemaker").list_data_quality_job_definitions method. boto3 documentation

# list_data_quality_job_definitions method definition

def list_data_quality_job_definitions(
    self,
    *,
    EndpointName: str = ...,
    SortBy: MonitoringJobDefinitionSortKeyType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
    NameContains: str = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    CreationTimeAfter: TimestampTypeDef = ...,
) -> ListDataQualityJobDefinitionsResponseTypeDef:  # (3)
    ...

1. See MonitoringJobDefinitionSortKeyType
2. See SortOrderType
3. See ListDataQualityJobDefinitionsResponseTypeDef

# list_data_quality_job_definitions method usage example with argument unpacking

kwargs: ListDataQualityJobDefinitionsRequestTypeDef = {  # (1)
    "EndpointName": ...,
}

parent.list_data_quality_job_definitions(**kwargs)

1. See ListDataQualityJobDefinitionsRequestTypeDef

list_device_fleets

Returns a list of devices in the fleet.

Type annotations and code completion for boto3.client("sagemaker").list_device_fleets method. boto3 documentation

# list_device_fleets method definition

def list_device_fleets(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    CreationTimeAfter: TimestampTypeDef = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    LastModifiedTimeAfter: TimestampTypeDef = ...,
    LastModifiedTimeBefore: TimestampTypeDef = ...,
    NameContains: str = ...,
    SortBy: ListDeviceFleetsSortByType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
) -> ListDeviceFleetsResponseTypeDef:  # (3)
    ...

1. See ListDeviceFleetsSortByType
2. See SortOrderType
3. See ListDeviceFleetsResponseTypeDef

# list_device_fleets method usage example with argument unpacking

kwargs: ListDeviceFleetsRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_device_fleets(**kwargs)

1. See ListDeviceFleetsRequestTypeDef

list_devices

A list of devices.

Type annotations and code completion for boto3.client("sagemaker").list_devices method. boto3 documentation

# list_devices method definition

def list_devices(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    LatestHeartbeatAfter: TimestampTypeDef = ...,
    ModelName: str = ...,
    DeviceFleetName: str = ...,
) -> ListDevicesResponseTypeDef:  # (1)
    ...

1. See ListDevicesResponseTypeDef

# list_devices method usage example with argument unpacking

kwargs: ListDevicesRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_devices(**kwargs)

1. See ListDevicesRequestTypeDef

list_domains

Lists the domains.

Type annotations and code completion for boto3.client("sagemaker").list_domains method. boto3 documentation

# list_domains method definition

def list_domains(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDomainsResponseTypeDef:  # (1)
    ...

1. See ListDomainsResponseTypeDef

# list_domains method usage example with argument unpacking

kwargs: ListDomainsRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_domains(**kwargs)

1. See ListDomainsRequestTypeDef

list_edge_deployment_plans

Lists all edge deployment plans.

Type annotations and code completion for boto3.client("sagemaker").list_edge_deployment_plans method. boto3 documentation

# list_edge_deployment_plans method definition

def list_edge_deployment_plans(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    CreationTimeAfter: TimestampTypeDef = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    LastModifiedTimeAfter: TimestampTypeDef = ...,
    LastModifiedTimeBefore: TimestampTypeDef = ...,
    NameContains: str = ...,
    DeviceFleetNameContains: str = ...,
    SortBy: ListEdgeDeploymentPlansSortByType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
) -> ListEdgeDeploymentPlansResponseTypeDef:  # (3)
    ...

1. See ListEdgeDeploymentPlansSortByType
2. See SortOrderType
3. See ListEdgeDeploymentPlansResponseTypeDef

# list_edge_deployment_plans method usage example with argument unpacking

kwargs: ListEdgeDeploymentPlansRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_edge_deployment_plans(**kwargs)

1. See ListEdgeDeploymentPlansRequestTypeDef

list_edge_packaging_jobs

Returns a list of edge packaging jobs.

Type annotations and code completion for boto3.client("sagemaker").list_edge_packaging_jobs method. boto3 documentation

# list_edge_packaging_jobs method definition

def list_edge_packaging_jobs(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    CreationTimeAfter: TimestampTypeDef = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    LastModifiedTimeAfter: TimestampTypeDef = ...,
    LastModifiedTimeBefore: TimestampTypeDef = ...,
    NameContains: str = ...,
    ModelNameContains: str = ...,
    StatusEquals: EdgePackagingJobStatusType = ...,  # (1)
    SortBy: ListEdgePackagingJobsSortByType = ...,  # (2)
    SortOrder: SortOrderType = ...,  # (3)
) -> ListEdgePackagingJobsResponseTypeDef:  # (4)
    ...

1. See EdgePackagingJobStatusType
2. See ListEdgePackagingJobsSortByType
3. See SortOrderType
4. See ListEdgePackagingJobsResponseTypeDef

# list_edge_packaging_jobs method usage example with argument unpacking

kwargs: ListEdgePackagingJobsRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_edge_packaging_jobs(**kwargs)

1. See ListEdgePackagingJobsRequestTypeDef

list_endpoint_configs

Lists endpoint configurations.

Type annotations and code completion for boto3.client("sagemaker").list_endpoint_configs method. boto3 documentation

# list_endpoint_configs method definition

def list_endpoint_configs(
    self,
    *,
    SortBy: EndpointConfigSortKeyType = ...,  # (1)
    SortOrder: OrderKeyType = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
    NameContains: str = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    CreationTimeAfter: TimestampTypeDef = ...,
) -> ListEndpointConfigsOutputTypeDef:  # (3)
    ...

1. See EndpointConfigSortKeyType
2. See OrderKeyType
3. See ListEndpointConfigsOutputTypeDef

# list_endpoint_configs method usage example with argument unpacking

kwargs: ListEndpointConfigsInputTypeDef = {  # (1)
    "SortBy": ...,
}

parent.list_endpoint_configs(**kwargs)

1. See ListEndpointConfigsInputTypeDef

list_endpoints

Lists endpoints.

Type annotations and code completion for boto3.client("sagemaker").list_endpoints method. boto3 documentation

# list_endpoints method definition

def list_endpoints(
    self,
    *,
    SortBy: EndpointSortKeyType = ...,  # (1)
    SortOrder: OrderKeyType = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
    NameContains: str = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    CreationTimeAfter: TimestampTypeDef = ...,
    LastModifiedTimeBefore: TimestampTypeDef = ...,
    LastModifiedTimeAfter: TimestampTypeDef = ...,
    StatusEquals: EndpointStatusType = ...,  # (3)
) -> ListEndpointsOutputTypeDef:  # (4)
    ...

1. See EndpointSortKeyType
2. See OrderKeyType
3. See EndpointStatusType
4. See ListEndpointsOutputTypeDef

# list_endpoints method usage example with argument unpacking

kwargs: ListEndpointsInputTypeDef = {  # (1)
    "SortBy": ...,
}

parent.list_endpoints(**kwargs)

1. See ListEndpointsInputTypeDef

list_experiments

Lists all the experiments in your account.

Type annotations and code completion for boto3.client("sagemaker").list_experiments method. boto3 documentation

# list_experiments method definition

def list_experiments(
    self,
    *,
    CreatedAfter: TimestampTypeDef = ...,
    CreatedBefore: TimestampTypeDef = ...,
    SortBy: SortExperimentsByType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListExperimentsResponseTypeDef:  # (3)
    ...

1. See SortExperimentsByType
2. See SortOrderType
3. See ListExperimentsResponseTypeDef

# list_experiments method usage example with argument unpacking

kwargs: ListExperimentsRequestTypeDef = {  # (1)
    "CreatedAfter": ...,
}

parent.list_experiments(**kwargs)

1. See ListExperimentsRequestTypeDef

list_feature_groups

List FeatureGroups based on given filter and order.

Type annotations and code completion for boto3.client("sagemaker").list_feature_groups method. boto3 documentation

# list_feature_groups method definition

def list_feature_groups(
    self,
    *,
    NameContains: str = ...,
    FeatureGroupStatusEquals: FeatureGroupStatusType = ...,  # (1)
    OfflineStoreStatusEquals: OfflineStoreStatusValueType = ...,  # (2)
    CreationTimeAfter: TimestampTypeDef = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    SortOrder: FeatureGroupSortOrderType = ...,  # (3)
    SortBy: FeatureGroupSortByType = ...,  # (4)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListFeatureGroupsResponseTypeDef:  # (5)
    ...

1. See FeatureGroupStatusType
2. See OfflineStoreStatusValueType
3. See FeatureGroupSortOrderType
4. See FeatureGroupSortByType
5. See ListFeatureGroupsResponseTypeDef

# list_feature_groups method usage example with argument unpacking

kwargs: ListFeatureGroupsRequestTypeDef = {  # (1)
    "NameContains": ...,
}

parent.list_feature_groups(**kwargs)

1. See ListFeatureGroupsRequestTypeDef

list_flow_definitions

Returns information about the flow definitions in your account.

Type annotations and code completion for boto3.client("sagemaker").list_flow_definitions method. boto3 documentation

# list_flow_definitions method definition

def list_flow_definitions(
    self,
    *,
    CreationTimeAfter: TimestampTypeDef = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    SortOrder: SortOrderType = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListFlowDefinitionsResponseTypeDef:  # (2)
    ...

1. See SortOrderType
2. See ListFlowDefinitionsResponseTypeDef

# list_flow_definitions method usage example with argument unpacking

kwargs: ListFlowDefinitionsRequestTypeDef = {  # (1)
    "CreationTimeAfter": ...,
}

parent.list_flow_definitions(**kwargs)

1. See ListFlowDefinitionsRequestTypeDef

list_hub_content_versions

List hub content versions.

Type annotations and code completion for boto3.client("sagemaker").list_hub_content_versions method. boto3 documentation

# list_hub_content_versions method definition

def list_hub_content_versions(
    self,
    *,
    HubName: str,
    HubContentType: HubContentTypeType,  # (1)
    HubContentName: str,
    MinVersion: str = ...,
    MaxSchemaVersion: str = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    CreationTimeAfter: TimestampTypeDef = ...,
    SortBy: HubContentSortByType = ...,  # (2)
    SortOrder: SortOrderType = ...,  # (3)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListHubContentVersionsResponseTypeDef:  # (4)
    ...

1. See HubContentTypeType
2. See HubContentSortByType
3. See SortOrderType
4. See ListHubContentVersionsResponseTypeDef

# list_hub_content_versions method usage example with argument unpacking

kwargs: ListHubContentVersionsRequestTypeDef = {  # (1)
    "HubName": ...,
    "HubContentType": ...,
    "HubContentName": ...,
}

parent.list_hub_content_versions(**kwargs)

1. See ListHubContentVersionsRequestTypeDef

list_hub_contents

List the contents of a hub.

Type annotations and code completion for boto3.client("sagemaker").list_hub_contents method. boto3 documentation

# list_hub_contents method definition

def list_hub_contents(
    self,
    *,
    HubName: str,
    HubContentType: HubContentTypeType,  # (1)
    NameContains: str = ...,
    MaxSchemaVersion: str = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    CreationTimeAfter: TimestampTypeDef = ...,
    SortBy: HubContentSortByType = ...,  # (2)
    SortOrder: SortOrderType = ...,  # (3)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListHubContentsResponseTypeDef:  # (4)
    ...

1. See HubContentTypeType
2. See HubContentSortByType
3. See SortOrderType
4. See ListHubContentsResponseTypeDef

# list_hub_contents method usage example with argument unpacking

kwargs: ListHubContentsRequestTypeDef = {  # (1)
    "HubName": ...,
    "HubContentType": ...,
}

parent.list_hub_contents(**kwargs)

1. See ListHubContentsRequestTypeDef

list_hubs

List all existing hubs.

Type annotations and code completion for boto3.client("sagemaker").list_hubs method. boto3 documentation

# list_hubs method definition

def list_hubs(
    self,
    *,
    NameContains: str = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    CreationTimeAfter: TimestampTypeDef = ...,
    LastModifiedTimeBefore: TimestampTypeDef = ...,
    LastModifiedTimeAfter: TimestampTypeDef = ...,
    SortBy: HubSortByType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListHubsResponseTypeDef:  # (3)
    ...

1. See HubSortByType
2. See SortOrderType
3. See ListHubsResponseTypeDef

# list_hubs method usage example with argument unpacking

kwargs: ListHubsRequestTypeDef = {  # (1)
    "NameContains": ...,
}

parent.list_hubs(**kwargs)

1. See ListHubsRequestTypeDef

list_human_task_uis

Returns information about the human task user interfaces in your account.

Type annotations and code completion for boto3.client("sagemaker").list_human_task_uis method. boto3 documentation

# list_human_task_uis method definition

def list_human_task_uis(
    self,
    *,
    CreationTimeAfter: TimestampTypeDef = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    SortOrder: SortOrderType = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListHumanTaskUisResponseTypeDef:  # (2)
    ...

1. See SortOrderType
2. See ListHumanTaskUisResponseTypeDef

# list_human_task_uis method usage example with argument unpacking

kwargs: ListHumanTaskUisRequestTypeDef = {  # (1)
    "CreationTimeAfter": ...,
}

parent.list_human_task_uis(**kwargs)

1. See ListHumanTaskUisRequestTypeDef

list_hyper_parameter_tuning_jobs

Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.

Type annotations and code completion for boto3.client("sagemaker").list_hyper_parameter_tuning_jobs method. boto3 documentation

# list_hyper_parameter_tuning_jobs method definition

def list_hyper_parameter_tuning_jobs(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    SortBy: HyperParameterTuningJobSortByOptionsType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    NameContains: str = ...,
    CreationTimeAfter: TimestampTypeDef = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    LastModifiedTimeAfter: TimestampTypeDef = ...,
    LastModifiedTimeBefore: TimestampTypeDef = ...,
    StatusEquals: HyperParameterTuningJobStatusType = ...,  # (3)
) -> ListHyperParameterTuningJobsResponseTypeDef:  # (4)
    ...

1. See HyperParameterTuningJobSortByOptionsType
2. See SortOrderType
3. See HyperParameterTuningJobStatusType
4. See ListHyperParameterTuningJobsResponseTypeDef

# list_hyper_parameter_tuning_jobs method usage example with argument unpacking

kwargs: ListHyperParameterTuningJobsRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_hyper_parameter_tuning_jobs(**kwargs)

1. See ListHyperParameterTuningJobsRequestTypeDef

list_image_versions

Lists the versions of a specified image and their properties.

Type annotations and code completion for boto3.client("sagemaker").list_image_versions method. boto3 documentation

# list_image_versions method definition

def list_image_versions(
    self,
    *,
    ImageName: str,
    CreationTimeAfter: TimestampTypeDef = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    LastModifiedTimeAfter: TimestampTypeDef = ...,
    LastModifiedTimeBefore: TimestampTypeDef = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
    SortBy: ImageVersionSortByType = ...,  # (1)
    SortOrder: ImageVersionSortOrderType = ...,  # (2)
) -> ListImageVersionsResponseTypeDef:  # (3)
    ...

1. See ImageVersionSortByType
2. See ImageVersionSortOrderType
3. See ListImageVersionsResponseTypeDef

# list_image_versions method usage example with argument unpacking

kwargs: ListImageVersionsRequestTypeDef = {  # (1)
    "ImageName": ...,
}

parent.list_image_versions(**kwargs)

1. See ListImageVersionsRequestTypeDef

list_images

Lists the images in your account and their properties.

Type annotations and code completion for boto3.client("sagemaker").list_images method. boto3 documentation

# list_images method definition

def list_images(
    self,
    *,
    CreationTimeAfter: TimestampTypeDef = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    LastModifiedTimeAfter: TimestampTypeDef = ...,
    LastModifiedTimeBefore: TimestampTypeDef = ...,
    MaxResults: int = ...,
    NameContains: str = ...,
    NextToken: str = ...,
    SortBy: ImageSortByType = ...,  # (1)
    SortOrder: ImageSortOrderType = ...,  # (2)
) -> ListImagesResponseTypeDef:  # (3)
    ...

1. See ImageSortByType
2. See ImageSortOrderType
3. See ListImagesResponseTypeDef

# list_images method usage example with argument unpacking

kwargs: ListImagesRequestTypeDef = {  # (1)
    "CreationTimeAfter": ...,
}

parent.list_images(**kwargs)

1. See ListImagesRequestTypeDef

list_inference_components

Lists the inference components in your account and their properties.

Type annotations and code completion for boto3.client("sagemaker").list_inference_components method. boto3 documentation

# list_inference_components method definition

def list_inference_components(
    self,
    *,
    SortBy: InferenceComponentSortKeyType = ...,  # (1)
    SortOrder: OrderKeyType = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
    NameContains: str = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    CreationTimeAfter: TimestampTypeDef = ...,
    LastModifiedTimeBefore: TimestampTypeDef = ...,
    LastModifiedTimeAfter: TimestampTypeDef = ...,
    StatusEquals: InferenceComponentStatusType = ...,  # (3)
    EndpointNameEquals: str = ...,
    VariantNameEquals: str = ...,
) -> ListInferenceComponentsOutputTypeDef:  # (4)
    ...

1. See InferenceComponentSortKeyType
2. See OrderKeyType
3. See InferenceComponentStatusType
4. See ListInferenceComponentsOutputTypeDef

# list_inference_components method usage example with argument unpacking

kwargs: ListInferenceComponentsInputTypeDef = {  # (1)
    "SortBy": ...,
}

parent.list_inference_components(**kwargs)

1. See ListInferenceComponentsInputTypeDef

list_inference_experiments

Returns the list of all inference experiments.

Type annotations and code completion for boto3.client("sagemaker").list_inference_experiments method. boto3 documentation

# list_inference_experiments method definition

def list_inference_experiments(
    self,
    *,
    NameContains: str = ...,
    Type: InferenceExperimentTypeType = ...,  # (1)
    StatusEquals: InferenceExperimentStatusType = ...,  # (2)
    CreationTimeAfter: TimestampTypeDef = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    LastModifiedTimeAfter: TimestampTypeDef = ...,
    LastModifiedTimeBefore: TimestampTypeDef = ...,
    SortBy: SortInferenceExperimentsByType = ...,  # (3)
    SortOrder: SortOrderType = ...,  # (4)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListInferenceExperimentsResponseTypeDef:  # (5)
    ...

1. See InferenceExperimentTypeType
2. See InferenceExperimentStatusType
3. See SortInferenceExperimentsByType
4. See SortOrderType
5. See ListInferenceExperimentsResponseTypeDef

# list_inference_experiments method usage example with argument unpacking

kwargs: ListInferenceExperimentsRequestTypeDef = {  # (1)
    "NameContains": ...,
}

parent.list_inference_experiments(**kwargs)

1. See ListInferenceExperimentsRequestTypeDef

list_inference_recommendations_job_steps

Returns a list of the subtasks for an Inference Recommender job.

Type annotations and code completion for boto3.client("sagemaker").list_inference_recommendations_job_steps method. boto3 documentation

# list_inference_recommendations_job_steps method definition

def list_inference_recommendations_job_steps(
    self,
    *,
    JobName: str,
    Status: RecommendationJobStatusType = ...,  # (1)
    StepType: RecommendationStepTypeType = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListInferenceRecommendationsJobStepsResponseTypeDef:  # (3)
    ...

1. See RecommendationJobStatusType
2. See RecommendationStepTypeType
3. See ListInferenceRecommendationsJobStepsResponseTypeDef

# list_inference_recommendations_job_steps method usage example with argument unpacking

kwargs: ListInferenceRecommendationsJobStepsRequestTypeDef = {  # (1)
    "JobName": ...,
}

parent.list_inference_recommendations_job_steps(**kwargs)

1. See ListInferenceRecommendationsJobStepsRequestTypeDef

list_inference_recommendations_jobs

Lists recommendation jobs that satisfy various filters.

Type annotations and code completion for boto3.client("sagemaker").list_inference_recommendations_jobs method. boto3 documentation

# list_inference_recommendations_jobs method definition

def list_inference_recommendations_jobs(
    self,
    *,
    CreationTimeAfter: TimestampTypeDef = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    LastModifiedTimeAfter: TimestampTypeDef = ...,
    LastModifiedTimeBefore: TimestampTypeDef = ...,
    NameContains: str = ...,
    StatusEquals: RecommendationJobStatusType = ...,  # (1)
    SortBy: ListInferenceRecommendationsJobsSortByType = ...,  # (2)
    SortOrder: SortOrderType = ...,  # (3)
    NextToken: str = ...,
    MaxResults: int = ...,
    ModelNameEquals: str = ...,
    ModelPackageVersionArnEquals: str = ...,
) -> ListInferenceRecommendationsJobsResponseTypeDef:  # (4)
    ...

1. See RecommendationJobStatusType
2. See ListInferenceRecommendationsJobsSortByType
3. See SortOrderType
4. See ListInferenceRecommendationsJobsResponseTypeDef

# list_inference_recommendations_jobs method usage example with argument unpacking

kwargs: ListInferenceRecommendationsJobsRequestTypeDef = {  # (1)
    "CreationTimeAfter": ...,
}

parent.list_inference_recommendations_jobs(**kwargs)

1. See ListInferenceRecommendationsJobsRequestTypeDef

list_labeling_jobs

Gets a list of labeling jobs.

Type annotations and code completion for boto3.client("sagemaker").list_labeling_jobs method. boto3 documentation

# list_labeling_jobs method definition

def list_labeling_jobs(
    self,
    *,
    CreationTimeAfter: TimestampTypeDef = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    LastModifiedTimeAfter: TimestampTypeDef = ...,
    LastModifiedTimeBefore: TimestampTypeDef = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
    NameContains: str = ...,
    SortBy: SortByType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    StatusEquals: LabelingJobStatusType = ...,  # (3)
) -> ListLabelingJobsResponseTypeDef:  # (4)
    ...

1. See SortByType
2. See SortOrderType
3. See LabelingJobStatusType
4. See ListLabelingJobsResponseTypeDef

# list_labeling_jobs method usage example with argument unpacking

kwargs: ListLabelingJobsRequestTypeDef = {  # (1)
    "CreationTimeAfter": ...,
}

parent.list_labeling_jobs(**kwargs)

1. See ListLabelingJobsRequestTypeDef

list_labeling_jobs_for_workteam

Gets a list of labeling jobs assigned to a specified work team.

Type annotations and code completion for boto3.client("sagemaker").list_labeling_jobs_for_workteam method. boto3 documentation

# list_labeling_jobs_for_workteam method definition

def list_labeling_jobs_for_workteam(
    self,
    *,
    WorkteamArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    CreationTimeAfter: TimestampTypeDef = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    JobReferenceCodeContains: str = ...,
    SortBy: ListLabelingJobsForWorkteamSortByOptionsType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
) -> ListLabelingJobsForWorkteamResponseTypeDef:  # (3)
    ...

1. See ListLabelingJobsForWorkteamSortByOptionsType
2. See SortOrderType
3. See ListLabelingJobsForWorkteamResponseTypeDef

# list_labeling_jobs_for_workteam method usage example with argument unpacking

kwargs: ListLabelingJobsForWorkteamRequestTypeDef = {  # (1)
    "WorkteamArn": ...,
}

parent.list_labeling_jobs_for_workteam(**kwargs)

1. See ListLabelingJobsForWorkteamRequestTypeDef

list_lineage_groups

A list of lineage groups shared with your Amazon Web Services account.

Type annotations and code completion for boto3.client("sagemaker").list_lineage_groups method. boto3 documentation

# list_lineage_groups method definition

def list_lineage_groups(
    self,
    *,
    CreatedAfter: TimestampTypeDef = ...,
    CreatedBefore: TimestampTypeDef = ...,
    SortBy: SortLineageGroupsByType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListLineageGroupsResponseTypeDef:  # (3)
    ...

1. See SortLineageGroupsByType
2. See SortOrderType
3. See ListLineageGroupsResponseTypeDef

# list_lineage_groups method usage example with argument unpacking

kwargs: ListLineageGroupsRequestTypeDef = {  # (1)
    "CreatedAfter": ...,
}

parent.list_lineage_groups(**kwargs)

1. See ListLineageGroupsRequestTypeDef

list_mlflow_tracking_servers

Lists all MLflow Tracking Servers.

Type annotations and code completion for boto3.client("sagemaker").list_mlflow_tracking_servers method. boto3 documentation

# list_mlflow_tracking_servers method definition

def list_mlflow_tracking_servers(
    self,
    *,
    CreatedAfter: TimestampTypeDef = ...,
    CreatedBefore: TimestampTypeDef = ...,
    TrackingServerStatus: TrackingServerStatusType = ...,  # (1)
    MlflowVersion: str = ...,
    SortBy: SortTrackingServerByType = ...,  # (2)
    SortOrder: SortOrderType = ...,  # (3)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListMlflowTrackingServersResponseTypeDef:  # (4)
    ...

1. See TrackingServerStatusType
2. See SortTrackingServerByType
3. See SortOrderType
4. See ListMlflowTrackingServersResponseTypeDef

# list_mlflow_tracking_servers method usage example with argument unpacking

kwargs: ListMlflowTrackingServersRequestTypeDef = {  # (1)
    "CreatedAfter": ...,
}

parent.list_mlflow_tracking_servers(**kwargs)

1. See ListMlflowTrackingServersRequestTypeDef

list_model_bias_job_definitions

Lists model bias jobs definitions that satisfy various filters.

Type annotations and code completion for boto3.client("sagemaker").list_model_bias_job_definitions method. boto3 documentation

# list_model_bias_job_definitions method definition

def list_model_bias_job_definitions(
    self,
    *,
    EndpointName: str = ...,
    SortBy: MonitoringJobDefinitionSortKeyType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
    NameContains: str = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    CreationTimeAfter: TimestampTypeDef = ...,
) -> ListModelBiasJobDefinitionsResponseTypeDef:  # (3)
    ...

1. See MonitoringJobDefinitionSortKeyType
2. See SortOrderType
3. See ListModelBiasJobDefinitionsResponseTypeDef

# list_model_bias_job_definitions method usage example with argument unpacking

kwargs: ListModelBiasJobDefinitionsRequestTypeDef = {  # (1)
    "EndpointName": ...,
}

parent.list_model_bias_job_definitions(**kwargs)

1. See ListModelBiasJobDefinitionsRequestTypeDef

list_model_card_export_jobs

List the export jobs for the Amazon SageMaker Model Card.

Type annotations and code completion for boto3.client("sagemaker").list_model_card_export_jobs method. boto3 documentation

# list_model_card_export_jobs method definition

def list_model_card_export_jobs(
    self,
    *,
    ModelCardName: str,
    ModelCardVersion: int = ...,
    CreationTimeAfter: TimestampTypeDef = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    ModelCardExportJobNameContains: str = ...,
    StatusEquals: ModelCardExportJobStatusType = ...,  # (1)
    SortBy: ModelCardExportJobSortByType = ...,  # (2)
    SortOrder: ModelCardExportJobSortOrderType = ...,  # (3)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListModelCardExportJobsResponseTypeDef:  # (4)
    ...

1. See ModelCardExportJobStatusType
2. See ModelCardExportJobSortByType
3. See ModelCardExportJobSortOrderType
4. See ListModelCardExportJobsResponseTypeDef

# list_model_card_export_jobs method usage example with argument unpacking

kwargs: ListModelCardExportJobsRequestTypeDef = {  # (1)
    "ModelCardName": ...,
}

parent.list_model_card_export_jobs(**kwargs)

1. See ListModelCardExportJobsRequestTypeDef

list_model_card_versions

List existing versions of an Amazon SageMaker Model Card.

Type annotations and code completion for boto3.client("sagemaker").list_model_card_versions method. boto3 documentation

# list_model_card_versions method definition

def list_model_card_versions(
    self,
    *,
    ModelCardName: str,
    CreationTimeAfter: TimestampTypeDef = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    MaxResults: int = ...,
    ModelCardStatus: ModelCardStatusType = ...,  # (1)
    NextToken: str = ...,
    SortBy: ModelCardVersionSortByType = ...,  # (2)
    SortOrder: ModelCardSortOrderType = ...,  # (3)
) -> ListModelCardVersionsResponseTypeDef:  # (4)
    ...

1. See ModelCardStatusType
2. See ModelCardVersionSortByType
3. See ModelCardSortOrderType
4. See ListModelCardVersionsResponseTypeDef

# list_model_card_versions method usage example with argument unpacking

kwargs: ListModelCardVersionsRequestTypeDef = {  # (1)
    "ModelCardName": ...,
}

parent.list_model_card_versions(**kwargs)

1. See ListModelCardVersionsRequestTypeDef

list_model_cards

List existing model cards.

Type annotations and code completion for boto3.client("sagemaker").list_model_cards method. boto3 documentation

# list_model_cards method definition

def list_model_cards(
    self,
    *,
    CreationTimeAfter: TimestampTypeDef = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    MaxResults: int = ...,
    NameContains: str = ...,
    ModelCardStatus: ModelCardStatusType = ...,  # (1)
    NextToken: str = ...,
    SortBy: ModelCardSortByType = ...,  # (2)
    SortOrder: ModelCardSortOrderType = ...,  # (3)
) -> ListModelCardsResponseTypeDef:  # (4)
    ...

1. See ModelCardStatusType
2. See ModelCardSortByType
3. See ModelCardSortOrderType
4. See ListModelCardsResponseTypeDef

# list_model_cards method usage example with argument unpacking

kwargs: ListModelCardsRequestTypeDef = {  # (1)
    "CreationTimeAfter": ...,
}

parent.list_model_cards(**kwargs)

1. See ListModelCardsRequestTypeDef

list_model_explainability_job_definitions

Lists model explainability job definitions that satisfy various filters.

Type annotations and code completion for boto3.client("sagemaker").list_model_explainability_job_definitions method. boto3 documentation

# list_model_explainability_job_definitions method definition

def list_model_explainability_job_definitions(
    self,
    *,
    EndpointName: str = ...,
    SortBy: MonitoringJobDefinitionSortKeyType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
    NameContains: str = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    CreationTimeAfter: TimestampTypeDef = ...,
) -> ListModelExplainabilityJobDefinitionsResponseTypeDef:  # (3)
    ...

1. See MonitoringJobDefinitionSortKeyType
2. See SortOrderType
3. See ListModelExplainabilityJobDefinitionsResponseTypeDef

# list_model_explainability_job_definitions method usage example with argument unpacking

kwargs: ListModelExplainabilityJobDefinitionsRequestTypeDef = {  # (1)
    "EndpointName": ...,
}

parent.list_model_explainability_job_definitions(**kwargs)

1. See ListModelExplainabilityJobDefinitionsRequestTypeDef

list_model_metadata

Lists the domain, framework, task, and model name of standard machine learning models found in common model zoos.

Type annotations and code completion for boto3.client("sagemaker").list_model_metadata method. boto3 documentation

# list_model_metadata method definition

def list_model_metadata(
    self,
    *,
    SearchExpression: ModelMetadataSearchExpressionTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListModelMetadataResponseTypeDef:  # (2)
    ...

1. See ModelMetadataSearchExpressionTypeDef
2. See ListModelMetadataResponseTypeDef

# list_model_metadata method usage example with argument unpacking

kwargs: ListModelMetadataRequestTypeDef = {  # (1)
    "SearchExpression": ...,
}

parent.list_model_metadata(**kwargs)

1. See ListModelMetadataRequestTypeDef

list_model_package_groups

Gets a list of the model groups in your Amazon Web Services account.

Type annotations and code completion for boto3.client("sagemaker").list_model_package_groups method. boto3 documentation

# list_model_package_groups method definition

def list_model_package_groups(
    self,
    *,
    CreationTimeAfter: TimestampTypeDef = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    MaxResults: int = ...,
    NameContains: str = ...,
    NextToken: str = ...,
    SortBy: ModelPackageGroupSortByType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    CrossAccountFilterOption: CrossAccountFilterOptionType = ...,  # (3)
) -> ListModelPackageGroupsOutputTypeDef:  # (4)
    ...

1. See ModelPackageGroupSortByType
2. See SortOrderType
3. See CrossAccountFilterOptionType
4. See ListModelPackageGroupsOutputTypeDef

# list_model_package_groups method usage example with argument unpacking

kwargs: ListModelPackageGroupsInputTypeDef = {  # (1)
    "CreationTimeAfter": ...,
}

parent.list_model_package_groups(**kwargs)

1. See ListModelPackageGroupsInputTypeDef

list_model_packages

Lists the model packages that have been created.

Type annotations and code completion for boto3.client("sagemaker").list_model_packages method. boto3 documentation

# list_model_packages method definition

def list_model_packages(
    self,
    *,
    CreationTimeAfter: TimestampTypeDef = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    MaxResults: int = ...,
    NameContains: str = ...,
    ModelApprovalStatus: ModelApprovalStatusType = ...,  # (1)
    ModelPackageGroupName: str = ...,
    ModelPackageType: ModelPackageTypeType = ...,  # (2)
    NextToken: str = ...,
    SortBy: ModelPackageSortByType = ...,  # (3)
    SortOrder: SortOrderType = ...,  # (4)
) -> ListModelPackagesOutputTypeDef:  # (5)
    ...

1. See ModelApprovalStatusType
2. See ModelPackageTypeType
3. See ModelPackageSortByType
4. See SortOrderType
5. See ListModelPackagesOutputTypeDef

# list_model_packages method usage example with argument unpacking

kwargs: ListModelPackagesInputTypeDef = {  # (1)
    "CreationTimeAfter": ...,
}

parent.list_model_packages(**kwargs)

1. See ListModelPackagesInputTypeDef

list_model_quality_job_definitions

Gets a list of model quality monitoring job definitions in your account.

Type annotations and code completion for boto3.client("sagemaker").list_model_quality_job_definitions method. boto3 documentation

# list_model_quality_job_definitions method definition

def list_model_quality_job_definitions(
    self,
    *,
    EndpointName: str = ...,
    SortBy: MonitoringJobDefinitionSortKeyType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
    NameContains: str = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    CreationTimeAfter: TimestampTypeDef = ...,
) -> ListModelQualityJobDefinitionsResponseTypeDef:  # (3)
    ...

1. See MonitoringJobDefinitionSortKeyType
2. See SortOrderType
3. See ListModelQualityJobDefinitionsResponseTypeDef

# list_model_quality_job_definitions method usage example with argument unpacking

kwargs: ListModelQualityJobDefinitionsRequestTypeDef = {  # (1)
    "EndpointName": ...,
}

parent.list_model_quality_job_definitions(**kwargs)

1. See ListModelQualityJobDefinitionsRequestTypeDef

list_models

Lists models created with the CreateModel API.

Type annotations and code completion for boto3.client("sagemaker").list_models method. boto3 documentation

# list_models method definition

def list_models(
    self,
    *,
    SortBy: ModelSortKeyType = ...,  # (1)
    SortOrder: OrderKeyType = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
    NameContains: str = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    CreationTimeAfter: TimestampTypeDef = ...,
) -> ListModelsOutputTypeDef:  # (3)
    ...

1. See ModelSortKeyType
2. See OrderKeyType
3. See ListModelsOutputTypeDef

# list_models method usage example with argument unpacking

kwargs: ListModelsInputTypeDef = {  # (1)
    "SortBy": ...,
}

parent.list_models(**kwargs)

1. See ListModelsInputTypeDef

list_monitoring_alert_history

Gets a list of past alerts in a model monitoring schedule.

Type annotations and code completion for boto3.client("sagemaker").list_monitoring_alert_history method. boto3 documentation

# list_monitoring_alert_history method definition

def list_monitoring_alert_history(
    self,
    *,
    MonitoringScheduleName: str = ...,
    MonitoringAlertName: str = ...,
    SortBy: MonitoringAlertHistorySortKeyType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    CreationTimeAfter: TimestampTypeDef = ...,
    StatusEquals: MonitoringAlertStatusType = ...,  # (3)
) -> ListMonitoringAlertHistoryResponseTypeDef:  # (4)
    ...

1. See MonitoringAlertHistorySortKeyType
2. See SortOrderType
3. See MonitoringAlertStatusType
4. See ListMonitoringAlertHistoryResponseTypeDef

# list_monitoring_alert_history method usage example with argument unpacking

kwargs: ListMonitoringAlertHistoryRequestTypeDef = {  # (1)
    "MonitoringScheduleName": ...,
}

parent.list_monitoring_alert_history(**kwargs)

1. See ListMonitoringAlertHistoryRequestTypeDef

list_monitoring_alerts

Gets the alerts for a single monitoring schedule.

Type annotations and code completion for boto3.client("sagemaker").list_monitoring_alerts method. boto3 documentation

# list_monitoring_alerts method definition

def list_monitoring_alerts(
    self,
    *,
    MonitoringScheduleName: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListMonitoringAlertsResponseTypeDef:  # (1)
    ...

1. See ListMonitoringAlertsResponseTypeDef

# list_monitoring_alerts method usage example with argument unpacking

kwargs: ListMonitoringAlertsRequestTypeDef = {  # (1)
    "MonitoringScheduleName": ...,
}

parent.list_monitoring_alerts(**kwargs)

1. See ListMonitoringAlertsRequestTypeDef

list_monitoring_executions

Returns list of all monitoring job executions.

Type annotations and code completion for boto3.client("sagemaker").list_monitoring_executions method. boto3 documentation

# list_monitoring_executions method definition

def list_monitoring_executions(
    self,
    *,
    MonitoringScheduleName: str = ...,
    EndpointName: str = ...,
    SortBy: MonitoringExecutionSortKeyType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
    ScheduledTimeBefore: TimestampTypeDef = ...,
    ScheduledTimeAfter: TimestampTypeDef = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    CreationTimeAfter: TimestampTypeDef = ...,
    LastModifiedTimeBefore: TimestampTypeDef = ...,
    LastModifiedTimeAfter: TimestampTypeDef = ...,
    StatusEquals: ExecutionStatusType = ...,  # (3)
    MonitoringJobDefinitionName: str = ...,
    MonitoringTypeEquals: MonitoringTypeType = ...,  # (4)
) -> ListMonitoringExecutionsResponseTypeDef:  # (5)
    ...

1. See MonitoringExecutionSortKeyType
2. See SortOrderType
3. See ExecutionStatusType
4. See MonitoringTypeType
5. See ListMonitoringExecutionsResponseTypeDef

# list_monitoring_executions method usage example with argument unpacking

kwargs: ListMonitoringExecutionsRequestTypeDef = {  # (1)
    "MonitoringScheduleName": ...,
}

parent.list_monitoring_executions(**kwargs)

1. See ListMonitoringExecutionsRequestTypeDef

list_monitoring_schedules

Returns list of all monitoring schedules.

Type annotations and code completion for boto3.client("sagemaker").list_monitoring_schedules method. boto3 documentation

# list_monitoring_schedules method definition

def list_monitoring_schedules(
    self,
    *,
    EndpointName: str = ...,
    SortBy: MonitoringScheduleSortKeyType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
    NameContains: str = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    CreationTimeAfter: TimestampTypeDef = ...,
    LastModifiedTimeBefore: TimestampTypeDef = ...,
    LastModifiedTimeAfter: TimestampTypeDef = ...,
    StatusEquals: ScheduleStatusType = ...,  # (3)
    MonitoringJobDefinitionName: str = ...,
    MonitoringTypeEquals: MonitoringTypeType = ...,  # (4)
) -> ListMonitoringSchedulesResponseTypeDef:  # (5)
    ...

1. See MonitoringScheduleSortKeyType
2. See SortOrderType
3. See ScheduleStatusType
4. See MonitoringTypeType
5. See ListMonitoringSchedulesResponseTypeDef

# list_monitoring_schedules method usage example with argument unpacking

kwargs: ListMonitoringSchedulesRequestTypeDef = {  # (1)
    "EndpointName": ...,
}

parent.list_monitoring_schedules(**kwargs)

1. See ListMonitoringSchedulesRequestTypeDef

list_notebook_instance_lifecycle_configs

Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.

Type annotations and code completion for boto3.client("sagemaker").list_notebook_instance_lifecycle_configs method. boto3 documentation

# list_notebook_instance_lifecycle_configs method definition

def list_notebook_instance_lifecycle_configs(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    SortBy: NotebookInstanceLifecycleConfigSortKeyType = ...,  # (1)
    SortOrder: NotebookInstanceLifecycleConfigSortOrderType = ...,  # (2)
    NameContains: str = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    CreationTimeAfter: TimestampTypeDef = ...,
    LastModifiedTimeBefore: TimestampTypeDef = ...,
    LastModifiedTimeAfter: TimestampTypeDef = ...,
) -> ListNotebookInstanceLifecycleConfigsOutputTypeDef:  # (3)
    ...

1. See NotebookInstanceLifecycleConfigSortKeyType
2. See NotebookInstanceLifecycleConfigSortOrderType
3. See ListNotebookInstanceLifecycleConfigsOutputTypeDef

# list_notebook_instance_lifecycle_configs method usage example with argument unpacking

kwargs: ListNotebookInstanceLifecycleConfigsInputTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_notebook_instance_lifecycle_configs(**kwargs)

1. See ListNotebookInstanceLifecycleConfigsInputTypeDef

list_notebook_instances

Returns a list of the SageMaker AI notebook instances in the requester's account in an Amazon Web Services Region.

Type annotations and code completion for boto3.client("sagemaker").list_notebook_instances method. boto3 documentation

# list_notebook_instances method definition

def list_notebook_instances(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    SortBy: NotebookInstanceSortKeyType = ...,  # (1)
    SortOrder: NotebookInstanceSortOrderType = ...,  # (2)
    NameContains: str = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    CreationTimeAfter: TimestampTypeDef = ...,
    LastModifiedTimeBefore: TimestampTypeDef = ...,
    LastModifiedTimeAfter: TimestampTypeDef = ...,
    StatusEquals: NotebookInstanceStatusType = ...,  # (3)
    NotebookInstanceLifecycleConfigNameContains: str = ...,
    DefaultCodeRepositoryContains: str = ...,
    AdditionalCodeRepositoryEquals: str = ...,
) -> ListNotebookInstancesOutputTypeDef:  # (4)
    ...

1. See NotebookInstanceSortKeyType
2. See NotebookInstanceSortOrderType
3. See NotebookInstanceStatusType
4. See ListNotebookInstancesOutputTypeDef

# list_notebook_instances method usage example with argument unpacking

kwargs: ListNotebookInstancesInputTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_notebook_instances(**kwargs)

1. See ListNotebookInstancesInputTypeDef

list_optimization_jobs

Lists the optimization jobs in your account and their properties.

Type annotations and code completion for boto3.client("sagemaker").list_optimization_jobs method. boto3 documentation

# list_optimization_jobs method definition

def list_optimization_jobs(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    CreationTimeAfter: TimestampTypeDef = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    LastModifiedTimeAfter: TimestampTypeDef = ...,
    LastModifiedTimeBefore: TimestampTypeDef = ...,
    OptimizationContains: str = ...,
    NameContains: str = ...,
    StatusEquals: OptimizationJobStatusType = ...,  # (1)
    SortBy: ListOptimizationJobsSortByType = ...,  # (2)
    SortOrder: SortOrderType = ...,  # (3)
) -> ListOptimizationJobsResponseTypeDef:  # (4)
    ...

1. See OptimizationJobStatusType
2. See ListOptimizationJobsSortByType
3. See SortOrderType
4. See ListOptimizationJobsResponseTypeDef

# list_optimization_jobs method usage example with argument unpacking

kwargs: ListOptimizationJobsRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_optimization_jobs(**kwargs)

1. See ListOptimizationJobsRequestTypeDef

list_partner_apps

Lists all of the SageMaker Partner AI Apps in an account.

Type annotations and code completion for boto3.client("sagemaker").list_partner_apps method. boto3 documentation

# list_partner_apps method definition

def list_partner_apps(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListPartnerAppsResponseTypeDef:  # (1)
    ...

1. See ListPartnerAppsResponseTypeDef

# list_partner_apps method usage example with argument unpacking

kwargs: ListPartnerAppsRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_partner_apps(**kwargs)

1. See ListPartnerAppsRequestTypeDef

list_pipeline_execution_steps

Gets a list of PipeLineExecutionStep objects.

Type annotations and code completion for boto3.client("sagemaker").list_pipeline_execution_steps method. boto3 documentation

# list_pipeline_execution_steps method definition

def list_pipeline_execution_steps(
    self,
    *,
    PipelineExecutionArn: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
    SortOrder: SortOrderType = ...,  # (1)
) -> ListPipelineExecutionStepsResponseTypeDef:  # (2)
    ...

1. See SortOrderType
2. See ListPipelineExecutionStepsResponseTypeDef

# list_pipeline_execution_steps method usage example with argument unpacking

kwargs: ListPipelineExecutionStepsRequestTypeDef = {  # (1)
    "PipelineExecutionArn": ...,
}

parent.list_pipeline_execution_steps(**kwargs)

1. See ListPipelineExecutionStepsRequestTypeDef

list_pipeline_executions

Gets a list of the pipeline executions.

Type annotations and code completion for boto3.client("sagemaker").list_pipeline_executions method. boto3 documentation

# list_pipeline_executions method definition

def list_pipeline_executions(
    self,
    *,
    PipelineName: str,
    CreatedAfter: TimestampTypeDef = ...,
    CreatedBefore: TimestampTypeDef = ...,
    SortBy: SortPipelineExecutionsByType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListPipelineExecutionsResponseTypeDef:  # (3)
    ...

1. See SortPipelineExecutionsByType
2. See SortOrderType
3. See ListPipelineExecutionsResponseTypeDef

# list_pipeline_executions method usage example with argument unpacking

kwargs: ListPipelineExecutionsRequestTypeDef = {  # (1)
    "PipelineName": ...,
}

parent.list_pipeline_executions(**kwargs)

1. See ListPipelineExecutionsRequestTypeDef

list_pipeline_parameters_for_execution

Gets a list of parameters for a pipeline execution.

Type annotations and code completion for boto3.client("sagemaker").list_pipeline_parameters_for_execution method. boto3 documentation

# list_pipeline_parameters_for_execution method definition

def list_pipeline_parameters_for_execution(
    self,
    *,
    PipelineExecutionArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListPipelineParametersForExecutionResponseTypeDef:  # (1)
    ...

1. See ListPipelineParametersForExecutionResponseTypeDef

# list_pipeline_parameters_for_execution method usage example with argument unpacking

kwargs: ListPipelineParametersForExecutionRequestTypeDef = {  # (1)
    "PipelineExecutionArn": ...,
}

parent.list_pipeline_parameters_for_execution(**kwargs)

1. See ListPipelineParametersForExecutionRequestTypeDef

list_pipelines

Gets a list of pipelines.

Type annotations and code completion for boto3.client("sagemaker").list_pipelines method. boto3 documentation

# list_pipelines method definition

def list_pipelines(
    self,
    *,
    PipelineNamePrefix: str = ...,
    CreatedAfter: TimestampTypeDef = ...,
    CreatedBefore: TimestampTypeDef = ...,
    SortBy: SortPipelinesByType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListPipelinesResponseTypeDef:  # (3)
    ...

1. See SortPipelinesByType
2. See SortOrderType
3. See ListPipelinesResponseTypeDef

# list_pipelines method usage example with argument unpacking

kwargs: ListPipelinesRequestTypeDef = {  # (1)
    "PipelineNamePrefix": ...,
}

parent.list_pipelines(**kwargs)

1. See ListPipelinesRequestTypeDef

list_processing_jobs

Lists processing jobs that satisfy various filters.

Type annotations and code completion for boto3.client("sagemaker").list_processing_jobs method. boto3 documentation

# list_processing_jobs method definition

def list_processing_jobs(
    self,
    *,
    CreationTimeAfter: TimestampTypeDef = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    LastModifiedTimeAfter: TimestampTypeDef = ...,
    LastModifiedTimeBefore: TimestampTypeDef = ...,
    NameContains: str = ...,
    StatusEquals: ProcessingJobStatusType = ...,  # (1)
    SortBy: SortByType = ...,  # (2)
    SortOrder: SortOrderType = ...,  # (3)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListProcessingJobsResponseTypeDef:  # (4)
    ...

1. See ProcessingJobStatusType
2. See SortByType
3. See SortOrderType
4. See ListProcessingJobsResponseTypeDef

# list_processing_jobs method usage example with argument unpacking

kwargs: ListProcessingJobsRequestTypeDef = {  # (1)
    "CreationTimeAfter": ...,
}

parent.list_processing_jobs(**kwargs)

1. See ListProcessingJobsRequestTypeDef

list_projects

Gets a list of the projects in an Amazon Web Services account.

Type annotations and code completion for boto3.client("sagemaker").list_projects method. boto3 documentation

# list_projects method definition

def list_projects(
    self,
    *,
    CreationTimeAfter: TimestampTypeDef = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    MaxResults: int = ...,
    NameContains: str = ...,
    NextToken: str = ...,
    SortBy: ProjectSortByType = ...,  # (1)
    SortOrder: ProjectSortOrderType = ...,  # (2)
) -> ListProjectsOutputTypeDef:  # (3)
    ...

1. See ProjectSortByType
2. See ProjectSortOrderType
3. See ListProjectsOutputTypeDef

# list_projects method usage example with argument unpacking

kwargs: ListProjectsInputTypeDef = {  # (1)
    "CreationTimeAfter": ...,
}

parent.list_projects(**kwargs)

1. See ListProjectsInputTypeDef

list_resource_catalogs

Lists Amazon SageMaker Catalogs based on given filters and orders.

Type annotations and code completion for boto3.client("sagemaker").list_resource_catalogs method. boto3 documentation

# list_resource_catalogs method definition

def list_resource_catalogs(
    self,
    *,
    NameContains: str = ...,
    CreationTimeAfter: TimestampTypeDef = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    SortOrder: ResourceCatalogSortOrderType = ...,  # (1)
    SortBy: ResourceCatalogSortByType = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListResourceCatalogsResponseTypeDef:  # (3)
    ...

1. See ResourceCatalogSortOrderType
2. See ResourceCatalogSortByType
3. See ListResourceCatalogsResponseTypeDef

# list_resource_catalogs method usage example with argument unpacking

kwargs: ListResourceCatalogsRequestTypeDef = {  # (1)
    "NameContains": ...,
}

parent.list_resource_catalogs(**kwargs)

1. See ListResourceCatalogsRequestTypeDef

list_spaces

Lists spaces.

Type annotations and code completion for boto3.client("sagemaker").list_spaces method. boto3 documentation

# list_spaces method definition

def list_spaces(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    SortOrder: SortOrderType = ...,  # (1)
    SortBy: SpaceSortKeyType = ...,  # (2)
    DomainIdEquals: str = ...,
    SpaceNameContains: str = ...,
) -> ListSpacesResponseTypeDef:  # (3)
    ...

1. See SortOrderType
2. See SpaceSortKeyType
3. See ListSpacesResponseTypeDef

# list_spaces method usage example with argument unpacking

kwargs: ListSpacesRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_spaces(**kwargs)

1. See ListSpacesRequestTypeDef

list_stage_devices

Lists devices allocated to the stage, containing detailed device information and deployment status.

Type annotations and code completion for boto3.client("sagemaker").list_stage_devices method. boto3 documentation

# list_stage_devices method definition

def list_stage_devices(
    self,
    *,
    EdgeDeploymentPlanName: str,
    StageName: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    ExcludeDevicesDeployedInOtherStage: bool = ...,
) -> ListStageDevicesResponseTypeDef:  # (1)
    ...

1. See ListStageDevicesResponseTypeDef

# list_stage_devices method usage example with argument unpacking

kwargs: ListStageDevicesRequestTypeDef = {  # (1)
    "EdgeDeploymentPlanName": ...,
    "StageName": ...,
}

parent.list_stage_devices(**kwargs)

1. See ListStageDevicesRequestTypeDef

list_studio_lifecycle_configs

Lists the Amazon SageMaker AI Studio Lifecycle Configurations in your Amazon Web Services Account.

Type annotations and code completion for boto3.client("sagemaker").list_studio_lifecycle_configs method. boto3 documentation

# list_studio_lifecycle_configs method definition

def list_studio_lifecycle_configs(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
    NameContains: str = ...,
    AppTypeEquals: StudioLifecycleConfigAppTypeType = ...,  # (1)
    CreationTimeBefore: TimestampTypeDef = ...,
    CreationTimeAfter: TimestampTypeDef = ...,
    ModifiedTimeBefore: TimestampTypeDef = ...,
    ModifiedTimeAfter: TimestampTypeDef = ...,
    SortBy: StudioLifecycleConfigSortKeyType = ...,  # (2)
    SortOrder: SortOrderType = ...,  # (3)
) -> ListStudioLifecycleConfigsResponseTypeDef:  # (4)
    ...

1. See StudioLifecycleConfigAppTypeType
2. See StudioLifecycleConfigSortKeyType
3. See SortOrderType
4. See ListStudioLifecycleConfigsResponseTypeDef

# list_studio_lifecycle_configs method usage example with argument unpacking

kwargs: ListStudioLifecycleConfigsRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_studio_lifecycle_configs(**kwargs)

1. See ListStudioLifecycleConfigsRequestTypeDef

list_subscribed_workteams

Gets a list of the work teams that you are subscribed to in the Amazon Web Services Marketplace.

Type annotations and code completion for boto3.client("sagemaker").list_subscribed_workteams method. boto3 documentation

# list_subscribed_workteams method definition

def list_subscribed_workteams(
    self,
    *,
    NameContains: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListSubscribedWorkteamsResponseTypeDef:  # (1)
    ...

1. See ListSubscribedWorkteamsResponseTypeDef

# list_subscribed_workteams method usage example with argument unpacking

kwargs: ListSubscribedWorkteamsRequestTypeDef = {  # (1)
    "NameContains": ...,
}

parent.list_subscribed_workteams(**kwargs)

1. See ListSubscribedWorkteamsRequestTypeDef

list_tags

Returns the tags for the specified SageMaker resource.

Type annotations and code completion for boto3.client("sagemaker").list_tags method. boto3 documentation

# list_tags method definition

def list_tags(
    self,
    *,
    ResourceArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListTagsOutputTypeDef:  # (1)
    ...

1. See ListTagsOutputTypeDef

# list_tags method usage example with argument unpacking

kwargs: ListTagsInputTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags(**kwargs)

1. See ListTagsInputTypeDef

list_training_jobs

Lists training jobs.

Type annotations and code completion for boto3.client("sagemaker").list_training_jobs method. boto3 documentation

# list_training_jobs method definition

def list_training_jobs(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    CreationTimeAfter: TimestampTypeDef = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    LastModifiedTimeAfter: TimestampTypeDef = ...,
    LastModifiedTimeBefore: TimestampTypeDef = ...,
    NameContains: str = ...,
    StatusEquals: TrainingJobStatusType = ...,  # (1)
    SortBy: SortByType = ...,  # (2)
    SortOrder: SortOrderType = ...,  # (3)
    WarmPoolStatusEquals: WarmPoolResourceStatusType = ...,  # (4)
    TrainingPlanArnEquals: str = ...,
) -> ListTrainingJobsResponseTypeDef:  # (5)
    ...

1. See TrainingJobStatusType
2. See SortByType
3. See SortOrderType
4. See WarmPoolResourceStatusType
5. See ListTrainingJobsResponseTypeDef

# list_training_jobs method usage example with argument unpacking

kwargs: ListTrainingJobsRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_training_jobs(**kwargs)

1. See ListTrainingJobsRequestTypeDef

list_training_jobs_for_hyper_parameter_tuning_job

Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.

Type annotations and code completion for boto3.client("sagemaker").list_training_jobs_for_hyper_parameter_tuning_job method. boto3 documentation

# list_training_jobs_for_hyper_parameter_tuning_job method definition

def list_training_jobs_for_hyper_parameter_tuning_job(
    self,
    *,
    HyperParameterTuningJobName: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    StatusEquals: TrainingJobStatusType = ...,  # (1)
    SortBy: TrainingJobSortByOptionsType = ...,  # (2)
    SortOrder: SortOrderType = ...,  # (3)
) -> ListTrainingJobsForHyperParameterTuningJobResponseTypeDef:  # (4)
    ...

1. See TrainingJobStatusType
2. See TrainingJobSortByOptionsType
3. See SortOrderType
4. See ListTrainingJobsForHyperParameterTuningJobResponseTypeDef

# list_training_jobs_for_hyper_parameter_tuning_job method usage example with argument unpacking

kwargs: ListTrainingJobsForHyperParameterTuningJobRequestTypeDef = {  # (1)
    "HyperParameterTuningJobName": ...,
}

parent.list_training_jobs_for_hyper_parameter_tuning_job(**kwargs)

1. See ListTrainingJobsForHyperParameterTuningJobRequestTypeDef

list_training_plans

Retrieves a list of training plans for the current account.

Type annotations and code completion for boto3.client("sagemaker").list_training_plans method. boto3 documentation

# list_training_plans method definition

def list_training_plans(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    StartTimeAfter: TimestampTypeDef = ...,
    StartTimeBefore: TimestampTypeDef = ...,
    SortBy: TrainingPlanSortByType = ...,  # (1)
    SortOrder: TrainingPlanSortOrderType = ...,  # (2)
    Filters: Sequence[TrainingPlanFilterTypeDef] = ...,  # (3)
) -> ListTrainingPlansResponseTypeDef:  # (4)
    ...

1. See TrainingPlanSortByType
2. See TrainingPlanSortOrderType
3. See Sequence[TrainingPlanFilterTypeDef]
4. See ListTrainingPlansResponseTypeDef

# list_training_plans method usage example with argument unpacking

kwargs: ListTrainingPlansRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_training_plans(**kwargs)

1. See ListTrainingPlansRequestTypeDef

list_transform_jobs

Lists transform jobs.

Type annotations and code completion for boto3.client("sagemaker").list_transform_jobs method. boto3 documentation

# list_transform_jobs method definition

def list_transform_jobs(
    self,
    *,
    CreationTimeAfter: TimestampTypeDef = ...,
    CreationTimeBefore: TimestampTypeDef = ...,
    LastModifiedTimeAfter: TimestampTypeDef = ...,
    LastModifiedTimeBefore: TimestampTypeDef = ...,
    NameContains: str = ...,
    StatusEquals: TransformJobStatusType = ...,  # (1)
    SortBy: SortByType = ...,  # (2)
    SortOrder: SortOrderType = ...,  # (3)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListTransformJobsResponseTypeDef:  # (4)
    ...

1. See TransformJobStatusType
2. See SortByType
3. See SortOrderType
4. See ListTransformJobsResponseTypeDef

# list_transform_jobs method usage example with argument unpacking

kwargs: ListTransformJobsRequestTypeDef = {  # (1)
    "CreationTimeAfter": ...,
}

parent.list_transform_jobs(**kwargs)

1. See ListTransformJobsRequestTypeDef

list_trial_components

Lists the trial components in your account.

Type annotations and code completion for boto3.client("sagemaker").list_trial_components method. boto3 documentation

# list_trial_components method definition

def list_trial_components(
    self,
    *,
    ExperimentName: str = ...,
    TrialName: str = ...,
    SourceArn: str = ...,
    CreatedAfter: TimestampTypeDef = ...,
    CreatedBefore: TimestampTypeDef = ...,
    SortBy: SortTrialComponentsByType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListTrialComponentsResponseTypeDef:  # (3)
    ...

1. See SortTrialComponentsByType
2. See SortOrderType
3. See ListTrialComponentsResponseTypeDef

# list_trial_components method usage example with argument unpacking

kwargs: ListTrialComponentsRequestTypeDef = {  # (1)
    "ExperimentName": ...,
}

parent.list_trial_components(**kwargs)

1. See ListTrialComponentsRequestTypeDef

list_trials

Lists the trials in your account.

Type annotations and code completion for boto3.client("sagemaker").list_trials method. boto3 documentation

# list_trials method definition

def list_trials(
    self,
    *,
    ExperimentName: str = ...,
    TrialComponentName: str = ...,
    CreatedAfter: TimestampTypeDef = ...,
    CreatedBefore: TimestampTypeDef = ...,
    SortBy: SortTrialsByType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListTrialsResponseTypeDef:  # (3)
    ...

1. See SortTrialsByType
2. See SortOrderType
3. See ListTrialsResponseTypeDef

# list_trials method usage example with argument unpacking

kwargs: ListTrialsRequestTypeDef = {  # (1)
    "ExperimentName": ...,
}

parent.list_trials(**kwargs)

1. See ListTrialsRequestTypeDef

list_user_profiles

Lists user profiles.

Type annotations and code completion for boto3.client("sagemaker").list_user_profiles method. boto3 documentation

# list_user_profiles method definition

def list_user_profiles(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    SortOrder: SortOrderType = ...,  # (1)
    SortBy: UserProfileSortKeyType = ...,  # (2)
    DomainIdEquals: str = ...,
    UserProfileNameContains: str = ...,
) -> ListUserProfilesResponseTypeDef:  # (3)
    ...

1. See SortOrderType
2. See UserProfileSortKeyType
3. See ListUserProfilesResponseTypeDef

# list_user_profiles method usage example with argument unpacking

kwargs: ListUserProfilesRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_user_profiles(**kwargs)

1. See ListUserProfilesRequestTypeDef

list_workforces

Use this operation to list all private and vendor workforces in an Amazon Web Services Region.

Type annotations and code completion for boto3.client("sagemaker").list_workforces method. boto3 documentation

# list_workforces method definition

def list_workforces(
    self,
    *,
    SortBy: ListWorkforcesSortByOptionsType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    NameContains: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListWorkforcesResponseTypeDef:  # (3)
    ...

1. See ListWorkforcesSortByOptionsType
2. See SortOrderType
3. See ListWorkforcesResponseTypeDef

# list_workforces method usage example with argument unpacking

kwargs: ListWorkforcesRequestTypeDef = {  # (1)
    "SortBy": ...,
}

parent.list_workforces(**kwargs)

1. See ListWorkforcesRequestTypeDef

list_workteams

Gets a list of private work teams that you have defined in a region.

Type annotations and code completion for boto3.client("sagemaker").list_workteams method. boto3 documentation

# list_workteams method definition

def list_workteams(
    self,
    *,
    SortBy: ListWorkteamsSortByOptionsType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    NameContains: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListWorkteamsResponseTypeDef:  # (3)
    ...

1. See ListWorkteamsSortByOptionsType
2. See SortOrderType
3. See ListWorkteamsResponseTypeDef

# list_workteams method usage example with argument unpacking

kwargs: ListWorkteamsRequestTypeDef = {  # (1)
    "SortBy": ...,
}

parent.list_workteams(**kwargs)

1. See ListWorkteamsRequestTypeDef

put_model_package_group_policy

Adds a resouce policy to control access to a model group.

Type annotations and code completion for boto3.client("sagemaker").put_model_package_group_policy method. boto3 documentation

# put_model_package_group_policy method definition

def put_model_package_group_policy(
    self,
    *,
    ModelPackageGroupName: str,
    ResourcePolicy: str,
) -> PutModelPackageGroupPolicyOutputTypeDef:  # (1)
    ...

1. See PutModelPackageGroupPolicyOutputTypeDef

# put_model_package_group_policy method usage example with argument unpacking

kwargs: PutModelPackageGroupPolicyInputTypeDef = {  # (1)
    "ModelPackageGroupName": ...,
    "ResourcePolicy": ...,
}

parent.put_model_package_group_policy(**kwargs)

1. See PutModelPackageGroupPolicyInputTypeDef

query_lineage

Use this action to inspect your lineage and discover relationships between entities.

Type annotations and code completion for boto3.client("sagemaker").query_lineage method. boto3 documentation

# query_lineage method definition

def query_lineage(
    self,
    *,
    StartArns: Sequence[str] = ...,
    Direction: DirectionType = ...,  # (1)
    IncludeEdges: bool = ...,
    Filters: QueryFiltersTypeDef = ...,  # (2)
    MaxDepth: int = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> QueryLineageResponseTypeDef:  # (3)
    ...

1. See DirectionType
2. See QueryFiltersTypeDef
3. See QueryLineageResponseTypeDef

# query_lineage method usage example with argument unpacking

kwargs: QueryLineageRequestTypeDef = {  # (1)
    "StartArns": ...,
}

parent.query_lineage(**kwargs)

1. See QueryLineageRequestTypeDef

register_devices

Register devices.

Type annotations and code completion for boto3.client("sagemaker").register_devices method. boto3 documentation

# register_devices method definition

def register_devices(
    self,
    *,
    DeviceFleetName: str,
    Devices: Sequence[DeviceTypeDef],  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...

1. See Sequence[DeviceTypeDef]
2. See Sequence[TagTypeDef]
3. See EmptyResponseMetadataTypeDef

# register_devices method usage example with argument unpacking

kwargs: RegisterDevicesRequestTypeDef = {  # (1)
    "DeviceFleetName": ...,
    "Devices": ...,
}

parent.register_devices(**kwargs)

1. See RegisterDevicesRequestTypeDef

render_ui_template

Renders the UI template so that you can preview the worker's experience.

Type annotations and code completion for boto3.client("sagemaker").render_ui_template method. boto3 documentation

# render_ui_template method definition

def render_ui_template(
    self,
    *,
    Task: RenderableTaskTypeDef,  # (1)
    RoleArn: str,
    UiTemplate: UiTemplateTypeDef = ...,  # (2)
    HumanTaskUiArn: str = ...,
) -> RenderUiTemplateResponseTypeDef:  # (3)
    ...

1. See RenderableTaskTypeDef
2. See UiTemplateTypeDef
3. See RenderUiTemplateResponseTypeDef

# render_ui_template method usage example with argument unpacking

kwargs: RenderUiTemplateRequestTypeDef = {  # (1)
    "Task": ...,
    "RoleArn": ...,
}

parent.render_ui_template(**kwargs)

1. See RenderUiTemplateRequestTypeDef

retry_pipeline_execution

Retry the execution of the pipeline.

Type annotations and code completion for boto3.client("sagemaker").retry_pipeline_execution method. boto3 documentation

# retry_pipeline_execution method definition

def retry_pipeline_execution(
    self,
    *,
    PipelineExecutionArn: str,
    ClientRequestToken: str,
    ParallelismConfiguration: ParallelismConfigurationTypeDef = ...,  # (1)
) -> RetryPipelineExecutionResponseTypeDef:  # (2)
    ...

1. See ParallelismConfigurationTypeDef
2. See RetryPipelineExecutionResponseTypeDef

# retry_pipeline_execution method usage example with argument unpacking

kwargs: RetryPipelineExecutionRequestTypeDef = {  # (1)
    "PipelineExecutionArn": ...,
    "ClientRequestToken": ...,
}

parent.retry_pipeline_execution(**kwargs)

1. See RetryPipelineExecutionRequestTypeDef

search

Finds SageMaker resources that match a search query.

Type annotations and code completion for boto3.client("sagemaker").search method. boto3 documentation

# search method definition

def search(
    self,
    *,
    Resource: ResourceTypeType,  # (1)
    SearchExpression: SearchExpressionTypeDef = ...,  # (2)
    SortBy: str = ...,
    SortOrder: SearchSortOrderType = ...,  # (3)
    NextToken: str = ...,
    MaxResults: int = ...,
    CrossAccountFilterOption: CrossAccountFilterOptionType = ...,  # (4)
    VisibilityConditions: Sequence[VisibilityConditionsTypeDef] = ...,  # (5)
) -> SearchResponseTypeDef:  # (6)
    ...

1. See ResourceTypeType
2. See SearchExpressionTypeDef
3. See SearchSortOrderType
4. See CrossAccountFilterOptionType
5. See Sequence[VisibilityConditionsTypeDef]
6. See SearchResponseTypeDef

# search method usage example with argument unpacking

kwargs: SearchRequestTypeDef = {  # (1)
    "Resource": ...,
}

parent.search(**kwargs)

1. See SearchRequestTypeDef

search_training_plan_offerings

Searches for available training plan offerings based on specified criteria.

Type annotations and code completion for boto3.client("sagemaker").search_training_plan_offerings method. boto3 documentation

# search_training_plan_offerings method definition

def search_training_plan_offerings(
    self,
    *,
    DurationHours: int,
    TargetResources: Sequence[SageMakerResourceNameType],  # (1)
    InstanceType: ReservedCapacityInstanceTypeType = ...,  # (2)
    InstanceCount: int = ...,
    StartTimeAfter: TimestampTypeDef = ...,
    EndTimeBefore: TimestampTypeDef = ...,
) -> SearchTrainingPlanOfferingsResponseTypeDef:  # (3)
    ...

1. See Sequence[SageMakerResourceNameType]
2. See ReservedCapacityInstanceTypeType
3. See SearchTrainingPlanOfferingsResponseTypeDef

# search_training_plan_offerings method usage example with argument unpacking

kwargs: SearchTrainingPlanOfferingsRequestTypeDef = {  # (1)
    "DurationHours": ...,
    "TargetResources": ...,
}

parent.search_training_plan_offerings(**kwargs)

1. See SearchTrainingPlanOfferingsRequestTypeDef

send_pipeline_execution_step_failure

Notifies the pipeline that the execution of a callback step failed, along with a message describing why.

Type annotations and code completion for boto3.client("sagemaker").send_pipeline_execution_step_failure method. boto3 documentation

# send_pipeline_execution_step_failure method definition

def send_pipeline_execution_step_failure(
    self,
    *,
    CallbackToken: str,
    FailureReason: str = ...,
    ClientRequestToken: str = ...,
) -> SendPipelineExecutionStepFailureResponseTypeDef:  # (1)
    ...

1. See SendPipelineExecutionStepFailureResponseTypeDef

# send_pipeline_execution_step_failure method usage example with argument unpacking

kwargs: SendPipelineExecutionStepFailureRequestTypeDef = {  # (1)
    "CallbackToken": ...,
}

parent.send_pipeline_execution_step_failure(**kwargs)

1. See SendPipelineExecutionStepFailureRequestTypeDef

send_pipeline_execution_step_success

Notifies the pipeline that the execution of a callback step succeeded and provides a list of the step's output parameters.

Type annotations and code completion for boto3.client("sagemaker").send_pipeline_execution_step_success method. boto3 documentation

# send_pipeline_execution_step_success method definition

def send_pipeline_execution_step_success(
    self,
    *,
    CallbackToken: str,
    OutputParameters: Sequence[OutputParameterTypeDef] = ...,  # (1)
    ClientRequestToken: str = ...,
) -> SendPipelineExecutionStepSuccessResponseTypeDef:  # (2)
    ...

1. See Sequence[OutputParameterTypeDef]
2. See SendPipelineExecutionStepSuccessResponseTypeDef

# send_pipeline_execution_step_success method usage example with argument unpacking

kwargs: SendPipelineExecutionStepSuccessRequestTypeDef = {  # (1)
    "CallbackToken": ...,
}

parent.send_pipeline_execution_step_success(**kwargs)

1. See SendPipelineExecutionStepSuccessRequestTypeDef

start_edge_deployment_stage

Starts a stage in an edge deployment plan.

Type annotations and code completion for boto3.client("sagemaker").start_edge_deployment_stage method. boto3 documentation

# start_edge_deployment_stage method definition

def start_edge_deployment_stage(
    self,
    *,
    EdgeDeploymentPlanName: str,
    StageName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# start_edge_deployment_stage method usage example with argument unpacking

kwargs: StartEdgeDeploymentStageRequestTypeDef = {  # (1)
    "EdgeDeploymentPlanName": ...,
    "StageName": ...,
}

parent.start_edge_deployment_stage(**kwargs)

1. See StartEdgeDeploymentStageRequestTypeDef

start_inference_experiment

Starts an inference experiment.

Type annotations and code completion for boto3.client("sagemaker").start_inference_experiment method. boto3 documentation

# start_inference_experiment method definition

def start_inference_experiment(
    self,
    *,
    Name: str,
) -> StartInferenceExperimentResponseTypeDef:  # (1)
    ...

1. See StartInferenceExperimentResponseTypeDef

# start_inference_experiment method usage example with argument unpacking

kwargs: StartInferenceExperimentRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.start_inference_experiment(**kwargs)

1. See StartInferenceExperimentRequestTypeDef

start_mlflow_tracking_server

Programmatically start an MLflow Tracking Server.

Type annotations and code completion for boto3.client("sagemaker").start_mlflow_tracking_server method. boto3 documentation

# start_mlflow_tracking_server method definition

def start_mlflow_tracking_server(
    self,
    *,
    TrackingServerName: str,
) -> StartMlflowTrackingServerResponseTypeDef:  # (1)
    ...

1. See StartMlflowTrackingServerResponseTypeDef

# start_mlflow_tracking_server method usage example with argument unpacking

kwargs: StartMlflowTrackingServerRequestTypeDef = {  # (1)
    "TrackingServerName": ...,
}

parent.start_mlflow_tracking_server(**kwargs)

1. See StartMlflowTrackingServerRequestTypeDef

start_monitoring_schedule

Starts a previously stopped monitoring schedule.

Type annotations and code completion for boto3.client("sagemaker").start_monitoring_schedule method. boto3 documentation

# start_monitoring_schedule method definition

def start_monitoring_schedule(
    self,
    *,
    MonitoringScheduleName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# start_monitoring_schedule method usage example with argument unpacking

kwargs: StartMonitoringScheduleRequestTypeDef = {  # (1)
    "MonitoringScheduleName": ...,
}

parent.start_monitoring_schedule(**kwargs)

1. See StartMonitoringScheduleRequestTypeDef

start_notebook_instance

Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume.

Type annotations and code completion for boto3.client("sagemaker").start_notebook_instance method. boto3 documentation

# start_notebook_instance method definition

def start_notebook_instance(
    self,
    *,
    NotebookInstanceName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# start_notebook_instance method usage example with argument unpacking

kwargs: StartNotebookInstanceInputTypeDef = {  # (1)
    "NotebookInstanceName": ...,
}

parent.start_notebook_instance(**kwargs)

1. See StartNotebookInstanceInputTypeDef

start_pipeline_execution

Starts a pipeline execution.

Type annotations and code completion for boto3.client("sagemaker").start_pipeline_execution method. boto3 documentation

# start_pipeline_execution method definition

def start_pipeline_execution(
    self,
    *,
    PipelineName: str,
    ClientRequestToken: str,
    PipelineExecutionDisplayName: str = ...,
    PipelineParameters: Sequence[ParameterTypeDef] = ...,  # (1)
    PipelineExecutionDescription: str = ...,
    ParallelismConfiguration: ParallelismConfigurationTypeDef = ...,  # (2)
    SelectiveExecutionConfig: SelectiveExecutionConfigUnionTypeDef = ...,  # (3)
) -> StartPipelineExecutionResponseTypeDef:  # (4)
    ...

1. See Sequence[ParameterTypeDef]
2. See ParallelismConfigurationTypeDef
3. See SelectiveExecutionConfigUnionTypeDef
4. See StartPipelineExecutionResponseTypeDef

# start_pipeline_execution method usage example with argument unpacking

kwargs: StartPipelineExecutionRequestTypeDef = {  # (1)
    "PipelineName": ...,
    "ClientRequestToken": ...,
}

parent.start_pipeline_execution(**kwargs)

1. See StartPipelineExecutionRequestTypeDef

start_session

Initiates a remote connection session between a local integrated development environments (IDEs) and a remote SageMaker space.

Type annotations and code completion for boto3.client("sagemaker").start_session method. boto3 documentation

# start_session method definition

def start_session(
    self,
    *,
    ResourceIdentifier: str,
) -> StartSessionResponseTypeDef:  # (1)
    ...

1. See StartSessionResponseTypeDef

# start_session method usage example with argument unpacking

kwargs: StartSessionRequestTypeDef = {  # (1)
    "ResourceIdentifier": ...,
}

parent.start_session(**kwargs)

1. See StartSessionRequestTypeDef

stop_auto_ml_job

A method for forcing a running job to shut down.

Type annotations and code completion for boto3.client("sagemaker").stop_auto_ml_job method. boto3 documentation

# stop_auto_ml_job method definition

def stop_auto_ml_job(
    self,
    *,
    AutoMLJobName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# stop_auto_ml_job method usage example with argument unpacking

kwargs: StopAutoMLJobRequestTypeDef = {  # (1)
    "AutoMLJobName": ...,
}

parent.stop_auto_ml_job(**kwargs)

1. See StopAutoMLJobRequestTypeDef

stop_compilation_job

Stops a model compilation job.

Type annotations and code completion for boto3.client("sagemaker").stop_compilation_job method. boto3 documentation

# stop_compilation_job method definition

def stop_compilation_job(
    self,
    *,
    CompilationJobName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# stop_compilation_job method usage example with argument unpacking

kwargs: StopCompilationJobRequestTypeDef = {  # (1)
    "CompilationJobName": ...,
}

parent.stop_compilation_job(**kwargs)

1. See StopCompilationJobRequestTypeDef

stop_edge_deployment_stage

Stops a stage in an edge deployment plan.

Type annotations and code completion for boto3.client("sagemaker").stop_edge_deployment_stage method. boto3 documentation

# stop_edge_deployment_stage method definition

def stop_edge_deployment_stage(
    self,
    *,
    EdgeDeploymentPlanName: str,
    StageName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# stop_edge_deployment_stage method usage example with argument unpacking

kwargs: StopEdgeDeploymentStageRequestTypeDef = {  # (1)
    "EdgeDeploymentPlanName": ...,
    "StageName": ...,
}

parent.stop_edge_deployment_stage(**kwargs)

1. See StopEdgeDeploymentStageRequestTypeDef

stop_edge_packaging_job

Request to stop an edge packaging job.

Type annotations and code completion for boto3.client("sagemaker").stop_edge_packaging_job method. boto3 documentation

# stop_edge_packaging_job method definition

def stop_edge_packaging_job(
    self,
    *,
    EdgePackagingJobName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# stop_edge_packaging_job method usage example with argument unpacking

kwargs: StopEdgePackagingJobRequestTypeDef = {  # (1)
    "EdgePackagingJobName": ...,
}

parent.stop_edge_packaging_job(**kwargs)

1. See StopEdgePackagingJobRequestTypeDef

stop_hyper_parameter_tuning_job

Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched.

Type annotations and code completion for boto3.client("sagemaker").stop_hyper_parameter_tuning_job method. boto3 documentation

# stop_hyper_parameter_tuning_job method definition

def stop_hyper_parameter_tuning_job(
    self,
    *,
    HyperParameterTuningJobName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# stop_hyper_parameter_tuning_job method usage example with argument unpacking

kwargs: StopHyperParameterTuningJobRequestTypeDef = {  # (1)
    "HyperParameterTuningJobName": ...,
}

parent.stop_hyper_parameter_tuning_job(**kwargs)

1. See StopHyperParameterTuningJobRequestTypeDef

stop_inference_experiment

Stops an inference experiment.

Type annotations and code completion for boto3.client("sagemaker").stop_inference_experiment method. boto3 documentation

# stop_inference_experiment method definition

def stop_inference_experiment(
    self,
    *,
    Name: str,
    ModelVariantActions: Mapping[str, ModelVariantActionType],  # (1)
    DesiredModelVariants: Sequence[ModelVariantConfigTypeDef] = ...,  # (2)
    DesiredState: InferenceExperimentStopDesiredStateType = ...,  # (3)
    Reason: str = ...,
) -> StopInferenceExperimentResponseTypeDef:  # (4)
    ...

1. See Mapping[str, ModelVariantActionType]
2. See Sequence[ModelVariantConfigTypeDef]
3. See InferenceExperimentStopDesiredStateType
4. See StopInferenceExperimentResponseTypeDef

# stop_inference_experiment method usage example with argument unpacking

kwargs: StopInferenceExperimentRequestTypeDef = {  # (1)
    "Name": ...,
    "ModelVariantActions": ...,
}

parent.stop_inference_experiment(**kwargs)

1. See StopInferenceExperimentRequestTypeDef

stop_inference_recommendations_job

Stops an Inference Recommender job.

Type annotations and code completion for boto3.client("sagemaker").stop_inference_recommendations_job method. boto3 documentation

# stop_inference_recommendations_job method definition

def stop_inference_recommendations_job(
    self,
    *,
    JobName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# stop_inference_recommendations_job method usage example with argument unpacking

kwargs: StopInferenceRecommendationsJobRequestTypeDef = {  # (1)
    "JobName": ...,
}

parent.stop_inference_recommendations_job(**kwargs)

1. See StopInferenceRecommendationsJobRequestTypeDef

stop_labeling_job

Stops a running labeling job.

Type annotations and code completion for boto3.client("sagemaker").stop_labeling_job method. boto3 documentation

# stop_labeling_job method definition

def stop_labeling_job(
    self,
    *,
    LabelingJobName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# stop_labeling_job method usage example with argument unpacking

kwargs: StopLabelingJobRequestTypeDef = {  # (1)
    "LabelingJobName": ...,
}

parent.stop_labeling_job(**kwargs)

1. See StopLabelingJobRequestTypeDef

stop_mlflow_tracking_server

Programmatically stop an MLflow Tracking Server.

Type annotations and code completion for boto3.client("sagemaker").stop_mlflow_tracking_server method. boto3 documentation

# stop_mlflow_tracking_server method definition

def stop_mlflow_tracking_server(
    self,
    *,
    TrackingServerName: str,
) -> StopMlflowTrackingServerResponseTypeDef:  # (1)
    ...

1. See StopMlflowTrackingServerResponseTypeDef

# stop_mlflow_tracking_server method usage example with argument unpacking

kwargs: StopMlflowTrackingServerRequestTypeDef = {  # (1)
    "TrackingServerName": ...,
}

parent.stop_mlflow_tracking_server(**kwargs)

1. See StopMlflowTrackingServerRequestTypeDef

stop_monitoring_schedule

Stops a previously started monitoring schedule.

Type annotations and code completion for boto3.client("sagemaker").stop_monitoring_schedule method. boto3 documentation

# stop_monitoring_schedule method definition

def stop_monitoring_schedule(
    self,
    *,
    MonitoringScheduleName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# stop_monitoring_schedule method usage example with argument unpacking

kwargs: StopMonitoringScheduleRequestTypeDef = {  # (1)
    "MonitoringScheduleName": ...,
}

parent.stop_monitoring_schedule(**kwargs)

1. See StopMonitoringScheduleRequestTypeDef

stop_notebook_instance

Terminates the ML compute instance.

Type annotations and code completion for boto3.client("sagemaker").stop_notebook_instance method. boto3 documentation

# stop_notebook_instance method definition

def stop_notebook_instance(
    self,
    *,
    NotebookInstanceName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# stop_notebook_instance method usage example with argument unpacking

kwargs: StopNotebookInstanceInputTypeDef = {  # (1)
    "NotebookInstanceName": ...,
}

parent.stop_notebook_instance(**kwargs)

1. See StopNotebookInstanceInputTypeDef

stop_optimization_job

Ends a running inference optimization job.

Type annotations and code completion for boto3.client("sagemaker").stop_optimization_job method. boto3 documentation

# stop_optimization_job method definition

def stop_optimization_job(
    self,
    *,
    OptimizationJobName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# stop_optimization_job method usage example with argument unpacking

kwargs: StopOptimizationJobRequestTypeDef = {  # (1)
    "OptimizationJobName": ...,
}

parent.stop_optimization_job(**kwargs)

1. See StopOptimizationJobRequestTypeDef

stop_pipeline_execution

Stops a pipeline execution.

Type annotations and code completion for boto3.client("sagemaker").stop_pipeline_execution method. boto3 documentation

# stop_pipeline_execution method definition

def stop_pipeline_execution(
    self,
    *,
    PipelineExecutionArn: str,
    ClientRequestToken: str,
) -> StopPipelineExecutionResponseTypeDef:  # (1)
    ...

1. See StopPipelineExecutionResponseTypeDef

# stop_pipeline_execution method usage example with argument unpacking

kwargs: StopPipelineExecutionRequestTypeDef = {  # (1)
    "PipelineExecutionArn": ...,
    "ClientRequestToken": ...,
}

parent.stop_pipeline_execution(**kwargs)

1. See StopPipelineExecutionRequestTypeDef

stop_processing_job

Stops a processing job.

Type annotations and code completion for boto3.client("sagemaker").stop_processing_job method. boto3 documentation

# stop_processing_job method definition

def stop_processing_job(
    self,
    *,
    ProcessingJobName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# stop_processing_job method usage example with argument unpacking

kwargs: StopProcessingJobRequestTypeDef = {  # (1)
    "ProcessingJobName": ...,
}

parent.stop_processing_job(**kwargs)

1. See StopProcessingJobRequestTypeDef

stop_training_job

Stops a training job.

Type annotations and code completion for boto3.client("sagemaker").stop_training_job method. boto3 documentation

# stop_training_job method definition

def stop_training_job(
    self,
    *,
    TrainingJobName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# stop_training_job method usage example with argument unpacking

kwargs: StopTrainingJobRequestTypeDef = {  # (1)
    "TrainingJobName": ...,
}

parent.stop_training_job(**kwargs)

1. See StopTrainingJobRequestTypeDef

stop_transform_job

Stops a batch transform job.

Type annotations and code completion for boto3.client("sagemaker").stop_transform_job method. boto3 documentation

# stop_transform_job method definition

def stop_transform_job(
    self,
    *,
    TransformJobName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# stop_transform_job method usage example with argument unpacking

kwargs: StopTransformJobRequestTypeDef = {  # (1)
    "TransformJobName": ...,
}

parent.stop_transform_job(**kwargs)

1. See StopTransformJobRequestTypeDef

update_action

Updates an action.

Type annotations and code completion for boto3.client("sagemaker").update_action method. boto3 documentation

# update_action method definition

def update_action(
    self,
    *,
    ActionName: str,
    Description: str = ...,
    Status: ActionStatusType = ...,  # (1)
    Properties: Mapping[str, str] = ...,
    PropertiesToRemove: Sequence[str] = ...,
) -> UpdateActionResponseTypeDef:  # (2)
    ...

1. See ActionStatusType
2. See UpdateActionResponseTypeDef

# update_action method usage example with argument unpacking

kwargs: UpdateActionRequestTypeDef = {  # (1)
    "ActionName": ...,
}

parent.update_action(**kwargs)

1. See UpdateActionRequestTypeDef

update_app_image_config

Updates the properties of an AppImageConfig.

Type annotations and code completion for boto3.client("sagemaker").update_app_image_config method. boto3 documentation

# update_app_image_config method definition

def update_app_image_config(
    self,
    *,
    AppImageConfigName: str,
    KernelGatewayImageConfig: KernelGatewayImageConfigUnionTypeDef = ...,  # (1)
    JupyterLabAppImageConfig: JupyterLabAppImageConfigUnionTypeDef = ...,  # (2)
    CodeEditorAppImageConfig: CodeEditorAppImageConfigUnionTypeDef = ...,  # (3)
) -> UpdateAppImageConfigResponseTypeDef:  # (4)
    ...

1. See KernelGatewayImageConfigUnionTypeDef
2. See JupyterLabAppImageConfigUnionTypeDef
3. See CodeEditorAppImageConfigUnionTypeDef
4. See UpdateAppImageConfigResponseTypeDef

# update_app_image_config method usage example with argument unpacking

kwargs: UpdateAppImageConfigRequestTypeDef = {  # (1)
    "AppImageConfigName": ...,
}

parent.update_app_image_config(**kwargs)

1. See UpdateAppImageConfigRequestTypeDef

update_artifact

Updates an artifact.

Type annotations and code completion for boto3.client("sagemaker").update_artifact method. boto3 documentation

# update_artifact method definition

def update_artifact(
    self,
    *,
    ArtifactArn: str,
    ArtifactName: str = ...,
    Properties: Mapping[str, str] = ...,
    PropertiesToRemove: Sequence[str] = ...,
) -> UpdateArtifactResponseTypeDef:  # (1)
    ...

1. See UpdateArtifactResponseTypeDef

# update_artifact method usage example with argument unpacking

kwargs: UpdateArtifactRequestTypeDef = {  # (1)
    "ArtifactArn": ...,
}

parent.update_artifact(**kwargs)

1. See UpdateArtifactRequestTypeDef

update_cluster

Updates a SageMaker HyperPod cluster.

Type annotations and code completion for boto3.client("sagemaker").update_cluster method. boto3 documentation

# update_cluster method definition

def update_cluster(
    self,
    *,
    ClusterName: str,
    InstanceGroups: Sequence[ClusterInstanceGroupSpecificationTypeDef] = ...,  # (1)
    NodeRecovery: ClusterNodeRecoveryType = ...,  # (2)
    InstanceGroupsToDelete: Sequence[str] = ...,
) -> UpdateClusterResponseTypeDef:  # (3)
    ...

1. See Sequence[ClusterInstanceGroupSpecificationTypeDef]
2. See ClusterNodeRecoveryType
3. See UpdateClusterResponseTypeDef

# update_cluster method usage example with argument unpacking

kwargs: UpdateClusterRequestTypeDef = {  # (1)
    "ClusterName": ...,
}

parent.update_cluster(**kwargs)

1. See UpdateClusterRequestTypeDef

update_cluster_scheduler_config

Update the cluster policy configuration.

Type annotations and code completion for boto3.client("sagemaker").update_cluster_scheduler_config method. boto3 documentation

# update_cluster_scheduler_config method definition

def update_cluster_scheduler_config(
    self,
    *,
    ClusterSchedulerConfigId: str,
    TargetVersion: int,
    SchedulerConfig: SchedulerConfigUnionTypeDef = ...,  # (1)
    Description: str = ...,
) -> UpdateClusterSchedulerConfigResponseTypeDef:  # (2)
    ...

1. See SchedulerConfigUnionTypeDef
2. See UpdateClusterSchedulerConfigResponseTypeDef

# update_cluster_scheduler_config method usage example with argument unpacking

kwargs: UpdateClusterSchedulerConfigRequestTypeDef = {  # (1)
    "ClusterSchedulerConfigId": ...,
    "TargetVersion": ...,
}

parent.update_cluster_scheduler_config(**kwargs)

1. See UpdateClusterSchedulerConfigRequestTypeDef

update_cluster_software

Updates the platform software of a SageMaker HyperPod cluster for security patching.

Type annotations and code completion for boto3.client("sagemaker").update_cluster_software method. boto3 documentation

# update_cluster_software method definition

def update_cluster_software(
    self,
    *,
    ClusterName: str,
    InstanceGroups: Sequence[UpdateClusterSoftwareInstanceGroupSpecificationTypeDef] = ...,  # (1)
    DeploymentConfig: DeploymentConfigurationUnionTypeDef = ...,  # (2)
) -> UpdateClusterSoftwareResponseTypeDef:  # (3)
    ...

1. See Sequence[UpdateClusterSoftwareInstanceGroupSpecificationTypeDef]
2. See DeploymentConfigurationUnionTypeDef
3. See UpdateClusterSoftwareResponseTypeDef

# update_cluster_software method usage example with argument unpacking

kwargs: UpdateClusterSoftwareRequestTypeDef = {  # (1)
    "ClusterName": ...,
}

parent.update_cluster_software(**kwargs)

1. See UpdateClusterSoftwareRequestTypeDef

update_code_repository

Updates the specified Git repository with the specified values.

Type annotations and code completion for boto3.client("sagemaker").update_code_repository method. boto3 documentation

# update_code_repository method definition

def update_code_repository(
    self,
    *,
    CodeRepositoryName: str,
    GitConfig: GitConfigForUpdateTypeDef = ...,  # (1)
) -> UpdateCodeRepositoryOutputTypeDef:  # (2)
    ...

1. See GitConfigForUpdateTypeDef
2. See UpdateCodeRepositoryOutputTypeDef

# update_code_repository method usage example with argument unpacking

kwargs: UpdateCodeRepositoryInputTypeDef = {  # (1)
    "CodeRepositoryName": ...,
}

parent.update_code_repository(**kwargs)

1. See UpdateCodeRepositoryInputTypeDef

update_compute_quota

Update the compute allocation definition.

Type annotations and code completion for boto3.client("sagemaker").update_compute_quota method. boto3 documentation

# update_compute_quota method definition

def update_compute_quota(
    self,
    *,
    ComputeQuotaId: str,
    TargetVersion: int,
    ComputeQuotaConfig: ComputeQuotaConfigUnionTypeDef = ...,  # (1)
    ComputeQuotaTarget: ComputeQuotaTargetTypeDef = ...,  # (2)
    ActivationState: ActivationStateType = ...,  # (3)
    Description: str = ...,
) -> UpdateComputeQuotaResponseTypeDef:  # (4)
    ...

1. See ComputeQuotaConfigUnionTypeDef
2. See ComputeQuotaTargetTypeDef
3. See ActivationStateType
4. See UpdateComputeQuotaResponseTypeDef

# update_compute_quota method usage example with argument unpacking

kwargs: UpdateComputeQuotaRequestTypeDef = {  # (1)
    "ComputeQuotaId": ...,
    "TargetVersion": ...,
}

parent.update_compute_quota(**kwargs)

1. See UpdateComputeQuotaRequestTypeDef

update_context

Updates a context.

Type annotations and code completion for boto3.client("sagemaker").update_context method. boto3 documentation

# update_context method definition

def update_context(
    self,
    *,
    ContextName: str,
    Description: str = ...,
    Properties: Mapping[str, str] = ...,
    PropertiesToRemove: Sequence[str] = ...,
) -> UpdateContextResponseTypeDef:  # (1)
    ...

1. See UpdateContextResponseTypeDef

# update_context method usage example with argument unpacking

kwargs: UpdateContextRequestTypeDef = {  # (1)
    "ContextName": ...,
}

parent.update_context(**kwargs)

1. See UpdateContextRequestTypeDef

update_device_fleet

Updates a fleet of devices.

Type annotations and code completion for boto3.client("sagemaker").update_device_fleet method. boto3 documentation

# update_device_fleet method definition

def update_device_fleet(
    self,
    *,
    DeviceFleetName: str,
    OutputConfig: EdgeOutputConfigTypeDef,  # (1)
    RoleArn: str = ...,
    Description: str = ...,
    EnableIotRoleAlias: bool = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See EdgeOutputConfigTypeDef
2. See EmptyResponseMetadataTypeDef

# update_device_fleet method usage example with argument unpacking

kwargs: UpdateDeviceFleetRequestTypeDef = {  # (1)
    "DeviceFleetName": ...,
    "OutputConfig": ...,
}

parent.update_device_fleet(**kwargs)

1. See UpdateDeviceFleetRequestTypeDef

update_devices

Updates one or more devices in a fleet.

Type annotations and code completion for boto3.client("sagemaker").update_devices method. boto3 documentation

# update_devices method definition

def update_devices(
    self,
    *,
    DeviceFleetName: str,
    Devices: Sequence[DeviceTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See Sequence[DeviceTypeDef]
2. See EmptyResponseMetadataTypeDef

# update_devices method usage example with argument unpacking

kwargs: UpdateDevicesRequestTypeDef = {  # (1)
    "DeviceFleetName": ...,
    "Devices": ...,
}

parent.update_devices(**kwargs)

1. See UpdateDevicesRequestTypeDef

update_domain

Updates the default settings for new user profiles in the domain.

Type annotations and code completion for boto3.client("sagemaker").update_domain method. boto3 documentation

# update_domain method definition

def update_domain(
    self,
    *,
    DomainId: str,
    DefaultUserSettings: UserSettingsUnionTypeDef = ...,  # (1)
    DomainSettingsForUpdate: DomainSettingsForUpdateTypeDef = ...,  # (2)
    AppSecurityGroupManagement: AppSecurityGroupManagementType = ...,  # (3)
    DefaultSpaceSettings: DefaultSpaceSettingsUnionTypeDef = ...,  # (4)
    SubnetIds: Sequence[str] = ...,
    AppNetworkAccessType: AppNetworkAccessTypeType = ...,  # (5)
    TagPropagation: TagPropagationType = ...,  # (6)
) -> UpdateDomainResponseTypeDef:  # (7)
    ...

1. See UserSettingsUnionTypeDef
2. See DomainSettingsForUpdateTypeDef
3. See AppSecurityGroupManagementType
4. See DefaultSpaceSettingsUnionTypeDef
5. See AppNetworkAccessTypeType
6. See TagPropagationType
7. See UpdateDomainResponseTypeDef

# update_domain method usage example with argument unpacking

kwargs: UpdateDomainRequestTypeDef = {  # (1)
    "DomainId": ...,
}

parent.update_domain(**kwargs)

1. See UpdateDomainRequestTypeDef

update_endpoint

Deploys the EndpointConfig specified in the request to a new fleet of instances.

Type annotations and code completion for boto3.client("sagemaker").update_endpoint method. boto3 documentation

# update_endpoint method definition

def update_endpoint(
    self,
    *,
    EndpointName: str,
    EndpointConfigName: str,
    RetainAllVariantProperties: bool = ...,
    ExcludeRetainedVariantProperties: Sequence[VariantPropertyTypeDef] = ...,  # (1)
    DeploymentConfig: DeploymentConfigUnionTypeDef = ...,  # (2)
    RetainDeploymentConfig: bool = ...,
) -> UpdateEndpointOutputTypeDef:  # (3)
    ...

1. See Sequence[VariantPropertyTypeDef]
2. See DeploymentConfigUnionTypeDef
3. See UpdateEndpointOutputTypeDef

# update_endpoint method usage example with argument unpacking

kwargs: UpdateEndpointInputTypeDef = {  # (1)
    "EndpointName": ...,
    "EndpointConfigName": ...,
}

parent.update_endpoint(**kwargs)

1. See UpdateEndpointInputTypeDef

update_endpoint_weights_and_capacities

Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint.

Type annotations and code completion for boto3.client("sagemaker").update_endpoint_weights_and_capacities method. boto3 documentation

# update_endpoint_weights_and_capacities method definition

def update_endpoint_weights_and_capacities(
    self,
    *,
    EndpointName: str,
    DesiredWeightsAndCapacities: Sequence[DesiredWeightAndCapacityTypeDef],  # (1)
) -> UpdateEndpointWeightsAndCapacitiesOutputTypeDef:  # (2)
    ...

1. See Sequence[DesiredWeightAndCapacityTypeDef]
2. See UpdateEndpointWeightsAndCapacitiesOutputTypeDef

# update_endpoint_weights_and_capacities method usage example with argument unpacking

kwargs: UpdateEndpointWeightsAndCapacitiesInputTypeDef = {  # (1)
    "EndpointName": ...,
    "DesiredWeightsAndCapacities": ...,
}

parent.update_endpoint_weights_and_capacities(**kwargs)

1. See UpdateEndpointWeightsAndCapacitiesInputTypeDef

update_experiment

Adds, updates, or removes the description of an experiment.

Type annotations and code completion for boto3.client("sagemaker").update_experiment method. boto3 documentation

# update_experiment method definition

def update_experiment(
    self,
    *,
    ExperimentName: str,
    DisplayName: str = ...,
    Description: str = ...,
) -> UpdateExperimentResponseTypeDef:  # (1)
    ...

1. See UpdateExperimentResponseTypeDef

# update_experiment method usage example with argument unpacking

kwargs: UpdateExperimentRequestTypeDef = {  # (1)
    "ExperimentName": ...,
}

parent.update_experiment(**kwargs)

1. See UpdateExperimentRequestTypeDef

update_feature_group

Updates the feature group by either adding features or updating the online store configuration.

Type annotations and code completion for boto3.client("sagemaker").update_feature_group method. boto3 documentation

# update_feature_group method definition

def update_feature_group(
    self,
    *,
    FeatureGroupName: str,
    FeatureAdditions: Sequence[FeatureDefinitionTypeDef] = ...,  # (1)
    OnlineStoreConfig: OnlineStoreConfigUpdateTypeDef = ...,  # (2)
    ThroughputConfig: ThroughputConfigUpdateTypeDef = ...,  # (3)
) -> UpdateFeatureGroupResponseTypeDef:  # (4)
    ...

1. See Sequence[FeatureDefinitionTypeDef]
2. See OnlineStoreConfigUpdateTypeDef
3. See ThroughputConfigUpdateTypeDef
4. See UpdateFeatureGroupResponseTypeDef

# update_feature_group method usage example with argument unpacking

kwargs: UpdateFeatureGroupRequestTypeDef = {  # (1)
    "FeatureGroupName": ...,
}

parent.update_feature_group(**kwargs)

1. See UpdateFeatureGroupRequestTypeDef

update_feature_metadata

Updates the description and parameters of the feature group.

Type annotations and code completion for boto3.client("sagemaker").update_feature_metadata method. boto3 documentation

# update_feature_metadata method definition

def update_feature_metadata(
    self,
    *,
    FeatureGroupName: str,
    FeatureName: str,
    Description: str = ...,
    ParameterAdditions: Sequence[FeatureParameterTypeDef] = ...,  # (1)
    ParameterRemovals: Sequence[str] = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See Sequence[FeatureParameterTypeDef]
2. See EmptyResponseMetadataTypeDef

# update_feature_metadata method usage example with argument unpacking

kwargs: UpdateFeatureMetadataRequestTypeDef = {  # (1)
    "FeatureGroupName": ...,
    "FeatureName": ...,
}

parent.update_feature_metadata(**kwargs)

1. See UpdateFeatureMetadataRequestTypeDef

update_hub

Update a hub.

Type annotations and code completion for boto3.client("sagemaker").update_hub method. boto3 documentation

# update_hub method definition

def update_hub(
    self,
    *,
    HubName: str,
    HubDescription: str = ...,
    HubDisplayName: str = ...,
    HubSearchKeywords: Sequence[str] = ...,
) -> UpdateHubResponseTypeDef:  # (1)
    ...

1. See UpdateHubResponseTypeDef

# update_hub method usage example with argument unpacking

kwargs: UpdateHubRequestTypeDef = {  # (1)
    "HubName": ...,
}

parent.update_hub(**kwargs)

1. See UpdateHubRequestTypeDef

update_hub_content

Updates SageMaker hub content (either a Model or Notebook resource).

Type annotations and code completion for boto3.client("sagemaker").update_hub_content method. boto3 documentation

# update_hub_content method definition

def update_hub_content(
    self,
    *,
    HubName: str,
    HubContentName: str,
    HubContentType: HubContentTypeType,  # (1)
    HubContentVersion: str,
    HubContentDisplayName: str = ...,
    HubContentDescription: str = ...,
    HubContentMarkdown: str = ...,
    HubContentSearchKeywords: Sequence[str] = ...,
    SupportStatus: HubContentSupportStatusType = ...,  # (2)
) -> UpdateHubContentResponseTypeDef:  # (3)
    ...

1. See HubContentTypeType
2. See HubContentSupportStatusType
3. See UpdateHubContentResponseTypeDef

# update_hub_content method usage example with argument unpacking

kwargs: UpdateHubContentRequestTypeDef = {  # (1)
    "HubName": ...,
    "HubContentName": ...,
    "HubContentType": ...,
    "HubContentVersion": ...,
}

parent.update_hub_content(**kwargs)

1. See UpdateHubContentRequestTypeDef

update_hub_content_reference

Updates the contents of a SageMaker hub for a ModelReference resource.

Type annotations and code completion for boto3.client("sagemaker").update_hub_content_reference method. boto3 documentation

# update_hub_content_reference method definition

def update_hub_content_reference(
    self,
    *,
    HubName: str,
    HubContentName: str,
    HubContentType: HubContentTypeType,  # (1)
    MinVersion: str = ...,
) -> UpdateHubContentReferenceResponseTypeDef:  # (2)
    ...

1. See HubContentTypeType
2. See UpdateHubContentReferenceResponseTypeDef

# update_hub_content_reference method usage example with argument unpacking

kwargs: UpdateHubContentReferenceRequestTypeDef = {  # (1)
    "HubName": ...,
    "HubContentName": ...,
    "HubContentType": ...,
}

parent.update_hub_content_reference(**kwargs)

1. See UpdateHubContentReferenceRequestTypeDef

update_image

Updates the properties of a SageMaker AI image.

Type annotations and code completion for boto3.client("sagemaker").update_image method. boto3 documentation

# update_image method definition

def update_image(
    self,
    *,
    ImageName: str,
    DeleteProperties: Sequence[str] = ...,
    Description: str = ...,
    DisplayName: str = ...,
    RoleArn: str = ...,
) -> UpdateImageResponseTypeDef:  # (1)
    ...

1. See UpdateImageResponseTypeDef

# update_image method usage example with argument unpacking

kwargs: UpdateImageRequestTypeDef = {  # (1)
    "ImageName": ...,
}

parent.update_image(**kwargs)

1. See UpdateImageRequestTypeDef

update_image_version

Updates the properties of a SageMaker AI image version.

Type annotations and code completion for boto3.client("sagemaker").update_image_version method. boto3 documentation

# update_image_version method definition

def update_image_version(
    self,
    *,
    ImageName: str,
    Alias: str = ...,
    Version: int = ...,
    AliasesToAdd: Sequence[str] = ...,
    AliasesToDelete: Sequence[str] = ...,
    VendorGuidance: VendorGuidanceType = ...,  # (1)
    JobType: JobTypeType = ...,  # (2)
    MLFramework: str = ...,
    ProgrammingLang: str = ...,
    Processor: ProcessorType = ...,  # (3)
    Horovod: bool = ...,
    ReleaseNotes: str = ...,
) -> UpdateImageVersionResponseTypeDef:  # (4)
    ...

1. See VendorGuidanceType
2. See JobTypeType
3. See ProcessorType
4. See UpdateImageVersionResponseTypeDef

# update_image_version method usage example with argument unpacking

kwargs: UpdateImageVersionRequestTypeDef = {  # (1)
    "ImageName": ...,
}

parent.update_image_version(**kwargs)

1. See UpdateImageVersionRequestTypeDef

update_inference_component

Updates an inference component.

Type annotations and code completion for boto3.client("sagemaker").update_inference_component method. boto3 documentation

# update_inference_component method definition

def update_inference_component(
    self,
    *,
    InferenceComponentName: str,
    Specification: InferenceComponentSpecificationTypeDef = ...,  # (1)
    RuntimeConfig: InferenceComponentRuntimeConfigTypeDef = ...,  # (2)
    DeploymentConfig: InferenceComponentDeploymentConfigUnionTypeDef = ...,  # (3)
) -> UpdateInferenceComponentOutputTypeDef:  # (4)
    ...

1. See InferenceComponentSpecificationTypeDef
2. See InferenceComponentRuntimeConfigTypeDef
3. See InferenceComponentDeploymentConfigUnionTypeDef
4. See UpdateInferenceComponentOutputTypeDef

# update_inference_component method usage example with argument unpacking

kwargs: UpdateInferenceComponentInputTypeDef = {  # (1)
    "InferenceComponentName": ...,
}

parent.update_inference_component(**kwargs)

1. See UpdateInferenceComponentInputTypeDef

update_inference_component_runtime_config

Runtime settings for a model that is deployed with an inference component.

Type annotations and code completion for boto3.client("sagemaker").update_inference_component_runtime_config method. boto3 documentation

# update_inference_component_runtime_config method definition

def update_inference_component_runtime_config(
    self,
    *,
    InferenceComponentName: str,
    DesiredRuntimeConfig: InferenceComponentRuntimeConfigTypeDef,  # (1)
) -> UpdateInferenceComponentRuntimeConfigOutputTypeDef:  # (2)
    ...

1. See InferenceComponentRuntimeConfigTypeDef
2. See UpdateInferenceComponentRuntimeConfigOutputTypeDef

# update_inference_component_runtime_config method usage example with argument unpacking

kwargs: UpdateInferenceComponentRuntimeConfigInputTypeDef = {  # (1)
    "InferenceComponentName": ...,
    "DesiredRuntimeConfig": ...,
}

parent.update_inference_component_runtime_config(**kwargs)

1. See UpdateInferenceComponentRuntimeConfigInputTypeDef

update_inference_experiment

Updates an inference experiment that you created.

Type annotations and code completion for boto3.client("sagemaker").update_inference_experiment method. boto3 documentation

# update_inference_experiment method definition

def update_inference_experiment(
    self,
    *,
    Name: str,
    Schedule: InferenceExperimentScheduleUnionTypeDef = ...,  # (1)
    Description: str = ...,
    ModelVariants: Sequence[ModelVariantConfigTypeDef] = ...,  # (2)
    DataStorageConfig: InferenceExperimentDataStorageConfigUnionTypeDef = ...,  # (3)
    ShadowModeConfig: ShadowModeConfigUnionTypeDef = ...,  # (4)
) -> UpdateInferenceExperimentResponseTypeDef:  # (5)
    ...

1. See InferenceExperimentScheduleUnionTypeDef
2. See Sequence[ModelVariantConfigTypeDef]
3. See InferenceExperimentDataStorageConfigUnionTypeDef
4. See ShadowModeConfigUnionTypeDef
5. See UpdateInferenceExperimentResponseTypeDef

# update_inference_experiment method usage example with argument unpacking

kwargs: UpdateInferenceExperimentRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.update_inference_experiment(**kwargs)

1. See UpdateInferenceExperimentRequestTypeDef

update_mlflow_tracking_server

Updates properties of an existing MLflow Tracking Server.

Type annotations and code completion for boto3.client("sagemaker").update_mlflow_tracking_server method. boto3 documentation

# update_mlflow_tracking_server method definition

def update_mlflow_tracking_server(
    self,
    *,
    TrackingServerName: str,
    ArtifactStoreUri: str = ...,
    TrackingServerSize: TrackingServerSizeType = ...,  # (1)
    AutomaticModelRegistration: bool = ...,
    WeeklyMaintenanceWindowStart: str = ...,
) -> UpdateMlflowTrackingServerResponseTypeDef:  # (2)
    ...

1. See TrackingServerSizeType
2. See UpdateMlflowTrackingServerResponseTypeDef

# update_mlflow_tracking_server method usage example with argument unpacking

kwargs: UpdateMlflowTrackingServerRequestTypeDef = {  # (1)
    "TrackingServerName": ...,
}

parent.update_mlflow_tracking_server(**kwargs)

1. See UpdateMlflowTrackingServerRequestTypeDef

update_model_card

Update an Amazon SageMaker Model Card.

Type annotations and code completion for boto3.client("sagemaker").update_model_card method. boto3 documentation

# update_model_card method definition

def update_model_card(
    self,
    *,
    ModelCardName: str,
    Content: str = ...,
    ModelCardStatus: ModelCardStatusType = ...,  # (1)
) -> UpdateModelCardResponseTypeDef:  # (2)
    ...

1. See ModelCardStatusType
2. See UpdateModelCardResponseTypeDef

# update_model_card method usage example with argument unpacking

kwargs: UpdateModelCardRequestTypeDef = {  # (1)
    "ModelCardName": ...,
}

parent.update_model_card(**kwargs)

1. See UpdateModelCardRequestTypeDef

update_model_package

Updates a versioned model.

Type annotations and code completion for boto3.client("sagemaker").update_model_package method. boto3 documentation

# update_model_package method definition

def update_model_package(
    self,
    *,
    ModelPackageArn: str,
    ModelApprovalStatus: ModelApprovalStatusType = ...,  # (1)
    ApprovalDescription: str = ...,
    CustomerMetadataProperties: Mapping[str, str] = ...,
    CustomerMetadataPropertiesToRemove: Sequence[str] = ...,
    AdditionalInferenceSpecificationsToAdd: Sequence[AdditionalInferenceSpecificationDefinitionUnionTypeDef] = ...,  # (2)
    InferenceSpecification: InferenceSpecificationUnionTypeDef = ...,  # (3)
    SourceUri: str = ...,
    ModelCard: ModelPackageModelCardTypeDef = ...,  # (4)
    ModelLifeCycle: ModelLifeCycleTypeDef = ...,  # (5)
    ClientToken: str = ...,
) -> UpdateModelPackageOutputTypeDef:  # (6)
    ...

1. See ModelApprovalStatusType
2. See Sequence[AdditionalInferenceSpecificationDefinitionUnionTypeDef]
3. See InferenceSpecificationUnionTypeDef
4. See ModelPackageModelCardTypeDef
5. See ModelLifeCycleTypeDef
6. See UpdateModelPackageOutputTypeDef

# update_model_package method usage example with argument unpacking

kwargs: UpdateModelPackageInputTypeDef = {  # (1)
    "ModelPackageArn": ...,
}

parent.update_model_package(**kwargs)

1. See UpdateModelPackageInputTypeDef

update_monitoring_alert

Update the parameters of a model monitor alert.

Type annotations and code completion for boto3.client("sagemaker").update_monitoring_alert method. boto3 documentation

# update_monitoring_alert method definition

def update_monitoring_alert(
    self,
    *,
    MonitoringScheduleName: str,
    MonitoringAlertName: str,
    DatapointsToAlert: int,
    EvaluationPeriod: int,
) -> UpdateMonitoringAlertResponseTypeDef:  # (1)
    ...

1. See UpdateMonitoringAlertResponseTypeDef

# update_monitoring_alert method usage example with argument unpacking

kwargs: UpdateMonitoringAlertRequestTypeDef = {  # (1)
    "MonitoringScheduleName": ...,
    "MonitoringAlertName": ...,
    "DatapointsToAlert": ...,
    "EvaluationPeriod": ...,
}

parent.update_monitoring_alert(**kwargs)

1. See UpdateMonitoringAlertRequestTypeDef

update_monitoring_schedule

Updates a previously created schedule.

Type annotations and code completion for boto3.client("sagemaker").update_monitoring_schedule method. boto3 documentation

# update_monitoring_schedule method definition

def update_monitoring_schedule(
    self,
    *,
    MonitoringScheduleName: str,
    MonitoringScheduleConfig: MonitoringScheduleConfigUnionTypeDef,  # (1)
) -> UpdateMonitoringScheduleResponseTypeDef:  # (2)
    ...

1. See MonitoringScheduleConfigUnionTypeDef
2. See UpdateMonitoringScheduleResponseTypeDef

# update_monitoring_schedule method usage example with argument unpacking

kwargs: UpdateMonitoringScheduleRequestTypeDef = {  # (1)
    "MonitoringScheduleName": ...,
    "MonitoringScheduleConfig": ...,
}

parent.update_monitoring_schedule(**kwargs)

1. See UpdateMonitoringScheduleRequestTypeDef

update_notebook_instance

Updates a notebook instance.

Type annotations and code completion for boto3.client("sagemaker").update_notebook_instance method. boto3 documentation

# update_notebook_instance method definition

def update_notebook_instance(
    self,
    *,
    NotebookInstanceName: str,
    InstanceType: InstanceTypeType = ...,  # (1)
    RoleArn: str = ...,
    LifecycleConfigName: str = ...,
    DisassociateLifecycleConfig: bool = ...,
    VolumeSizeInGB: int = ...,
    DefaultCodeRepository: str = ...,
    AdditionalCodeRepositories: Sequence[str] = ...,
    AcceleratorTypes: Sequence[NotebookInstanceAcceleratorTypeType] = ...,  # (2)
    DisassociateAcceleratorTypes: bool = ...,
    DisassociateDefaultCodeRepository: bool = ...,
    DisassociateAdditionalCodeRepositories: bool = ...,
    RootAccess: RootAccessType = ...,  # (3)
    InstanceMetadataServiceConfiguration: InstanceMetadataServiceConfigurationTypeDef = ...,  # (4)
) -> Dict[str, Any]:
    ...

1. See InstanceTypeType
2. See Sequence[NotebookInstanceAcceleratorTypeType]
3. See RootAccessType
4. See InstanceMetadataServiceConfigurationTypeDef

# update_notebook_instance method usage example with argument unpacking

kwargs: UpdateNotebookInstanceInputTypeDef = {  # (1)
    "NotebookInstanceName": ...,
}

parent.update_notebook_instance(**kwargs)

1. See UpdateNotebookInstanceInputTypeDef

update_notebook_instance_lifecycle_config

Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.

Type annotations and code completion for boto3.client("sagemaker").update_notebook_instance_lifecycle_config method. boto3 documentation

# update_notebook_instance_lifecycle_config method definition

def update_notebook_instance_lifecycle_config(
    self,
    *,
    NotebookInstanceLifecycleConfigName: str,
    OnCreate: Sequence[NotebookInstanceLifecycleHookTypeDef] = ...,  # (1)
    OnStart: Sequence[NotebookInstanceLifecycleHookTypeDef] = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See Sequence[NotebookInstanceLifecycleHookTypeDef]
2. See Sequence[NotebookInstanceLifecycleHookTypeDef]

# update_notebook_instance_lifecycle_config method usage example with argument unpacking

kwargs: UpdateNotebookInstanceLifecycleConfigInputTypeDef = {  # (1)
    "NotebookInstanceLifecycleConfigName": ...,
}

parent.update_notebook_instance_lifecycle_config(**kwargs)

1. See UpdateNotebookInstanceLifecycleConfigInputTypeDef

update_partner_app

Updates all of the SageMaker Partner AI Apps in an account.

Type annotations and code completion for boto3.client("sagemaker").update_partner_app method. boto3 documentation

# update_partner_app method definition

def update_partner_app(
    self,
    *,
    Arn: str,
    MaintenanceConfig: PartnerAppMaintenanceConfigTypeDef = ...,  # (1)
    Tier: str = ...,
    ApplicationConfig: PartnerAppConfigUnionTypeDef = ...,  # (2)
    EnableIamSessionBasedIdentity: bool = ...,
    ClientToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> UpdatePartnerAppResponseTypeDef:  # (4)
    ...

1. See PartnerAppMaintenanceConfigTypeDef
2. See PartnerAppConfigUnionTypeDef
3. See Sequence[TagTypeDef]
4. See UpdatePartnerAppResponseTypeDef

# update_partner_app method usage example with argument unpacking

kwargs: UpdatePartnerAppRequestTypeDef = {  # (1)
    "Arn": ...,
}

parent.update_partner_app(**kwargs)

1. See UpdatePartnerAppRequestTypeDef

update_pipeline

Updates a pipeline.

Type annotations and code completion for boto3.client("sagemaker").update_pipeline method. boto3 documentation

# update_pipeline method definition

def update_pipeline(
    self,
    *,
    PipelineName: str,
    PipelineDisplayName: str = ...,
    PipelineDefinition: str = ...,
    PipelineDefinitionS3Location: PipelineDefinitionS3LocationTypeDef = ...,  # (1)
    PipelineDescription: str = ...,
    RoleArn: str = ...,
    ParallelismConfiguration: ParallelismConfigurationTypeDef = ...,  # (2)
) -> UpdatePipelineResponseTypeDef:  # (3)
    ...

1. See PipelineDefinitionS3LocationTypeDef
2. See ParallelismConfigurationTypeDef
3. See UpdatePipelineResponseTypeDef

# update_pipeline method usage example with argument unpacking

kwargs: UpdatePipelineRequestTypeDef = {  # (1)
    "PipelineName": ...,
}

parent.update_pipeline(**kwargs)

1. See UpdatePipelineRequestTypeDef

update_pipeline_execution

Updates a pipeline execution.

Type annotations and code completion for boto3.client("sagemaker").update_pipeline_execution method. boto3 documentation

# update_pipeline_execution method definition

def update_pipeline_execution(
    self,
    *,
    PipelineExecutionArn: str,
    PipelineExecutionDescription: str = ...,
    PipelineExecutionDisplayName: str = ...,
    ParallelismConfiguration: ParallelismConfigurationTypeDef = ...,  # (1)
) -> UpdatePipelineExecutionResponseTypeDef:  # (2)
    ...

1. See ParallelismConfigurationTypeDef
2. See UpdatePipelineExecutionResponseTypeDef

# update_pipeline_execution method usage example with argument unpacking

kwargs: UpdatePipelineExecutionRequestTypeDef = {  # (1)
    "PipelineExecutionArn": ...,
}

parent.update_pipeline_execution(**kwargs)

1. See UpdatePipelineExecutionRequestTypeDef

update_project

Updates a machine learning (ML) project that is created from a template that sets up an ML pipeline from training to deploying an approved model.

Type annotations and code completion for boto3.client("sagemaker").update_project method. boto3 documentation

# update_project method definition

def update_project(
    self,
    *,
    ProjectName: str,
    ProjectDescription: str = ...,
    ServiceCatalogProvisioningUpdateDetails: ServiceCatalogProvisioningUpdateDetailsTypeDef = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    TemplateProvidersToUpdate: Sequence[UpdateTemplateProviderTypeDef] = ...,  # (3)
) -> UpdateProjectOutputTypeDef:  # (4)
    ...

1. See ServiceCatalogProvisioningUpdateDetailsTypeDef
2. See Sequence[TagTypeDef]
3. See Sequence[UpdateTemplateProviderTypeDef]
4. See UpdateProjectOutputTypeDef

# update_project method usage example with argument unpacking

kwargs: UpdateProjectInputTypeDef = {  # (1)
    "ProjectName": ...,
}

parent.update_project(**kwargs)

1. See UpdateProjectInputTypeDef

update_space

Updates the settings of a space.

Type annotations and code completion for boto3.client("sagemaker").update_space method. boto3 documentation

# update_space method definition

def update_space(
    self,
    *,
    DomainId: str,
    SpaceName: str,
    SpaceSettings: SpaceSettingsUnionTypeDef = ...,  # (1)
    SpaceDisplayName: str = ...,
) -> UpdateSpaceResponseTypeDef:  # (2)
    ...

1. See SpaceSettingsUnionTypeDef
2. See UpdateSpaceResponseTypeDef

# update_space method usage example with argument unpacking

kwargs: UpdateSpaceRequestTypeDef = {  # (1)
    "DomainId": ...,
    "SpaceName": ...,
}

parent.update_space(**kwargs)

1. See UpdateSpaceRequestTypeDef

update_training_job

Update a model training job to request a new Debugger profiling configuration or to change warm pool retention length.

Type annotations and code completion for boto3.client("sagemaker").update_training_job method. boto3 documentation

# update_training_job method definition

def update_training_job(
    self,
    *,
    TrainingJobName: str,
    ProfilerConfig: ProfilerConfigForUpdateTypeDef = ...,  # (1)
    ProfilerRuleConfigurations: Sequence[ProfilerRuleConfigurationUnionTypeDef] = ...,  # (2)
    ResourceConfig: ResourceConfigForUpdateTypeDef = ...,  # (3)
    RemoteDebugConfig: RemoteDebugConfigForUpdateTypeDef = ...,  # (4)
) -> UpdateTrainingJobResponseTypeDef:  # (5)
    ...

1. See ProfilerConfigForUpdateTypeDef
2. See Sequence[ProfilerRuleConfigurationUnionTypeDef]
3. See ResourceConfigForUpdateTypeDef
4. See RemoteDebugConfigForUpdateTypeDef
5. See UpdateTrainingJobResponseTypeDef

# update_training_job method usage example with argument unpacking

kwargs: UpdateTrainingJobRequestTypeDef = {  # (1)
    "TrainingJobName": ...,
}

parent.update_training_job(**kwargs)

1. See UpdateTrainingJobRequestTypeDef

update_trial

Updates the display name of a trial.

Type annotations and code completion for boto3.client("sagemaker").update_trial method. boto3 documentation

# update_trial method definition

def update_trial(
    self,
    *,
    TrialName: str,
    DisplayName: str = ...,
) -> UpdateTrialResponseTypeDef:  # (1)
    ...

1. See UpdateTrialResponseTypeDef

# update_trial method usage example with argument unpacking

kwargs: UpdateTrialRequestTypeDef = {  # (1)
    "TrialName": ...,
}

parent.update_trial(**kwargs)

1. See UpdateTrialRequestTypeDef

update_trial_component

Updates one or more properties of a trial component.

Type annotations and code completion for boto3.client("sagemaker").update_trial_component method. boto3 documentation

# update_trial_component method definition

def update_trial_component(
    self,
    *,
    TrialComponentName: str,
    DisplayName: str = ...,
    Status: TrialComponentStatusTypeDef = ...,  # (1)
    StartTime: TimestampTypeDef = ...,
    EndTime: TimestampTypeDef = ...,
    Parameters: Mapping[str, TrialComponentParameterValueTypeDef] = ...,  # (2)
    ParametersToRemove: Sequence[str] = ...,
    InputArtifacts: Mapping[str, TrialComponentArtifactTypeDef] = ...,  # (3)
    InputArtifactsToRemove: Sequence[str] = ...,
    OutputArtifacts: Mapping[str, TrialComponentArtifactTypeDef] = ...,  # (3)
    OutputArtifactsToRemove: Sequence[str] = ...,
) -> UpdateTrialComponentResponseTypeDef:  # (5)
    ...

1. See TrialComponentStatusTypeDef
2. See Mapping[str, TrialComponentParameterValueTypeDef]
3. See Mapping[str, TrialComponentArtifactTypeDef]
4. See Mapping[str, TrialComponentArtifactTypeDef]
5. See UpdateTrialComponentResponseTypeDef

# update_trial_component method usage example with argument unpacking

kwargs: UpdateTrialComponentRequestTypeDef = {  # (1)
    "TrialComponentName": ...,
}

parent.update_trial_component(**kwargs)

1. See UpdateTrialComponentRequestTypeDef

update_user_profile

Updates a user profile.

Type annotations and code completion for boto3.client("sagemaker").update_user_profile method. boto3 documentation

# update_user_profile method definition

def update_user_profile(
    self,
    *,
    DomainId: str,
    UserProfileName: str,
    UserSettings: UserSettingsUnionTypeDef = ...,  # (1)
) -> UpdateUserProfileResponseTypeDef:  # (2)
    ...

1. See UserSettingsUnionTypeDef
2. See UpdateUserProfileResponseTypeDef

# update_user_profile method usage example with argument unpacking

kwargs: UpdateUserProfileRequestTypeDef = {  # (1)
    "DomainId": ...,
    "UserProfileName": ...,
}

parent.update_user_profile(**kwargs)

1. See UpdateUserProfileRequestTypeDef

update_workforce

Use this operation to update your workforce.

Type annotations and code completion for boto3.client("sagemaker").update_workforce method. boto3 documentation

# update_workforce method definition

def update_workforce(
    self,
    *,
    WorkforceName: str,
    SourceIpConfig: SourceIpConfigUnionTypeDef = ...,  # (1)
    OidcConfig: OidcConfigTypeDef = ...,  # (2)
    WorkforceVpcConfig: WorkforceVpcConfigRequestTypeDef = ...,  # (3)
) -> UpdateWorkforceResponseTypeDef:  # (4)
    ...

1. See SourceIpConfigUnionTypeDef
2. See OidcConfigTypeDef
3. See WorkforceVpcConfigRequestTypeDef
4. See UpdateWorkforceResponseTypeDef

# update_workforce method usage example with argument unpacking

kwargs: UpdateWorkforceRequestTypeDef = {  # (1)
    "WorkforceName": ...,
}

parent.update_workforce(**kwargs)

1. See UpdateWorkforceRequestTypeDef

update_workteam

Updates an existing work team with new member definitions or description.

Type annotations and code completion for boto3.client("sagemaker").update_workteam method. boto3 documentation

# update_workteam method definition

def update_workteam(
    self,
    *,
    WorkteamName: str,
    MemberDefinitions: Sequence[MemberDefinitionUnionTypeDef] = ...,  # (1)
    Description: str = ...,
    NotificationConfiguration: NotificationConfigurationTypeDef = ...,  # (2)
    WorkerAccessConfiguration: WorkerAccessConfigurationTypeDef = ...,  # (3)
) -> UpdateWorkteamResponseTypeDef:  # (4)
    ...

1. See Sequence[MemberDefinitionUnionTypeDef]
2. See NotificationConfigurationTypeDef
3. See WorkerAccessConfigurationTypeDef
4. See UpdateWorkteamResponseTypeDef

# update_workteam method usage example with argument unpacking

kwargs: UpdateWorkteamRequestTypeDef = {  # (1)
    "WorkteamName": ...,
}

parent.update_workteam(**kwargs)

1. See UpdateWorkteamRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("sagemaker").get_paginator method with overloads.

• client.get_paginator("create_hub_content_presigned_urls") -> CreateHubContentPresignedUrlsPaginator
• client.get_paginator("list_actions") -> ListActionsPaginator
• client.get_paginator("list_algorithms") -> ListAlgorithmsPaginator
• client.get_paginator("list_aliases") -> ListAliasesPaginator
• client.get_paginator("list_app_image_configs") -> ListAppImageConfigsPaginator
• client.get_paginator("list_apps") -> ListAppsPaginator
• client.get_paginator("list_artifacts") -> ListArtifactsPaginator
• client.get_paginator("list_associations") -> ListAssociationsPaginator
• client.get_paginator("list_auto_ml_jobs") -> ListAutoMLJobsPaginator
• client.get_paginator("list_candidates_for_auto_ml_job") -> ListCandidatesForAutoMLJobPaginator
• client.get_paginator("list_cluster_nodes") -> ListClusterNodesPaginator
• client.get_paginator("list_cluster_scheduler_configs") -> ListClusterSchedulerConfigsPaginator
• client.get_paginator("list_clusters") -> ListClustersPaginator
• client.get_paginator("list_code_repositories") -> ListCodeRepositoriesPaginator
• client.get_paginator("list_compilation_jobs") -> ListCompilationJobsPaginator
• client.get_paginator("list_compute_quotas") -> ListComputeQuotasPaginator
• client.get_paginator("list_contexts") -> ListContextsPaginator
• client.get_paginator("list_data_quality_job_definitions") -> ListDataQualityJobDefinitionsPaginator
• client.get_paginator("list_device_fleets") -> ListDeviceFleetsPaginator
• client.get_paginator("list_devices") -> ListDevicesPaginator
• client.get_paginator("list_domains") -> ListDomainsPaginator
• client.get_paginator("list_edge_deployment_plans") -> ListEdgeDeploymentPlansPaginator
• client.get_paginator("list_edge_packaging_jobs") -> ListEdgePackagingJobsPaginator
• client.get_paginator("list_endpoint_configs") -> ListEndpointConfigsPaginator
• client.get_paginator("list_endpoints") -> ListEndpointsPaginator
• client.get_paginator("list_experiments") -> ListExperimentsPaginator
• client.get_paginator("list_feature_groups") -> ListFeatureGroupsPaginator
• client.get_paginator("list_flow_definitions") -> ListFlowDefinitionsPaginator
• client.get_paginator("list_human_task_uis") -> ListHumanTaskUisPaginator
• client.get_paginator("list_hyper_parameter_tuning_jobs") -> ListHyperParameterTuningJobsPaginator
• client.get_paginator("list_image_versions") -> ListImageVersionsPaginator
• client.get_paginator("list_images") -> ListImagesPaginator
• client.get_paginator("list_inference_components") -> ListInferenceComponentsPaginator
• client.get_paginator("list_inference_experiments") -> ListInferenceExperimentsPaginator
• client.get_paginator("list_inference_recommendations_job_steps") -> ListInferenceRecommendationsJobStepsPaginator
• client.get_paginator("list_inference_recommendations_jobs") -> ListInferenceRecommendationsJobsPaginator
• client.get_paginator("list_labeling_jobs_for_workteam") -> ListLabelingJobsForWorkteamPaginator
• client.get_paginator("list_labeling_jobs") -> ListLabelingJobsPaginator
• client.get_paginator("list_lineage_groups") -> ListLineageGroupsPaginator
• client.get_paginator("list_mlflow_tracking_servers") -> ListMlflowTrackingServersPaginator
• client.get_paginator("list_model_bias_job_definitions") -> ListModelBiasJobDefinitionsPaginator
• client.get_paginator("list_model_card_export_jobs") -> ListModelCardExportJobsPaginator
• client.get_paginator("list_model_card_versions") -> ListModelCardVersionsPaginator
• client.get_paginator("list_model_cards") -> ListModelCardsPaginator
• client.get_paginator("list_model_explainability_job_definitions") -> ListModelExplainabilityJobDefinitionsPaginator
• client.get_paginator("list_model_metadata") -> ListModelMetadataPaginator
• client.get_paginator("list_model_package_groups") -> ListModelPackageGroupsPaginator
• client.get_paginator("list_model_packages") -> ListModelPackagesPaginator
• client.get_paginator("list_model_quality_job_definitions") -> ListModelQualityJobDefinitionsPaginator
• client.get_paginator("list_models") -> ListModelsPaginator
• client.get_paginator("list_monitoring_alert_history") -> ListMonitoringAlertHistoryPaginator
• client.get_paginator("list_monitoring_alerts") -> ListMonitoringAlertsPaginator
• client.get_paginator("list_monitoring_executions") -> ListMonitoringExecutionsPaginator
• client.get_paginator("list_monitoring_schedules") -> ListMonitoringSchedulesPaginator
• client.get_paginator("list_notebook_instance_lifecycle_configs") -> ListNotebookInstanceLifecycleConfigsPaginator
• client.get_paginator("list_notebook_instances") -> ListNotebookInstancesPaginator
• client.get_paginator("list_optimization_jobs") -> ListOptimizationJobsPaginator
• client.get_paginator("list_partner_apps") -> ListPartnerAppsPaginator
• client.get_paginator("list_pipeline_execution_steps") -> ListPipelineExecutionStepsPaginator
• client.get_paginator("list_pipeline_executions") -> ListPipelineExecutionsPaginator
• client.get_paginator("list_pipeline_parameters_for_execution") -> ListPipelineParametersForExecutionPaginator
• client.get_paginator("list_pipelines") -> ListPipelinesPaginator
• client.get_paginator("list_processing_jobs") -> ListProcessingJobsPaginator
• client.get_paginator("list_resource_catalogs") -> ListResourceCatalogsPaginator
• client.get_paginator("list_spaces") -> ListSpacesPaginator
• client.get_paginator("list_stage_devices") -> ListStageDevicesPaginator
• client.get_paginator("list_studio_lifecycle_configs") -> ListStudioLifecycleConfigsPaginator
• client.get_paginator("list_subscribed_workteams") -> ListSubscribedWorkteamsPaginator
• client.get_paginator("list_tags") -> ListTagsPaginator
• client.get_paginator("list_training_jobs_for_hyper_parameter_tuning_job") -> ListTrainingJobsForHyperParameterTuningJobPaginator
• client.get_paginator("list_training_jobs") -> ListTrainingJobsPaginator
• client.get_paginator("list_training_plans") -> ListTrainingPlansPaginator
• client.get_paginator("list_transform_jobs") -> ListTransformJobsPaginator
• client.get_paginator("list_trial_components") -> ListTrialComponentsPaginator
• client.get_paginator("list_trials") -> ListTrialsPaginator
• client.get_paginator("list_user_profiles") -> ListUserProfilesPaginator
• client.get_paginator("list_workforces") -> ListWorkforcesPaginator
• client.get_paginator("list_workteams") -> ListWorkteamsPaginator
• client.get_paginator("search") -> SearchPaginator

get_waiter

Type annotations and code completion for boto3.client("sagemaker").get_waiter method with overloads.

• client.get_waiter("endpoint_deleted") -> EndpointDeletedWaiter
• client.get_waiter("endpoint_in_service") -> EndpointInServiceWaiter
• client.get_waiter("image_created") -> ImageCreatedWaiter
• client.get_waiter("image_deleted") -> ImageDeletedWaiter
• client.get_waiter("image_updated") -> ImageUpdatedWaiter
• client.get_waiter("image_version_created") -> ImageVersionCreatedWaiter
• client.get_waiter("image_version_deleted") -> ImageVersionDeletedWaiter
• client.get_waiter("notebook_instance_deleted") -> NotebookInstanceDeletedWaiter
• client.get_waiter("notebook_instance_in_service") -> NotebookInstanceInServiceWaiter
• client.get_waiter("notebook_instance_stopped") -> NotebookInstanceStoppedWaiter
• client.get_waiter("processing_job_completed_or_stopped") -> ProcessingJobCompletedOrStoppedWaiter
• client.get_waiter("training_job_completed_or_stopped") -> TrainingJobCompletedOrStoppedWaiter
• client.get_waiter("transform_job_completed_or_stopped") -> TransformJobCompletedOrStoppedWaiter