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#

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

See AssociationEdgeTypeType
See AddAssociationResponseTypeDef

# add_association method usage example with argument unpacking

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

parent.add_association(**kwargs)

See AddAssociationRequestRequestTypeDef

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

See TagTypeDef
See AddTagsOutputTypeDef

# add_tags method usage example with argument unpacking

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

parent.add_tags(**kwargs)

See AddTagsInputRequestTypeDef

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

See AssociateTrialComponentResponseTypeDef

# associate_trial_component method usage example with argument unpacking

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

parent.associate_trial_component(**kwargs)

See AssociateTrialComponentRequestRequestTypeDef

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

See BatchDeleteClusterNodesResponseTypeDef

# batch_delete_cluster_nodes method usage example with argument unpacking

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

parent.batch_delete_cluster_nodes(**kwargs)

See BatchDeleteClusterNodesRequestRequestTypeDef

batch_describe_model_package#

This action batch describes a list of versioned model packages See also: AWS API Documentation.

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

# batch_describe_model_package method definition

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

See BatchDescribeModelPackageOutputTypeDef

# batch_describe_model_package method usage example with argument unpacking

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

parent.batch_describe_model_package(**kwargs)

See BatchDescribeModelPackageInputRequestTypeDef

can_paginate#

Check if an operation can be paginated.

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

close#

Closes underlying endpoint connections.

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

# close method definition

def close(
    self,
) -> None:
    ...

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

# create_action method usage example with argument unpacking

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

parent.create_action(**kwargs)

See CreateActionRequestRequestTypeDef

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: TrainingSpecificationTypeDef,  # (1)
    AlgorithmDescription: str = ...,
    InferenceSpecification: InferenceSpecificationTypeDef = ...,  # (2)
    ValidationSpecification: AlgorithmValidationSpecificationTypeDef = ...,  # (3)
    CertifyForMarketplace: bool = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (4)
) -> CreateAlgorithmOutputTypeDef:  # (5)
    ...

See TrainingSpecificationTypeDef
See InferenceSpecificationTypeDef
See AlgorithmValidationSpecificationTypeDef
See TagTypeDef
See CreateAlgorithmOutputTypeDef

# create_algorithm method usage example with argument unpacking

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

parent.create_algorithm(**kwargs)

See CreateAlgorithmInputRequestTypeDef

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)
) -> CreateAppResponseTypeDef:  # (4)
    ...

# create_app method usage example with argument unpacking

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

parent.create_app(**kwargs)

See CreateAppRequestRequestTypeDef

create_app_image_config#

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

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

# create_app_image_config method definition

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

# create_app_image_config method usage example with argument unpacking

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

parent.create_app_image_config(**kwargs)

See CreateAppImageConfigRequestRequestTypeDef

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: ArtifactSourceTypeDef,  # (1)
    ArtifactType: str,
    ArtifactName: str = ...,
    Properties: Mapping[str, str] = ...,
    MetadataProperties: MetadataPropertiesTypeDef = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateArtifactResponseTypeDef:  # (4)
    ...

# create_artifact method usage example with argument unpacking

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

parent.create_artifact(**kwargs)

See CreateArtifactRequestRequestTypeDef

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: AutoMLJobConfigTypeDef = ...,  # (5)
    GenerateCandidateDefinitionsOnly: bool = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (6)
    ModelDeployConfig: ModelDeployConfigTypeDef = ...,  # (7)
) -> CreateAutoMLJobResponseTypeDef:  # (8)
    ...

# create_auto_ml_job method usage example with argument unpacking

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

parent.create_auto_ml_job(**kwargs)

See CreateAutoMLJobRequestRequestTypeDef

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: AutoMLProblemTypeConfigTypeDef,  # (3)
    RoleArn: str,
    Tags: Sequence[TagTypeDef] = ...,  # (4)
    SecurityConfig: AutoMLSecurityConfigTypeDef = ...,  # (5)
    AutoMLJobObjective: AutoMLJobObjectiveTypeDef = ...,  # (6)
    ModelDeployConfig: ModelDeployConfigTypeDef = ...,  # (7)
    DataSplitConfig: AutoMLDataSplitConfigTypeDef = ...,  # (8)
    AutoMLComputeConfig: AutoMLComputeConfigTypeDef = ...,  # (9)
) -> CreateAutoMLJobV2ResponseTypeDef:  # (10)
    ...

# create_auto_ml_job_v2 method usage example with argument unpacking

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

parent.create_auto_ml_job_v2(**kwargs)

See CreateAutoMLJobV2RequestRequestTypeDef

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: VpcConfigTypeDef = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
    Orchestrator: ClusterOrchestratorTypeDef = ...,  # (4)
    NodeRecovery: ClusterNodeRecoveryType = ...,  # (5)
) -> CreateClusterResponseTypeDef:  # (6)
    ...

See ClusterInstanceGroupSpecificationTypeDef
See VpcConfigTypeDef
See TagTypeDef
See ClusterOrchestratorTypeDef
See ClusterNodeRecoveryType
See CreateClusterResponseTypeDef

# create_cluster method usage example with argument unpacking

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

parent.create_cluster(**kwargs)

See CreateClusterRequestRequestTypeDef

create_code_repository#

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

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

# create_code_repository method definition

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

# create_code_repository method usage example with argument unpacking

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

parent.create_code_repository(**kwargs)

See CreateCodeRepositoryInputRequestTypeDef

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: NeoVpcConfigTypeDef = ...,  # (4)
    Tags: Sequence[TagTypeDef] = ...,  # (5)
) -> CreateCompilationJobResponseTypeDef:  # (6)
    ...

# create_compilation_job method usage example with argument unpacking

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

parent.create_compilation_job(**kwargs)

See CreateCompilationJobRequestRequestTypeDef

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

# create_context method usage example with argument unpacking

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

parent.create_context(**kwargs)

See CreateContextRequestRequestTypeDef

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: DataQualityAppSpecificationTypeDef,  # (1)
    DataQualityJobInput: DataQualityJobInputTypeDef,  # (2)
    DataQualityJobOutputConfig: MonitoringOutputConfigTypeDef,  # (3)
    JobResources: MonitoringResourcesTypeDef,  # (4)
    RoleArn: str,
    DataQualityBaselineConfig: DataQualityBaselineConfigTypeDef = ...,  # (5)
    NetworkConfig: MonitoringNetworkConfigTypeDef = ...,  # (6)
    StoppingCondition: MonitoringStoppingConditionTypeDef = ...,  # (7)
    Tags: Sequence[TagTypeDef] = ...,  # (8)
) -> CreateDataQualityJobDefinitionResponseTypeDef:  # (9)
    ...

See DataQualityAppSpecificationTypeDef
See DataQualityJobInputTypeDef
See MonitoringOutputConfigTypeDef
See MonitoringResourcesTypeDef
See DataQualityBaselineConfigTypeDef
See MonitoringNetworkConfigTypeDef
See MonitoringStoppingConditionTypeDef
See TagTypeDef
See CreateDataQualityJobDefinitionResponseTypeDef

# create_data_quality_job_definition method usage example with argument unpacking

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

parent.create_data_quality_job_definition(**kwargs)

See CreateDataQualityJobDefinitionRequestRequestTypeDef

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

# create_device_fleet method usage example with argument unpacking

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

parent.create_device_fleet(**kwargs)

See CreateDeviceFleetRequestRequestTypeDef

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: UserSettingsTypeDef,  # (2)
    SubnetIds: Sequence[str],
    VpcId: str,
    DomainSettings: DomainSettingsTypeDef = ...,  # (3)
    Tags: Sequence[TagTypeDef] = ...,  # (4)
    AppNetworkAccessType: AppNetworkAccessTypeType = ...,  # (5)
    HomeEfsFileSystemKmsKeyId: str = ...,
    KmsKeyId: str = ...,
    AppSecurityGroupManagement: AppSecurityGroupManagementType = ...,  # (6)
    TagPropagation: TagPropagationType = ...,  # (7)
    DefaultSpaceSettings: DefaultSpaceSettingsTypeDef = ...,  # (8)
) -> CreateDomainResponseTypeDef:  # (9)
    ...

# create_domain method usage example with argument unpacking

kwargs: CreateDomainRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "AuthMode": ...,
    "DefaultUserSettings": ...,
    "SubnetIds": ...,
    "VpcId": ...,
}

parent.create_domain(**kwargs)

See CreateDomainRequestRequestTypeDef

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

See EdgeDeploymentModelConfigTypeDef
See DeploymentStageTypeDef
See TagTypeDef
See CreateEdgeDeploymentPlanResponseTypeDef

# create_edge_deployment_plan method usage example with argument unpacking

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

parent.create_edge_deployment_plan(**kwargs)

See CreateEdgeDeploymentPlanRequestRequestTypeDef

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

See DeploymentStageTypeDef
See EmptyResponseMetadataTypeDef

# create_edge_deployment_stage method usage example with argument unpacking

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

parent.create_edge_deployment_stage(**kwargs)

See CreateEdgeDeploymentStageRequestRequestTypeDef

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

# create_edge_packaging_job method usage example with argument unpacking

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

parent.create_edge_packaging_job(**kwargs)

See CreateEdgePackagingJobRequestRequestTypeDef

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: DeploymentConfigTypeDef = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateEndpointOutputTypeDef:  # (3)
    ...

# create_endpoint method usage example with argument unpacking

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

parent.create_endpoint(**kwargs)

See CreateEndpointInputRequestTypeDef

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: DataCaptureConfigTypeDef = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
    KmsKeyId: str = ...,
    AsyncInferenceConfig: AsyncInferenceConfigTypeDef = ...,  # (4)
    ExplainerConfig: ExplainerConfigTypeDef = ...,  # (5)
    ShadowProductionVariants: Sequence[ProductionVariantTypeDef] = ...,  # (1)
    ExecutionRoleArn: str = ...,
    VpcConfig: VpcConfigTypeDef = ...,  # (7)
    EnableNetworkIsolation: bool = ...,
) -> CreateEndpointConfigOutputTypeDef:  # (8)
    ...

# create_endpoint_config method usage example with argument unpacking

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

parent.create_endpoint_config(**kwargs)

See CreateEndpointConfigInputRequestTypeDef

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

See TagTypeDef
See CreateExperimentResponseTypeDef

# create_experiment method usage example with argument unpacking

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

parent.create_experiment(**kwargs)

See CreateExperimentRequestRequestTypeDef

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

# create_feature_group method usage example with argument unpacking

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

parent.create_feature_group(**kwargs)

See CreateFeatureGroupRequestRequestTypeDef

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: HumanLoopConfigTypeDef = ...,  # (4)
    Tags: Sequence[TagTypeDef] = ...,  # (5)
) -> CreateFlowDefinitionResponseTypeDef:  # (6)
    ...

# create_flow_definition method usage example with argument unpacking

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

parent.create_flow_definition(**kwargs)

See CreateFlowDefinitionRequestRequestTypeDef

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

# create_hub method usage example with argument unpacking

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

parent.create_hub(**kwargs)

See CreateHubRequestRequestTypeDef

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

See TagTypeDef
See CreateHubContentReferenceResponseTypeDef

# create_hub_content_reference method usage example with argument unpacking

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

parent.create_hub_content_reference(**kwargs)

See CreateHubContentReferenceRequestRequestTypeDef

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

# create_human_task_ui method usage example with argument unpacking

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

parent.create_human_task_ui(**kwargs)

See CreateHumanTaskUiRequestRequestTypeDef

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: HyperParameterTuningJobConfigTypeDef,  # (1)
    TrainingJobDefinition: HyperParameterTrainingJobDefinitionTypeDef = ...,  # (2)
    TrainingJobDefinitions: Sequence[HyperParameterTrainingJobDefinitionUnionTypeDef] = ...,  # (3)
    WarmStartConfig: HyperParameterTuningJobWarmStartConfigTypeDef = ...,  # (4)
    Tags: Sequence[TagTypeDef] = ...,  # (5)
    Autotune: AutotuneTypeDef = ...,  # (6)
) -> CreateHyperParameterTuningJobResponseTypeDef:  # (7)
    ...

# create_hyper_parameter_tuning_job method usage example with argument unpacking

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

parent.create_hyper_parameter_tuning_job(**kwargs)

See CreateHyperParameterTuningJobRequestRequestTypeDef

create_image#

Creates a custom SageMaker 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)
    ...

See TagTypeDef
See CreateImageResponseTypeDef

# create_image method usage example with argument unpacking

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

parent.create_image(**kwargs)

See CreateImageRequestRequestTypeDef

create_image_version#

Creates a version of the SageMaker 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)
    ...

# create_image_version method usage example with argument unpacking

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

parent.create_image_version(**kwargs)

See CreateImageVersionRequestRequestTypeDef

create_inference_component#

Creates an inference component, which is a SageMaker 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,
    VariantName: str,
    Specification: InferenceComponentSpecificationTypeDef,  # (1)
    RuntimeConfig: InferenceComponentRuntimeConfigTypeDef,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateInferenceComponentOutputTypeDef:  # (4)
    ...

See InferenceComponentSpecificationTypeDef
See InferenceComponentRuntimeConfigTypeDef
See TagTypeDef
See CreateInferenceComponentOutputTypeDef

# create_inference_component method usage example with argument unpacking

kwargs: CreateInferenceComponentInputRequestTypeDef = {  # (1)
    "InferenceComponentName": ...,
    "EndpointName": ...,
    "VariantName": ...,
    "Specification": ...,
    "RuntimeConfig": ...,
}

parent.create_inference_component(**kwargs)

See CreateInferenceComponentInputRequestTypeDef

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: ShadowModeConfigTypeDef,  # (3)
    Schedule: InferenceExperimentScheduleTypeDef = ...,  # (4)
    Description: str = ...,
    DataStorageConfig: InferenceExperimentDataStorageConfigTypeDef = ...,  # (5)
    KmsKey: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (6)
) -> CreateInferenceExperimentResponseTypeDef:  # (7)
    ...

See InferenceExperimentTypeType
See ModelVariantConfigTypeDef
See ShadowModeConfigTypeDef
See InferenceExperimentScheduleTypeDef
See InferenceExperimentDataStorageConfigTypeDef
See TagTypeDef
See CreateInferenceExperimentResponseTypeDef

# create_inference_experiment method usage example with argument unpacking

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

parent.create_inference_experiment(**kwargs)

See CreateInferenceExperimentRequestRequestTypeDef

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: RecommendationJobInputConfigTypeDef,  # (2)
    JobDescription: str = ...,
    StoppingConditions: RecommendationJobStoppingConditionsTypeDef = ...,  # (3)
    OutputConfig: RecommendationJobOutputConfigTypeDef = ...,  # (4)
    Tags: Sequence[TagTypeDef] = ...,  # (5)
) -> CreateInferenceRecommendationsJobResponseTypeDef:  # (6)
    ...

# create_inference_recommendations_job method usage example with argument unpacking

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

parent.create_inference_recommendations_job(**kwargs)

See CreateInferenceRecommendationsJobRequestRequestTypeDef

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: LabelingJobInputConfigTypeDef,  # (1)
    OutputConfig: LabelingJobOutputConfigTypeDef,  # (2)
    RoleArn: str,
    HumanTaskConfig: HumanTaskConfigTypeDef,  # (3)
    LabelCategoryConfigS3Uri: str = ...,
    StoppingConditions: LabelingJobStoppingConditionsTypeDef = ...,  # (4)
    LabelingJobAlgorithmsConfig: LabelingJobAlgorithmsConfigTypeDef = ...,  # (5)
    Tags: Sequence[TagTypeDef] = ...,  # (6)
) -> CreateLabelingJobResponseTypeDef:  # (7)
    ...

See LabelingJobInputConfigTypeDef
See LabelingJobOutputConfigTypeDef
See HumanTaskConfigTypeDef
See LabelingJobStoppingConditionsTypeDef
See LabelingJobAlgorithmsConfigTypeDef
See TagTypeDef
See CreateLabelingJobResponseTypeDef

# create_labeling_job method usage example with argument unpacking

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

parent.create_labeling_job(**kwargs)

See CreateLabelingJobRequestRequestTypeDef

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

See TrackingServerSizeType
See TagTypeDef
See CreateMlflowTrackingServerResponseTypeDef

# create_mlflow_tracking_server method usage example with argument unpacking

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

parent.create_mlflow_tracking_server(**kwargs)

See CreateMlflowTrackingServerRequestRequestTypeDef

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: ContainerDefinitionTypeDef = ...,  # (1)
    Containers: Sequence[ContainerDefinitionUnionTypeDef] = ...,  # (2)
    InferenceExecutionConfig: InferenceExecutionConfigTypeDef = ...,  # (3)
    ExecutionRoleArn: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (4)
    VpcConfig: VpcConfigTypeDef = ...,  # (5)
    EnableNetworkIsolation: bool = ...,
) -> CreateModelOutputTypeDef:  # (6)
    ...

See ContainerDefinitionTypeDef
See ContainerDefinitionTypeDef ContainerDefinitionOutputTypeDef
See InferenceExecutionConfigTypeDef
See TagTypeDef
See VpcConfigTypeDef
See CreateModelOutputTypeDef

# create_model method usage example with argument unpacking

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

parent.create_model(**kwargs)

See CreateModelInputRequestTypeDef

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: ModelBiasAppSpecificationTypeDef,  # (1)
    ModelBiasJobInput: ModelBiasJobInputTypeDef,  # (2)
    ModelBiasJobOutputConfig: MonitoringOutputConfigTypeDef,  # (3)
    JobResources: MonitoringResourcesTypeDef,  # (4)
    RoleArn: str,
    ModelBiasBaselineConfig: ModelBiasBaselineConfigTypeDef = ...,  # (5)
    NetworkConfig: MonitoringNetworkConfigTypeDef = ...,  # (6)
    StoppingCondition: MonitoringStoppingConditionTypeDef = ...,  # (7)
    Tags: Sequence[TagTypeDef] = ...,  # (8)
) -> CreateModelBiasJobDefinitionResponseTypeDef:  # (9)
    ...

See ModelBiasAppSpecificationTypeDef
See ModelBiasJobInputTypeDef
See MonitoringOutputConfigTypeDef
See MonitoringResourcesTypeDef
See ModelBiasBaselineConfigTypeDef
See MonitoringNetworkConfigTypeDef
See MonitoringStoppingConditionTypeDef
See TagTypeDef
See CreateModelBiasJobDefinitionResponseTypeDef

# create_model_bias_job_definition method usage example with argument unpacking

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

parent.create_model_bias_job_definition(**kwargs)

See CreateModelBiasJobDefinitionRequestRequestTypeDef

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

# create_model_card method usage example with argument unpacking

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

parent.create_model_card(**kwargs)

See CreateModelCardRequestRequestTypeDef

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

# create_model_card_export_job method usage example with argument unpacking

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

parent.create_model_card_export_job(**kwargs)

See CreateModelCardExportJobRequestRequestTypeDef

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: ModelExplainabilityAppSpecificationTypeDef,  # (1)
    ModelExplainabilityJobInput: ModelExplainabilityJobInputTypeDef,  # (2)
    ModelExplainabilityJobOutputConfig: MonitoringOutputConfigTypeDef,  # (3)
    JobResources: MonitoringResourcesTypeDef,  # (4)
    RoleArn: str,
    ModelExplainabilityBaselineConfig: ModelExplainabilityBaselineConfigTypeDef = ...,  # (5)
    NetworkConfig: MonitoringNetworkConfigTypeDef = ...,  # (6)
    StoppingCondition: MonitoringStoppingConditionTypeDef = ...,  # (7)
    Tags: Sequence[TagTypeDef] = ...,  # (8)
) -> CreateModelExplainabilityJobDefinitionResponseTypeDef:  # (9)
    ...

# create_model_explainability_job_definition method usage example with argument unpacking

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

parent.create_model_explainability_job_definition(**kwargs)

See CreateModelExplainabilityJobDefinitionRequestRequestTypeDef

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: InferenceSpecificationTypeDef = ...,  # (1)
    ValidationSpecification: ModelPackageValidationSpecificationTypeDef = ...,  # (2)
    SourceAlgorithmSpecification: SourceAlgorithmSpecificationTypeDef = ...,  # (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)
    ...

See InferenceSpecificationTypeDef
See ModelPackageValidationSpecificationTypeDef
See SourceAlgorithmSpecificationTypeDef
See TagTypeDef
See ModelApprovalStatusType
See MetadataPropertiesTypeDef
See ModelMetricsTypeDef
See DriftCheckBaselinesTypeDef
See AdditionalInferenceSpecificationDefinitionTypeDef AdditionalInferenceSpecificationDefinitionOutputTypeDef
See SkipModelValidationType
See ModelPackageSecurityConfigTypeDef
See ModelPackageModelCardTypeDef
See ModelLifeCycleTypeDef
See CreateModelPackageOutputTypeDef

# create_model_package method usage example with argument unpacking

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

parent.create_model_package(**kwargs)

See CreateModelPackageInputRequestTypeDef

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

See TagTypeDef
See CreateModelPackageGroupOutputTypeDef

# create_model_package_group method usage example with argument unpacking

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

parent.create_model_package_group(**kwargs)

See CreateModelPackageGroupInputRequestTypeDef

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: ModelQualityAppSpecificationTypeDef,  # (1)
    ModelQualityJobInput: ModelQualityJobInputTypeDef,  # (2)
    ModelQualityJobOutputConfig: MonitoringOutputConfigTypeDef,  # (3)
    JobResources: MonitoringResourcesTypeDef,  # (4)
    RoleArn: str,
    ModelQualityBaselineConfig: ModelQualityBaselineConfigTypeDef = ...,  # (5)
    NetworkConfig: MonitoringNetworkConfigTypeDef = ...,  # (6)
    StoppingCondition: MonitoringStoppingConditionTypeDef = ...,  # (7)
    Tags: Sequence[TagTypeDef] = ...,  # (8)
) -> CreateModelQualityJobDefinitionResponseTypeDef:  # (9)
    ...

See ModelQualityAppSpecificationTypeDef
See ModelQualityJobInputTypeDef
See MonitoringOutputConfigTypeDef
See MonitoringResourcesTypeDef
See ModelQualityBaselineConfigTypeDef
See MonitoringNetworkConfigTypeDef
See MonitoringStoppingConditionTypeDef
See TagTypeDef
See CreateModelQualityJobDefinitionResponseTypeDef

# create_model_quality_job_definition method usage example with argument unpacking

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

parent.create_model_quality_job_definition(**kwargs)

See CreateModelQualityJobDefinitionRequestRequestTypeDef

create_monitoring_schedule#

Creates a schedule that regularly starts Amazon SageMaker Processing Jobs to monitor the data captured for an Amazon SageMaker 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: MonitoringScheduleConfigTypeDef,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateMonitoringScheduleResponseTypeDef:  # (3)
    ...

See MonitoringScheduleConfigTypeDef
See TagTypeDef
See CreateMonitoringScheduleResponseTypeDef

# create_monitoring_schedule method usage example with argument unpacking

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

parent.create_monitoring_schedule(**kwargs)

See CreateMonitoringScheduleRequestRequestTypeDef

create_notebook_instance#

Creates an SageMaker 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)
    ...

See InstanceTypeType
See TagTypeDef
See DirectInternetAccessType
See NotebookInstanceAcceleratorTypeType
See RootAccessType
See InstanceMetadataServiceConfigurationTypeDef
See CreateNotebookInstanceOutputTypeDef

# create_notebook_instance method usage example with argument unpacking

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

parent.create_notebook_instance(**kwargs)

See CreateNotebookInstanceInputRequestTypeDef

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)
) -> CreateNotebookInstanceLifecycleConfigOutputTypeDef:  # (3)
    ...

# create_notebook_instance_lifecycle_config method usage example with argument unpacking

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

parent.create_notebook_instance_lifecycle_config(**kwargs)

See CreateNotebookInstanceLifecycleConfigInputRequestTypeDef

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: OptimizationVpcConfigTypeDef = ...,  # (7)
) -> CreateOptimizationJobResponseTypeDef:  # (8)
    ...

See OptimizationJobModelSourceTypeDef
See OptimizationJobDeploymentInstanceTypeType
See OptimizationConfigTypeDef OptimizationConfigOutputTypeDef
See OptimizationJobOutputConfigTypeDef
See StoppingConditionTypeDef
See TagTypeDef
See OptimizationVpcConfigTypeDef
See CreateOptimizationJobResponseTypeDef

# create_optimization_job method usage example with argument unpacking

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

parent.create_optimization_job(**kwargs)

See CreateOptimizationJobRequestRequestTypeDef

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

# create_pipeline method usage example with argument unpacking

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

parent.create_pipeline(**kwargs)

See CreatePipelineRequestRequestTypeDef

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

See CreatePresignedDomainUrlResponseTypeDef

# create_presigned_domain_url method usage example with argument unpacking

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

parent.create_presigned_domain_url(**kwargs)

See CreatePresignedDomainUrlRequestRequestTypeDef

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

See CreatePresignedMlflowTrackingServerUrlResponseTypeDef

# create_presigned_mlflow_tracking_server_url method usage example with argument unpacking

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

parent.create_presigned_mlflow_tracking_server_url(**kwargs)

See CreatePresignedMlflowTrackingServerUrlRequestRequestTypeDef

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

See CreatePresignedNotebookInstanceUrlOutputTypeDef

# create_presigned_notebook_instance_url method usage example with argument unpacking

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

parent.create_presigned_notebook_instance_url(**kwargs)

See CreatePresignedNotebookInstanceUrlInputRequestTypeDef

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: AppSpecificationTypeDef,  # (2)
    RoleArn: str,
    ProcessingInputs: Sequence[ProcessingInputTypeDef] = ...,  # (3)
    ProcessingOutputConfig: ProcessingOutputConfigTypeDef = ...,  # (4)
    StoppingCondition: ProcessingStoppingConditionTypeDef = ...,  # (5)
    Environment: Mapping[str, str] = ...,
    NetworkConfig: NetworkConfigTypeDef = ...,  # (6)
    Tags: Sequence[TagTypeDef] = ...,  # (7)
    ExperimentConfig: ExperimentConfigTypeDef = ...,  # (8)
) -> CreateProcessingJobResponseTypeDef:  # (9)
    ...

# create_processing_job method usage example with argument unpacking

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

parent.create_processing_job(**kwargs)

See CreateProcessingJobRequestRequestTypeDef

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,
    ServiceCatalogProvisioningDetails: ServiceCatalogProvisioningDetailsTypeDef,  # (1)
    ProjectDescription: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateProjectOutputTypeDef:  # (3)
    ...

See ServiceCatalogProvisioningDetailsTypeDef
See TagTypeDef
See CreateProjectOutputTypeDef

# create_project method usage example with argument unpacking

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

parent.create_project(**kwargs)

See CreateProjectInputRequestTypeDef

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: SpaceSettingsTypeDef = ...,  # (2)
    OwnershipSettings: OwnershipSettingsTypeDef = ...,  # (3)
    SpaceSharingSettings: SpaceSharingSettingsTypeDef = ...,  # (4)
    SpaceDisplayName: str = ...,
) -> CreateSpaceResponseTypeDef:  # (5)
    ...

# create_space method usage example with argument unpacking

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

parent.create_space(**kwargs)

See CreateSpaceRequestRequestTypeDef

create_studio_lifecycle_config#

Creates a new Amazon SageMaker 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)
    ...

See StudioLifecycleConfigAppTypeType
See TagTypeDef
See CreateStudioLifecycleConfigResponseTypeDef

# create_studio_lifecycle_config method usage example with argument unpacking

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

parent.create_studio_lifecycle_config(**kwargs)

See CreateStudioLifecycleConfigRequestRequestTypeDef

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: AlgorithmSpecificationTypeDef,  # (1)
    RoleArn: str,
    OutputDataConfig: OutputDataConfigTypeDef,  # (2)
    ResourceConfig: ResourceConfigTypeDef,  # (3)
    StoppingCondition: StoppingConditionTypeDef,  # (4)
    HyperParameters: Mapping[str, str] = ...,
    InputDataConfig: Sequence[ChannelUnionTypeDef] = ...,  # (5)
    VpcConfig: VpcConfigTypeDef = ...,  # (6)
    Tags: Sequence[TagTypeDef] = ...,  # (7)
    EnableNetworkIsolation: bool = ...,
    EnableInterContainerTrafficEncryption: bool = ...,
    EnableManagedSpotTraining: bool = ...,
    CheckpointConfig: CheckpointConfigTypeDef = ...,  # (8)
    DebugHookConfig: DebugHookConfigTypeDef = ...,  # (9)
    DebugRuleConfigurations: Sequence[DebugRuleConfigurationUnionTypeDef] = ...,  # (10)
    TensorBoardOutputConfig: TensorBoardOutputConfigTypeDef = ...,  # (11)
    ExperimentConfig: ExperimentConfigTypeDef = ...,  # (12)
    ProfilerConfig: ProfilerConfigTypeDef = ...,  # (13)
    ProfilerRuleConfigurations: Sequence[ProfilerRuleConfigurationUnionTypeDef] = ...,  # (14)
    Environment: Mapping[str, str] = ...,
    RetryStrategy: RetryStrategyTypeDef = ...,  # (15)
    RemoteDebugConfig: RemoteDebugConfigTypeDef = ...,  # (16)
    InfraCheckConfig: InfraCheckConfigTypeDef = ...,  # (17)
    SessionChainingConfig: SessionChainingConfigTypeDef = ...,  # (18)
) -> CreateTrainingJobResponseTypeDef:  # (19)
    ...

See AlgorithmSpecificationTypeDef
See OutputDataConfigTypeDef
See ResourceConfigTypeDef
See StoppingConditionTypeDef
See ChannelTypeDef ChannelOutputTypeDef
See VpcConfigTypeDef
See TagTypeDef
See CheckpointConfigTypeDef
See DebugHookConfigTypeDef
See DebugRuleConfigurationTypeDef DebugRuleConfigurationOutputTypeDef
See TensorBoardOutputConfigTypeDef
See ExperimentConfigTypeDef
See ProfilerConfigTypeDef
See ProfilerRuleConfigurationTypeDef ProfilerRuleConfigurationOutputTypeDef
See RetryStrategyTypeDef
See RemoteDebugConfigTypeDef
See InfraCheckConfigTypeDef
See SessionChainingConfigTypeDef
See CreateTrainingJobResponseTypeDef

# create_training_job method usage example with argument unpacking

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

parent.create_training_job(**kwargs)

See CreateTrainingJobRequestRequestTypeDef

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

# create_transform_job method usage example with argument unpacking

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

parent.create_transform_job(**kwargs)

See CreateTransformJobRequestRequestTypeDef

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

# create_trial method usage example with argument unpacking

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

parent.create_trial(**kwargs)

See CreateTrialRequestRequestTypeDef

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

# create_trial_component method usage example with argument unpacking

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

parent.create_trial_component(**kwargs)

See CreateTrialComponentRequestRequestTypeDef

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: UserSettingsTypeDef = ...,  # (2)
) -> CreateUserProfileResponseTypeDef:  # (3)
    ...

# create_user_profile method usage example with argument unpacking

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

parent.create_user_profile(**kwargs)

See CreateUserProfileRequestRequestTypeDef

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: SourceIpConfigTypeDef = ...,  # (3)
    Tags: Sequence[TagTypeDef] = ...,  # (4)
    WorkforceVpcConfig: WorkforceVpcConfigRequestTypeDef = ...,  # (5)
) -> CreateWorkforceResponseTypeDef:  # (6)
    ...

# create_workforce method usage example with argument unpacking

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

parent.create_workforce(**kwargs)

See CreateWorkforceRequestRequestTypeDef

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

See MemberDefinitionTypeDef MemberDefinitionOutputTypeDef
See NotificationConfigurationTypeDef
See WorkerAccessConfigurationTypeDef
See TagTypeDef
See CreateWorkteamResponseTypeDef

# create_workteam method usage example with argument unpacking

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

parent.create_workteam(**kwargs)

See CreateWorkteamRequestRequestTypeDef

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

See DeleteActionResponseTypeDef

# delete_action method usage example with argument unpacking

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

parent.delete_action(**kwargs)

See DeleteActionRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# delete_algorithm method usage example with argument unpacking

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

parent.delete_algorithm(**kwargs)

See DeleteAlgorithmInputRequestTypeDef

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

See AppTypeType
See EmptyResponseMetadataTypeDef

# delete_app method usage example with argument unpacking

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

parent.delete_app(**kwargs)

See DeleteAppRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# delete_app_image_config method usage example with argument unpacking

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

parent.delete_app_image_config(**kwargs)

See DeleteAppImageConfigRequestRequestTypeDef

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: ArtifactSourceTypeDef = ...,  # (1)
) -> DeleteArtifactResponseTypeDef:  # (2)
    ...

See ArtifactSourceTypeDef
See DeleteArtifactResponseTypeDef

# delete_artifact method usage example with argument unpacking

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

parent.delete_artifact(**kwargs)

See DeleteArtifactRequestRequestTypeDef

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

See DeleteAssociationResponseTypeDef

# delete_association method usage example with argument unpacking

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

parent.delete_association(**kwargs)

See DeleteAssociationRequestRequestTypeDef

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

See DeleteClusterResponseTypeDef

# delete_cluster method usage example with argument unpacking

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

parent.delete_cluster(**kwargs)

See DeleteClusterRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# delete_code_repository method usage example with argument unpacking

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

parent.delete_code_repository(**kwargs)

See DeleteCodeRepositoryInputRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# delete_compilation_job method usage example with argument unpacking

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

parent.delete_compilation_job(**kwargs)

See DeleteCompilationJobRequestRequestTypeDef

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

See DeleteContextResponseTypeDef

# delete_context method usage example with argument unpacking

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

parent.delete_context(**kwargs)

See DeleteContextRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# delete_data_quality_job_definition method usage example with argument unpacking

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

parent.delete_data_quality_job_definition(**kwargs)

See DeleteDataQualityJobDefinitionRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# delete_device_fleet method usage example with argument unpacking

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

parent.delete_device_fleet(**kwargs)

See DeleteDeviceFleetRequestRequestTypeDef

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

See RetentionPolicyTypeDef
See EmptyResponseMetadataTypeDef

# delete_domain method usage example with argument unpacking

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

parent.delete_domain(**kwargs)

See DeleteDomainRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# delete_edge_deployment_plan method usage example with argument unpacking

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

parent.delete_edge_deployment_plan(**kwargs)

See DeleteEdgeDeploymentPlanRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# delete_edge_deployment_stage method usage example with argument unpacking

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

parent.delete_edge_deployment_stage(**kwargs)

See DeleteEdgeDeploymentStageRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# delete_endpoint method usage example with argument unpacking

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

parent.delete_endpoint(**kwargs)

See DeleteEndpointInputRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# delete_endpoint_config method usage example with argument unpacking

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

parent.delete_endpoint_config(**kwargs)

See DeleteEndpointConfigInputRequestTypeDef

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

See DeleteExperimentResponseTypeDef

# delete_experiment method usage example with argument unpacking

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

parent.delete_experiment(**kwargs)

See DeleteExperimentRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# delete_feature_group method usage example with argument unpacking

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

parent.delete_feature_group(**kwargs)

See DeleteFeatureGroupRequestRequestTypeDef

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: DeleteFlowDefinitionRequestRequestTypeDef = {  # (1)
    "FlowDefinitionName": ...,
}

parent.delete_flow_definition(**kwargs)

See DeleteFlowDefinitionRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# delete_hub method usage example with argument unpacking

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

parent.delete_hub(**kwargs)

See DeleteHubRequestRequestTypeDef

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

See HubContentTypeType
See EmptyResponseMetadataTypeDef

# delete_hub_content method usage example with argument unpacking

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

parent.delete_hub_content(**kwargs)

See DeleteHubContentRequestRequestTypeDef

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

See HubContentTypeType
See EmptyResponseMetadataTypeDef

# delete_hub_content_reference method usage example with argument unpacking

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

parent.delete_hub_content_reference(**kwargs)

See DeleteHubContentReferenceRequestRequestTypeDef

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: DeleteHumanTaskUiRequestRequestTypeDef = {  # (1)
    "HumanTaskUiName": ...,
}

parent.delete_human_task_ui(**kwargs)

See DeleteHumanTaskUiRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# delete_hyper_parameter_tuning_job method usage example with argument unpacking

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

parent.delete_hyper_parameter_tuning_job(**kwargs)

See DeleteHyperParameterTuningJobRequestRequestTypeDef

delete_image#

Deletes a SageMaker 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: DeleteImageRequestRequestTypeDef = {  # (1)
    "ImageName": ...,
}

parent.delete_image(**kwargs)

See DeleteImageRequestRequestTypeDef

delete_image_version#

Deletes a version of a SageMaker 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: DeleteImageVersionRequestRequestTypeDef = {  # (1)
    "ImageName": ...,
}

parent.delete_image_version(**kwargs)

See DeleteImageVersionRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# delete_inference_component method usage example with argument unpacking

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

parent.delete_inference_component(**kwargs)

See DeleteInferenceComponentInputRequestTypeDef

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

See DeleteInferenceExperimentResponseTypeDef

# delete_inference_experiment method usage example with argument unpacking

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

parent.delete_inference_experiment(**kwargs)

See DeleteInferenceExperimentRequestRequestTypeDef

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

See DeleteMlflowTrackingServerResponseTypeDef

# delete_mlflow_tracking_server method usage example with argument unpacking

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

parent.delete_mlflow_tracking_server(**kwargs)

See DeleteMlflowTrackingServerRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# delete_model method usage example with argument unpacking

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

parent.delete_model(**kwargs)

See DeleteModelInputRequestTypeDef

delete_model_bias_job_definition#

Deletes an Amazon SageMaker 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)
    ...

See EmptyResponseMetadataTypeDef

# delete_model_bias_job_definition method usage example with argument unpacking

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

parent.delete_model_bias_job_definition(**kwargs)

See DeleteModelBiasJobDefinitionRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# delete_model_card method usage example with argument unpacking

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

parent.delete_model_card(**kwargs)

See DeleteModelCardRequestRequestTypeDef

delete_model_explainability_job_definition#

Deletes an Amazon SageMaker 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)
    ...

See EmptyResponseMetadataTypeDef

# delete_model_explainability_job_definition method usage example with argument unpacking

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

parent.delete_model_explainability_job_definition(**kwargs)

See DeleteModelExplainabilityJobDefinitionRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# delete_model_package method usage example with argument unpacking

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

parent.delete_model_package(**kwargs)

See DeleteModelPackageInputRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# delete_model_package_group method usage example with argument unpacking

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

parent.delete_model_package_group(**kwargs)

See DeleteModelPackageGroupInputRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# delete_model_package_group_policy method usage example with argument unpacking

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

parent.delete_model_package_group_policy(**kwargs)

See DeleteModelPackageGroupPolicyInputRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# delete_model_quality_job_definition method usage example with argument unpacking

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

parent.delete_model_quality_job_definition(**kwargs)

See DeleteModelQualityJobDefinitionRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# delete_monitoring_schedule method usage example with argument unpacking

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

parent.delete_monitoring_schedule(**kwargs)

See DeleteMonitoringScheduleRequestRequestTypeDef

delete_notebook_instance#

Deletes an SageMaker 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)
    ...

See EmptyResponseMetadataTypeDef

# delete_notebook_instance method usage example with argument unpacking

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

parent.delete_notebook_instance(**kwargs)

See DeleteNotebookInstanceInputRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# delete_notebook_instance_lifecycle_config method usage example with argument unpacking

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

parent.delete_notebook_instance_lifecycle_config(**kwargs)

See DeleteNotebookInstanceLifecycleConfigInputRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# delete_optimization_job method usage example with argument unpacking

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

parent.delete_optimization_job(**kwargs)

See DeleteOptimizationJobRequestRequestTypeDef

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

See DeletePipelineResponseTypeDef

# delete_pipeline method usage example with argument unpacking

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

parent.delete_pipeline(**kwargs)

See DeletePipelineRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# delete_project method usage example with argument unpacking

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

parent.delete_project(**kwargs)

See DeleteProjectInputRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# delete_space method usage example with argument unpacking

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

parent.delete_space(**kwargs)

See DeleteSpaceRequestRequestTypeDef

delete_studio_lifecycle_config#

Deletes the Amazon SageMaker 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)
    ...

See EmptyResponseMetadataTypeDef

# delete_studio_lifecycle_config method usage example with argument unpacking

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

parent.delete_studio_lifecycle_config(**kwargs)

See DeleteStudioLifecycleConfigRequestRequestTypeDef

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: DeleteTagsInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.delete_tags(**kwargs)

See DeleteTagsInputRequestTypeDef

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

See DeleteTrialResponseTypeDef

# delete_trial method usage example with argument unpacking

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

parent.delete_trial(**kwargs)

See DeleteTrialRequestRequestTypeDef

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

See DeleteTrialComponentResponseTypeDef

# delete_trial_component method usage example with argument unpacking

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

parent.delete_trial_component(**kwargs)

See DeleteTrialComponentRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# delete_user_profile method usage example with argument unpacking

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

parent.delete_user_profile(**kwargs)

See DeleteUserProfileRequestRequestTypeDef

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: DeleteWorkforceRequestRequestTypeDef = {  # (1)
    "WorkforceName": ...,
}

parent.delete_workforce(**kwargs)

See DeleteWorkforceRequestRequestTypeDef

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

See DeleteWorkteamResponseTypeDef

# delete_workteam method usage example with argument unpacking

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

parent.delete_workteam(**kwargs)

See DeleteWorkteamRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# deregister_devices method usage example with argument unpacking

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

parent.deregister_devices(**kwargs)

See DeregisterDevicesRequestRequestTypeDef

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

See DescribeActionResponseTypeDef

# describe_action method usage example with argument unpacking

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

parent.describe_action(**kwargs)

See DescribeActionRequestRequestTypeDef

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

See DescribeAlgorithmOutputTypeDef

# describe_algorithm method usage example with argument unpacking

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

parent.describe_algorithm(**kwargs)

See DescribeAlgorithmInputRequestTypeDef

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

See AppTypeType
See DescribeAppResponseTypeDef

# describe_app method usage example with argument unpacking

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

parent.describe_app(**kwargs)

See DescribeAppRequestRequestTypeDef

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

See DescribeAppImageConfigResponseTypeDef

# describe_app_image_config method usage example with argument unpacking

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

parent.describe_app_image_config(**kwargs)

See DescribeAppImageConfigRequestRequestTypeDef

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

See DescribeArtifactResponseTypeDef

# describe_artifact method usage example with argument unpacking

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

parent.describe_artifact(**kwargs)

See DescribeArtifactRequestRequestTypeDef

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

See DescribeAutoMLJobResponseTypeDef

# describe_auto_ml_job method usage example with argument unpacking

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

parent.describe_auto_ml_job(**kwargs)

See DescribeAutoMLJobRequestRequestTypeDef

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

See DescribeAutoMLJobV2ResponseTypeDef

# describe_auto_ml_job_v2 method usage example with argument unpacking

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

parent.describe_auto_ml_job_v2(**kwargs)

See DescribeAutoMLJobV2RequestRequestTypeDef

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

See DescribeClusterResponseTypeDef

# describe_cluster method usage example with argument unpacking

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

parent.describe_cluster(**kwargs)

See DescribeClusterRequestRequestTypeDef

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

See DescribeClusterNodeResponseTypeDef

# describe_cluster_node method usage example with argument unpacking

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

parent.describe_cluster_node(**kwargs)

See DescribeClusterNodeRequestRequestTypeDef

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

See DescribeCodeRepositoryOutputTypeDef

# describe_code_repository method usage example with argument unpacking

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

parent.describe_code_repository(**kwargs)

See DescribeCodeRepositoryInputRequestTypeDef

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

See DescribeCompilationJobResponseTypeDef

# describe_compilation_job method usage example with argument unpacking

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

parent.describe_compilation_job(**kwargs)

See DescribeCompilationJobRequestRequestTypeDef

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

See DescribeContextResponseTypeDef

# describe_context method usage example with argument unpacking

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

parent.describe_context(**kwargs)

See DescribeContextRequestRequestTypeDef

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

See DescribeDataQualityJobDefinitionResponseTypeDef

# describe_data_quality_job_definition method usage example with argument unpacking

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

parent.describe_data_quality_job_definition(**kwargs)

See DescribeDataQualityJobDefinitionRequestRequestTypeDef

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

See DescribeDeviceResponseTypeDef

# describe_device method usage example with argument unpacking

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

parent.describe_device(**kwargs)

See DescribeDeviceRequestRequestTypeDef

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

See DescribeDeviceFleetResponseTypeDef

# describe_device_fleet method usage example with argument unpacking

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

parent.describe_device_fleet(**kwargs)

See DescribeDeviceFleetRequestRequestTypeDef

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

See DescribeDomainResponseTypeDef

# describe_domain method usage example with argument unpacking

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

parent.describe_domain(**kwargs)

See DescribeDomainRequestRequestTypeDef

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

See DescribeEdgeDeploymentPlanResponseTypeDef

# describe_edge_deployment_plan method usage example with argument unpacking

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

parent.describe_edge_deployment_plan(**kwargs)

See DescribeEdgeDeploymentPlanRequestRequestTypeDef

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

See DescribeEdgePackagingJobResponseTypeDef

# describe_edge_packaging_job method usage example with argument unpacking

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

parent.describe_edge_packaging_job(**kwargs)

See DescribeEdgePackagingJobRequestRequestTypeDef

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

See DescribeEndpointOutputTypeDef

# describe_endpoint method usage example with argument unpacking

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

parent.describe_endpoint(**kwargs)

See DescribeEndpointInputRequestTypeDef

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

See DescribeEndpointConfigOutputTypeDef

# describe_endpoint_config method usage example with argument unpacking

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

parent.describe_endpoint_config(**kwargs)

See DescribeEndpointConfigInputRequestTypeDef

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

See DescribeExperimentResponseTypeDef

# describe_experiment method usage example with argument unpacking

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

parent.describe_experiment(**kwargs)

See DescribeExperimentRequestRequestTypeDef

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

See DescribeFeatureGroupResponseTypeDef

# describe_feature_group method usage example with argument unpacking

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

parent.describe_feature_group(**kwargs)

See DescribeFeatureGroupRequestRequestTypeDef

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

See DescribeFeatureMetadataResponseTypeDef

# describe_feature_metadata method usage example with argument unpacking

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

parent.describe_feature_metadata(**kwargs)

See DescribeFeatureMetadataRequestRequestTypeDef

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

See DescribeFlowDefinitionResponseTypeDef

# describe_flow_definition method usage example with argument unpacking

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

parent.describe_flow_definition(**kwargs)

See DescribeFlowDefinitionRequestRequestTypeDef

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

See DescribeHubResponseTypeDef

# describe_hub method usage example with argument unpacking

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

parent.describe_hub(**kwargs)

See DescribeHubRequestRequestTypeDef

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

See HubContentTypeType
See DescribeHubContentResponseTypeDef

# describe_hub_content method usage example with argument unpacking

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

parent.describe_hub_content(**kwargs)

See DescribeHubContentRequestRequestTypeDef

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

See DescribeHumanTaskUiResponseTypeDef

# describe_human_task_ui method usage example with argument unpacking

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

parent.describe_human_task_ui(**kwargs)

See DescribeHumanTaskUiRequestRequestTypeDef

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

See DescribeHyperParameterTuningJobResponseTypeDef

# describe_hyper_parameter_tuning_job method usage example with argument unpacking

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

parent.describe_hyper_parameter_tuning_job(**kwargs)

See DescribeHyperParameterTuningJobRequestRequestTypeDef

describe_image#

Describes a SageMaker 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)
    ...

See DescribeImageResponseTypeDef

# describe_image method usage example with argument unpacking

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

parent.describe_image(**kwargs)

See DescribeImageRequestRequestTypeDef

describe_image_version#

Describes a version of a SageMaker 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)
    ...

See DescribeImageVersionResponseTypeDef

# describe_image_version method usage example with argument unpacking

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

parent.describe_image_version(**kwargs)

See DescribeImageVersionRequestRequestTypeDef

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

See DescribeInferenceComponentOutputTypeDef

# describe_inference_component method usage example with argument unpacking

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

parent.describe_inference_component(**kwargs)

See DescribeInferenceComponentInputRequestTypeDef

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

See DescribeInferenceExperimentResponseTypeDef

# describe_inference_experiment method usage example with argument unpacking

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

parent.describe_inference_experiment(**kwargs)

See DescribeInferenceExperimentRequestRequestTypeDef

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

See DescribeInferenceRecommendationsJobResponseTypeDef

# describe_inference_recommendations_job method usage example with argument unpacking

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

parent.describe_inference_recommendations_job(**kwargs)

See DescribeInferenceRecommendationsJobRequestRequestTypeDef

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

See DescribeLabelingJobResponseTypeDef

# describe_labeling_job method usage example with argument unpacking

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

parent.describe_labeling_job(**kwargs)

See DescribeLabelingJobRequestRequestTypeDef

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

See DescribeLineageGroupResponseTypeDef

# describe_lineage_group method usage example with argument unpacking

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

parent.describe_lineage_group(**kwargs)

See DescribeLineageGroupRequestRequestTypeDef

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

See DescribeMlflowTrackingServerResponseTypeDef

# describe_mlflow_tracking_server method usage example with argument unpacking

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

parent.describe_mlflow_tracking_server(**kwargs)

See DescribeMlflowTrackingServerRequestRequestTypeDef

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

See DescribeModelOutputTypeDef

# describe_model method usage example with argument unpacking

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

parent.describe_model(**kwargs)

See DescribeModelInputRequestTypeDef

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

See DescribeModelBiasJobDefinitionResponseTypeDef

# describe_model_bias_job_definition method usage example with argument unpacking

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

parent.describe_model_bias_job_definition(**kwargs)

See DescribeModelBiasJobDefinitionRequestRequestTypeDef

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

See DescribeModelCardResponseTypeDef

# describe_model_card method usage example with argument unpacking

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

parent.describe_model_card(**kwargs)

See DescribeModelCardRequestRequestTypeDef

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

See DescribeModelCardExportJobResponseTypeDef

# describe_model_card_export_job method usage example with argument unpacking

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

parent.describe_model_card_export_job(**kwargs)

See DescribeModelCardExportJobRequestRequestTypeDef

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

See DescribeModelExplainabilityJobDefinitionResponseTypeDef

# describe_model_explainability_job_definition method usage example with argument unpacking

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

parent.describe_model_explainability_job_definition(**kwargs)

See DescribeModelExplainabilityJobDefinitionRequestRequestTypeDef

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

See DescribeModelPackageOutputTypeDef

# describe_model_package method usage example with argument unpacking

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

parent.describe_model_package(**kwargs)

See DescribeModelPackageInputRequestTypeDef

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

See DescribeModelPackageGroupOutputTypeDef

# describe_model_package_group method usage example with argument unpacking

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

parent.describe_model_package_group(**kwargs)

See DescribeModelPackageGroupInputRequestTypeDef

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

See DescribeModelQualityJobDefinitionResponseTypeDef

# describe_model_quality_job_definition method usage example with argument unpacking

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

parent.describe_model_quality_job_definition(**kwargs)

See DescribeModelQualityJobDefinitionRequestRequestTypeDef

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

See DescribeMonitoringScheduleResponseTypeDef

# describe_monitoring_schedule method usage example with argument unpacking

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

parent.describe_monitoring_schedule(**kwargs)

See DescribeMonitoringScheduleRequestRequestTypeDef

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

See DescribeNotebookInstanceOutputTypeDef

# describe_notebook_instance method usage example with argument unpacking

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

parent.describe_notebook_instance(**kwargs)

See DescribeNotebookInstanceInputRequestTypeDef

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

See DescribeNotebookInstanceLifecycleConfigOutputTypeDef

# describe_notebook_instance_lifecycle_config method usage example with argument unpacking

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

parent.describe_notebook_instance_lifecycle_config(**kwargs)

See DescribeNotebookInstanceLifecycleConfigInputRequestTypeDef

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

See DescribeOptimizationJobResponseTypeDef

# describe_optimization_job method usage example with argument unpacking

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

parent.describe_optimization_job(**kwargs)

See DescribeOptimizationJobRequestRequestTypeDef

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

See DescribePipelineResponseTypeDef

# describe_pipeline method usage example with argument unpacking

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

parent.describe_pipeline(**kwargs)

See DescribePipelineRequestRequestTypeDef

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

See DescribePipelineDefinitionForExecutionResponseTypeDef

# describe_pipeline_definition_for_execution method usage example with argument unpacking

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

parent.describe_pipeline_definition_for_execution(**kwargs)

See DescribePipelineDefinitionForExecutionRequestRequestTypeDef

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

See DescribePipelineExecutionResponseTypeDef

# describe_pipeline_execution method usage example with argument unpacking

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

parent.describe_pipeline_execution(**kwargs)

See DescribePipelineExecutionRequestRequestTypeDef

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

See DescribeProcessingJobResponseTypeDef

# describe_processing_job method usage example with argument unpacking

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

parent.describe_processing_job(**kwargs)

See DescribeProcessingJobRequestRequestTypeDef

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

See DescribeProjectOutputTypeDef

# describe_project method usage example with argument unpacking

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

parent.describe_project(**kwargs)

See DescribeProjectInputRequestTypeDef

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

See DescribeSpaceResponseTypeDef

# describe_space method usage example with argument unpacking

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

parent.describe_space(**kwargs)

See DescribeSpaceRequestRequestTypeDef

describe_studio_lifecycle_config#

Describes the Amazon SageMaker 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)
    ...

See DescribeStudioLifecycleConfigResponseTypeDef

# describe_studio_lifecycle_config method usage example with argument unpacking

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

parent.describe_studio_lifecycle_config(**kwargs)

See DescribeStudioLifecycleConfigRequestRequestTypeDef

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

See DescribeSubscribedWorkteamResponseTypeDef

# describe_subscribed_workteam method usage example with argument unpacking

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

parent.describe_subscribed_workteam(**kwargs)

See DescribeSubscribedWorkteamRequestRequestTypeDef

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

See DescribeTrainingJobResponseTypeDef

# describe_training_job method usage example with argument unpacking

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

parent.describe_training_job(**kwargs)

See DescribeTrainingJobRequestRequestTypeDef

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

See DescribeTransformJobResponseTypeDef

# describe_transform_job method usage example with argument unpacking

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

parent.describe_transform_job(**kwargs)

See DescribeTransformJobRequestRequestTypeDef

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

See DescribeTrialResponseTypeDef

# describe_trial method usage example with argument unpacking

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

parent.describe_trial(**kwargs)

See DescribeTrialRequestRequestTypeDef

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

See DescribeTrialComponentResponseTypeDef

# describe_trial_component method usage example with argument unpacking

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

parent.describe_trial_component(**kwargs)

See DescribeTrialComponentRequestRequestTypeDef

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

See DescribeUserProfileResponseTypeDef

# describe_user_profile method usage example with argument unpacking

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

parent.describe_user_profile(**kwargs)

See DescribeUserProfileRequestRequestTypeDef

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

See DescribeWorkforceResponseTypeDef

# describe_workforce method usage example with argument unpacking

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

parent.describe_workforce(**kwargs)

See DescribeWorkforceRequestRequestTypeDef

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

See DescribeWorkteamResponseTypeDef

# describe_workteam method usage example with argument unpacking

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

parent.describe_workteam(**kwargs)

See DescribeWorkteamRequestRequestTypeDef

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

See DisassociateTrialComponentResponseTypeDef

# disassociate_trial_component method usage example with argument unpacking

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

parent.disassociate_trial_component(**kwargs)

See DisassociateTrialComponentRequestRequestTypeDef

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]:
    ...

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

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

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

See GetDeviceFleetReportResponseTypeDef

# get_device_fleet_report method usage example with argument unpacking

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

parent.get_device_fleet_report(**kwargs)

See GetDeviceFleetReportRequestRequestTypeDef

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

See GetLineageGroupPolicyResponseTypeDef

# get_lineage_group_policy method usage example with argument unpacking

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

parent.get_lineage_group_policy(**kwargs)

See GetLineageGroupPolicyRequestRequestTypeDef

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

See GetModelPackageGroupPolicyOutputTypeDef

# get_model_package_group_policy method usage example with argument unpacking

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

parent.get_model_package_group_policy(**kwargs)

See GetModelPackageGroupPolicyInputRequestTypeDef

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

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

# get_scaling_configuration_recommendation method usage example with argument unpacking

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

parent.get_scaling_configuration_recommendation(**kwargs)

See GetScalingConfigurationRecommendationRequestRequestTypeDef

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

# get_search_suggestions method usage example with argument unpacking

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

parent.get_search_suggestions(**kwargs)

See GetSearchSuggestionsRequestRequestTypeDef

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 = ...,
    HubContentSearchKeywords: Sequence[str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> ImportHubContentResponseTypeDef:  # (3)
    ...

# import_hub_content method usage example with argument unpacking

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

parent.import_hub_content(**kwargs)

See ImportHubContentRequestRequestTypeDef

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

# list_actions method usage example with argument unpacking

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

parent.list_actions(**kwargs)

See ListActionsRequestRequestTypeDef

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

# list_algorithms method usage example with argument unpacking

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

parent.list_algorithms(**kwargs)

See ListAlgorithmsInputRequestTypeDef

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

See ListAliasesResponseTypeDef

# list_aliases method usage example with argument unpacking

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

parent.list_aliases(**kwargs)

See ListAliasesRequestRequestTypeDef

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

# list_app_image_configs method usage example with argument unpacking

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

parent.list_app_image_configs(**kwargs)

See ListAppImageConfigsRequestRequestTypeDef

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

# list_apps method usage example with argument unpacking

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

parent.list_apps(**kwargs)

See ListAppsRequestRequestTypeDef

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

# list_artifacts method usage example with argument unpacking

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

parent.list_artifacts(**kwargs)

See ListArtifactsRequestRequestTypeDef

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

# list_associations method usage example with argument unpacking

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

parent.list_associations(**kwargs)

See ListAssociationsRequestRequestTypeDef

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

# list_auto_ml_jobs method usage example with argument unpacking

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

parent.list_auto_ml_jobs(**kwargs)

See ListAutoMLJobsRequestRequestTypeDef

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

See CandidateStatusType
See AutoMLSortOrderType
See CandidateSortByType
See ListCandidatesForAutoMLJobResponseTypeDef

# list_candidates_for_auto_ml_job method usage example with argument unpacking

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

parent.list_candidates_for_auto_ml_job(**kwargs)

See ListCandidatesForAutoMLJobRequestRequestTypeDef

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

# list_cluster_nodes method usage example with argument unpacking

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

parent.list_cluster_nodes(**kwargs)

See ListClusterNodesRequestRequestTypeDef

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)
) -> ListClustersResponseTypeDef:  # (3)
    ...

# list_clusters method usage example with argument unpacking

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

parent.list_clusters(**kwargs)

See ListClustersRequestRequestTypeDef

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

# list_code_repositories method usage example with argument unpacking

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

parent.list_code_repositories(**kwargs)

See ListCodeRepositoriesInputRequestTypeDef

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

# list_compilation_jobs method usage example with argument unpacking

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

parent.list_compilation_jobs(**kwargs)

See ListCompilationJobsRequestRequestTypeDef

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

# list_contexts method usage example with argument unpacking

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

parent.list_contexts(**kwargs)

See ListContextsRequestRequestTypeDef

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

# list_data_quality_job_definitions method usage example with argument unpacking

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

parent.list_data_quality_job_definitions(**kwargs)

See ListDataQualityJobDefinitionsRequestRequestTypeDef

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

# list_device_fleets method usage example with argument unpacking

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

parent.list_device_fleets(**kwargs)

See ListDeviceFleetsRequestRequestTypeDef

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

See ListDevicesResponseTypeDef

# list_devices method usage example with argument unpacking

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

parent.list_devices(**kwargs)

See ListDevicesRequestRequestTypeDef

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

See ListDomainsResponseTypeDef

# list_domains method usage example with argument unpacking

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

parent.list_domains(**kwargs)

See ListDomainsRequestRequestTypeDef

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

See ListEdgeDeploymentPlansSortByType
See SortOrderType
See ListEdgeDeploymentPlansResponseTypeDef

# list_edge_deployment_plans method usage example with argument unpacking

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

parent.list_edge_deployment_plans(**kwargs)

See ListEdgeDeploymentPlansRequestRequestTypeDef

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

See EdgePackagingJobStatusType
See ListEdgePackagingJobsSortByType
See SortOrderType
See ListEdgePackagingJobsResponseTypeDef

# list_edge_packaging_jobs method usage example with argument unpacking

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

parent.list_edge_packaging_jobs(**kwargs)

See ListEdgePackagingJobsRequestRequestTypeDef

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

# list_endpoint_configs method usage example with argument unpacking

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

parent.list_endpoint_configs(**kwargs)

See ListEndpointConfigsInputRequestTypeDef

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

# list_endpoints method usage example with argument unpacking

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

parent.list_endpoints(**kwargs)

See ListEndpointsInputRequestTypeDef

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

# list_experiments method usage example with argument unpacking

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

parent.list_experiments(**kwargs)

See ListExperimentsRequestRequestTypeDef

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

# list_feature_groups method usage example with argument unpacking

kwargs: ListFeatureGroupsRequestRequestTypeDef = {  # (1)
    "NameContains": ...,
}

parent.list_feature_groups(**kwargs)

See ListFeatureGroupsRequestRequestTypeDef

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

See SortOrderType
See ListFlowDefinitionsResponseTypeDef

# list_flow_definitions method usage example with argument unpacking

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

parent.list_flow_definitions(**kwargs)

See ListFlowDefinitionsRequestRequestTypeDef

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

See HubContentTypeType
See HubContentSortByType
See SortOrderType
See ListHubContentVersionsResponseTypeDef

# list_hub_content_versions method usage example with argument unpacking

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

parent.list_hub_content_versions(**kwargs)

See ListHubContentVersionsRequestRequestTypeDef

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

# list_hub_contents method usage example with argument unpacking

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

parent.list_hub_contents(**kwargs)

See ListHubContentsRequestRequestTypeDef

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

# list_hubs method usage example with argument unpacking

kwargs: ListHubsRequestRequestTypeDef = {  # (1)
    "NameContains": ...,
}

parent.list_hubs(**kwargs)

See ListHubsRequestRequestTypeDef

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

See SortOrderType
See ListHumanTaskUisResponseTypeDef

# list_human_task_uis method usage example with argument unpacking

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

parent.list_human_task_uis(**kwargs)

See ListHumanTaskUisRequestRequestTypeDef

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

# list_hyper_parameter_tuning_jobs method usage example with argument unpacking

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

parent.list_hyper_parameter_tuning_jobs(**kwargs)

See ListHyperParameterTuningJobsRequestRequestTypeDef

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

# list_image_versions method usage example with argument unpacking

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

parent.list_image_versions(**kwargs)

See ListImageVersionsRequestRequestTypeDef

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

# list_images method usage example with argument unpacking

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

parent.list_images(**kwargs)

See ListImagesRequestRequestTypeDef

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

See InferenceComponentSortKeyType
See OrderKeyType
See InferenceComponentStatusType
See ListInferenceComponentsOutputTypeDef

# list_inference_components method usage example with argument unpacking

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

parent.list_inference_components(**kwargs)

See ListInferenceComponentsInputRequestTypeDef

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

See InferenceExperimentTypeType
See InferenceExperimentStatusType
See SortInferenceExperimentsByType
See SortOrderType
See ListInferenceExperimentsResponseTypeDef

# list_inference_experiments method usage example with argument unpacking

kwargs: ListInferenceExperimentsRequestRequestTypeDef = {  # (1)
    "NameContains": ...,
}

parent.list_inference_experiments(**kwargs)

See ListInferenceExperimentsRequestRequestTypeDef

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

# list_inference_recommendations_job_steps method usage example with argument unpacking

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

parent.list_inference_recommendations_job_steps(**kwargs)

See ListInferenceRecommendationsJobStepsRequestRequestTypeDef

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

# list_inference_recommendations_jobs method usage example with argument unpacking

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

parent.list_inference_recommendations_jobs(**kwargs)

See ListInferenceRecommendationsJobsRequestRequestTypeDef

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

# list_labeling_jobs method usage example with argument unpacking

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

parent.list_labeling_jobs(**kwargs)

See ListLabelingJobsRequestRequestTypeDef

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

# list_labeling_jobs_for_workteam method usage example with argument unpacking

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

parent.list_labeling_jobs_for_workteam(**kwargs)

See ListLabelingJobsForWorkteamRequestRequestTypeDef

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

# list_lineage_groups method usage example with argument unpacking

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

parent.list_lineage_groups(**kwargs)

See ListLineageGroupsRequestRequestTypeDef

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

See TrackingServerStatusType
See SortTrackingServerByType
See SortOrderType
See ListMlflowTrackingServersResponseTypeDef

# list_mlflow_tracking_servers method usage example with argument unpacking

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

parent.list_mlflow_tracking_servers(**kwargs)

See ListMlflowTrackingServersRequestRequestTypeDef

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

See MonitoringJobDefinitionSortKeyType
See SortOrderType
See ListModelBiasJobDefinitionsResponseTypeDef

# list_model_bias_job_definitions method usage example with argument unpacking

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

parent.list_model_bias_job_definitions(**kwargs)

See ListModelBiasJobDefinitionsRequestRequestTypeDef

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

# list_model_card_export_jobs method usage example with argument unpacking

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

parent.list_model_card_export_jobs(**kwargs)

See ListModelCardExportJobsRequestRequestTypeDef

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

See ModelCardStatusType
See ModelCardVersionSortByType
See ModelCardSortOrderType
See ListModelCardVersionsResponseTypeDef

# list_model_card_versions method usage example with argument unpacking

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

parent.list_model_card_versions(**kwargs)

See ListModelCardVersionsRequestRequestTypeDef

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

# list_model_cards method usage example with argument unpacking

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

parent.list_model_cards(**kwargs)

See ListModelCardsRequestRequestTypeDef

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

# list_model_explainability_job_definitions method usage example with argument unpacking

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

parent.list_model_explainability_job_definitions(**kwargs)

See ListModelExplainabilityJobDefinitionsRequestRequestTypeDef

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

# list_model_metadata method usage example with argument unpacking

kwargs: ListModelMetadataRequestRequestTypeDef = {  # (1)
    "SearchExpression": ...,
}

parent.list_model_metadata(**kwargs)

See ListModelMetadataRequestRequestTypeDef

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

# list_model_package_groups method usage example with argument unpacking

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

parent.list_model_package_groups(**kwargs)

See ListModelPackageGroupsInputRequestTypeDef

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

# list_model_packages method usage example with argument unpacking

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

parent.list_model_packages(**kwargs)

See ListModelPackagesInputRequestTypeDef

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

# list_model_quality_job_definitions method usage example with argument unpacking

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

parent.list_model_quality_job_definitions(**kwargs)

See ListModelQualityJobDefinitionsRequestRequestTypeDef

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

# list_models method usage example with argument unpacking

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

parent.list_models(**kwargs)

See ListModelsInputRequestTypeDef

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

See MonitoringAlertHistorySortKeyType
See SortOrderType
See MonitoringAlertStatusType
See ListMonitoringAlertHistoryResponseTypeDef

# list_monitoring_alert_history method usage example with argument unpacking

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

parent.list_monitoring_alert_history(**kwargs)

See ListMonitoringAlertHistoryRequestRequestTypeDef

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

See ListMonitoringAlertsResponseTypeDef

# list_monitoring_alerts method usage example with argument unpacking

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

parent.list_monitoring_alerts(**kwargs)

See ListMonitoringAlertsRequestRequestTypeDef

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

See MonitoringExecutionSortKeyType
See SortOrderType
See ExecutionStatusType
See MonitoringTypeType
See ListMonitoringExecutionsResponseTypeDef

# list_monitoring_executions method usage example with argument unpacking

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

parent.list_monitoring_executions(**kwargs)

See ListMonitoringExecutionsRequestRequestTypeDef

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

See MonitoringScheduleSortKeyType
See SortOrderType
See ScheduleStatusType
See MonitoringTypeType
See ListMonitoringSchedulesResponseTypeDef

# list_monitoring_schedules method usage example with argument unpacking

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

parent.list_monitoring_schedules(**kwargs)

See ListMonitoringSchedulesRequestRequestTypeDef

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

# list_notebook_instance_lifecycle_configs method usage example with argument unpacking

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

parent.list_notebook_instance_lifecycle_configs(**kwargs)

See ListNotebookInstanceLifecycleConfigsInputRequestTypeDef

list_notebook_instances#

Returns a list of the SageMaker 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)
    ...

# list_notebook_instances method usage example with argument unpacking

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

parent.list_notebook_instances(**kwargs)

See ListNotebookInstancesInputRequestTypeDef

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

# list_optimization_jobs method usage example with argument unpacking

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

parent.list_optimization_jobs(**kwargs)

See ListOptimizationJobsRequestRequestTypeDef

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

See SortOrderType
See ListPipelineExecutionStepsResponseTypeDef

# list_pipeline_execution_steps method usage example with argument unpacking

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

parent.list_pipeline_execution_steps(**kwargs)

See ListPipelineExecutionStepsRequestRequestTypeDef

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

See SortPipelineExecutionsByType
See SortOrderType
See ListPipelineExecutionsResponseTypeDef

# list_pipeline_executions method usage example with argument unpacking

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

parent.list_pipeline_executions(**kwargs)

See ListPipelineExecutionsRequestRequestTypeDef

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

See ListPipelineParametersForExecutionResponseTypeDef

# list_pipeline_parameters_for_execution method usage example with argument unpacking

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

parent.list_pipeline_parameters_for_execution(**kwargs)

See ListPipelineParametersForExecutionRequestRequestTypeDef

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

# list_pipelines method usage example with argument unpacking

kwargs: ListPipelinesRequestRequestTypeDef = {  # (1)
    "PipelineNamePrefix": ...,
}

parent.list_pipelines(**kwargs)

See ListPipelinesRequestRequestTypeDef

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

# list_processing_jobs method usage example with argument unpacking

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

parent.list_processing_jobs(**kwargs)

See ListProcessingJobsRequestRequestTypeDef

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

# list_projects method usage example with argument unpacking

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

parent.list_projects(**kwargs)

See ListProjectsInputRequestTypeDef

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

# list_resource_catalogs method usage example with argument unpacking

kwargs: ListResourceCatalogsRequestRequestTypeDef = {  # (1)
    "NameContains": ...,
}

parent.list_resource_catalogs(**kwargs)

See ListResourceCatalogsRequestRequestTypeDef

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

# list_spaces method usage example with argument unpacking

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

parent.list_spaces(**kwargs)

See ListSpacesRequestRequestTypeDef

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

See ListStageDevicesResponseTypeDef

# list_stage_devices method usage example with argument unpacking

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

parent.list_stage_devices(**kwargs)

See ListStageDevicesRequestRequestTypeDef

list_studio_lifecycle_configs#

Lists the Amazon SageMaker 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)
    ...

See StudioLifecycleConfigAppTypeType
See StudioLifecycleConfigSortKeyType
See SortOrderType
See ListStudioLifecycleConfigsResponseTypeDef

# list_studio_lifecycle_configs method usage example with argument unpacking

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

parent.list_studio_lifecycle_configs(**kwargs)

See ListStudioLifecycleConfigsRequestRequestTypeDef

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

See ListSubscribedWorkteamsResponseTypeDef

# list_subscribed_workteams method usage example with argument unpacking

kwargs: ListSubscribedWorkteamsRequestRequestTypeDef = {  # (1)
    "NameContains": ...,
}

parent.list_subscribed_workteams(**kwargs)

See ListSubscribedWorkteamsRequestRequestTypeDef

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

See ListTagsOutputTypeDef

# list_tags method usage example with argument unpacking

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

parent.list_tags(**kwargs)

See ListTagsInputRequestTypeDef

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)
) -> ListTrainingJobsResponseTypeDef:  # (5)
    ...

# list_training_jobs method usage example with argument unpacking

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

parent.list_training_jobs(**kwargs)

See ListTrainingJobsRequestRequestTypeDef

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

See TrainingJobStatusType
See TrainingJobSortByOptionsType
See SortOrderType
See ListTrainingJobsForHyperParameterTuningJobResponseTypeDef

# list_training_jobs_for_hyper_parameter_tuning_job method usage example with argument unpacking

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

parent.list_training_jobs_for_hyper_parameter_tuning_job(**kwargs)

See ListTrainingJobsForHyperParameterTuningJobRequestRequestTypeDef

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

# list_transform_jobs method usage example with argument unpacking

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

parent.list_transform_jobs(**kwargs)

See ListTransformJobsRequestRequestTypeDef

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

# list_trial_components method usage example with argument unpacking

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

parent.list_trial_components(**kwargs)

See ListTrialComponentsRequestRequestTypeDef

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

# list_trials method usage example with argument unpacking

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

parent.list_trials(**kwargs)

See ListTrialsRequestRequestTypeDef

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

# list_user_profiles method usage example with argument unpacking

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

parent.list_user_profiles(**kwargs)

See ListUserProfilesRequestRequestTypeDef

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

# list_workforces method usage example with argument unpacking

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

parent.list_workforces(**kwargs)

See ListWorkforcesRequestRequestTypeDef

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

# list_workteams method usage example with argument unpacking

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

parent.list_workteams(**kwargs)

See ListWorkteamsRequestRequestTypeDef

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

See PutModelPackageGroupPolicyOutputTypeDef

# put_model_package_group_policy method usage example with argument unpacking

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

parent.put_model_package_group_policy(**kwargs)

See PutModelPackageGroupPolicyInputRequestTypeDef

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

# query_lineage method usage example with argument unpacking

kwargs: QueryLineageRequestRequestTypeDef = {  # (1)
    "StartArns": ...,
}

parent.query_lineage(**kwargs)

See QueryLineageRequestRequestTypeDef

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

# register_devices method usage example with argument unpacking

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

parent.register_devices(**kwargs)

See RegisterDevicesRequestRequestTypeDef

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

# render_ui_template method usage example with argument unpacking

kwargs: RenderUiTemplateRequestRequestTypeDef = {  # (1)
    "Task": ...,
    "RoleArn": ...,
}

parent.render_ui_template(**kwargs)

See RenderUiTemplateRequestRequestTypeDef

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

# retry_pipeline_execution method usage example with argument unpacking

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

parent.retry_pipeline_execution(**kwargs)

See RetryPipelineExecutionRequestRequestTypeDef

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

# search method usage example with argument unpacking

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

parent.search(**kwargs)

See SearchRequestRequestTypeDef

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

See SendPipelineExecutionStepFailureResponseTypeDef

# send_pipeline_execution_step_failure method usage example with argument unpacking

kwargs: SendPipelineExecutionStepFailureRequestRequestTypeDef = {  # (1)
    "CallbackToken": ...,
}

parent.send_pipeline_execution_step_failure(**kwargs)

See SendPipelineExecutionStepFailureRequestRequestTypeDef

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

# send_pipeline_execution_step_success method usage example with argument unpacking

kwargs: SendPipelineExecutionStepSuccessRequestRequestTypeDef = {  # (1)
    "CallbackToken": ...,
}

parent.send_pipeline_execution_step_success(**kwargs)

See SendPipelineExecutionStepSuccessRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# start_edge_deployment_stage method usage example with argument unpacking

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

parent.start_edge_deployment_stage(**kwargs)

See StartEdgeDeploymentStageRequestRequestTypeDef

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

See StartInferenceExperimentResponseTypeDef

# start_inference_experiment method usage example with argument unpacking

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

parent.start_inference_experiment(**kwargs)

See StartInferenceExperimentRequestRequestTypeDef

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

See StartMlflowTrackingServerResponseTypeDef

# start_mlflow_tracking_server method usage example with argument unpacking

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

parent.start_mlflow_tracking_server(**kwargs)

See StartMlflowTrackingServerRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# start_monitoring_schedule method usage example with argument unpacking

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

parent.start_monitoring_schedule(**kwargs)

See StartMonitoringScheduleRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# start_notebook_instance method usage example with argument unpacking

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

parent.start_notebook_instance(**kwargs)

See StartNotebookInstanceInputRequestTypeDef

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: SelectiveExecutionConfigTypeDef = ...,  # (3)
) -> StartPipelineExecutionResponseTypeDef:  # (4)
    ...

See ParameterTypeDef
See ParallelismConfigurationTypeDef
See SelectiveExecutionConfigTypeDef
See StartPipelineExecutionResponseTypeDef

# start_pipeline_execution method usage example with argument unpacking

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

parent.start_pipeline_execution(**kwargs)

See StartPipelineExecutionRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# stop_auto_ml_job method usage example with argument unpacking

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

parent.stop_auto_ml_job(**kwargs)

See StopAutoMLJobRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# stop_compilation_job method usage example with argument unpacking

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

parent.stop_compilation_job(**kwargs)

See StopCompilationJobRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# stop_edge_deployment_stage method usage example with argument unpacking

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

parent.stop_edge_deployment_stage(**kwargs)

See StopEdgeDeploymentStageRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# stop_edge_packaging_job method usage example with argument unpacking

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

parent.stop_edge_packaging_job(**kwargs)

See StopEdgePackagingJobRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# stop_hyper_parameter_tuning_job method usage example with argument unpacking

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

parent.stop_hyper_parameter_tuning_job(**kwargs)

See StopHyperParameterTuningJobRequestRequestTypeDef

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

See ModelVariantActionType
See ModelVariantConfigTypeDef
See InferenceExperimentStopDesiredStateType
See StopInferenceExperimentResponseTypeDef

# stop_inference_experiment method usage example with argument unpacking

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

parent.stop_inference_experiment(**kwargs)

See StopInferenceExperimentRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# stop_inference_recommendations_job method usage example with argument unpacking

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

parent.stop_inference_recommendations_job(**kwargs)

See StopInferenceRecommendationsJobRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# stop_labeling_job method usage example with argument unpacking

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

parent.stop_labeling_job(**kwargs)

See StopLabelingJobRequestRequestTypeDef

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

See StopMlflowTrackingServerResponseTypeDef

# stop_mlflow_tracking_server method usage example with argument unpacking

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

parent.stop_mlflow_tracking_server(**kwargs)

See StopMlflowTrackingServerRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# stop_monitoring_schedule method usage example with argument unpacking

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

parent.stop_monitoring_schedule(**kwargs)

See StopMonitoringScheduleRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# stop_notebook_instance method usage example with argument unpacking

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

parent.stop_notebook_instance(**kwargs)

See StopNotebookInstanceInputRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# stop_optimization_job method usage example with argument unpacking

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

parent.stop_optimization_job(**kwargs)

See StopOptimizationJobRequestRequestTypeDef

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

See StopPipelineExecutionResponseTypeDef

# stop_pipeline_execution method usage example with argument unpacking

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

parent.stop_pipeline_execution(**kwargs)

See StopPipelineExecutionRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# stop_processing_job method usage example with argument unpacking

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

parent.stop_processing_job(**kwargs)

See StopProcessingJobRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# stop_training_job method usage example with argument unpacking

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

parent.stop_training_job(**kwargs)

See StopTrainingJobRequestRequestTypeDef

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

See EmptyResponseMetadataTypeDef

# stop_transform_job method usage example with argument unpacking

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

parent.stop_transform_job(**kwargs)

See StopTransformJobRequestRequestTypeDef

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

See ActionStatusType
See UpdateActionResponseTypeDef

# update_action method usage example with argument unpacking

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

parent.update_action(**kwargs)

See UpdateActionRequestRequestTypeDef

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: KernelGatewayImageConfigTypeDef = ...,  # (1)
    JupyterLabAppImageConfig: JupyterLabAppImageConfigTypeDef = ...,  # (2)
    CodeEditorAppImageConfig: CodeEditorAppImageConfigTypeDef = ...,  # (3)
) -> UpdateAppImageConfigResponseTypeDef:  # (4)
    ...

# update_app_image_config method usage example with argument unpacking

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

parent.update_app_image_config(**kwargs)

See UpdateAppImageConfigRequestRequestTypeDef

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

See UpdateArtifactResponseTypeDef

# update_artifact method usage example with argument unpacking

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

parent.update_artifact(**kwargs)

See UpdateArtifactRequestRequestTypeDef

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)
) -> UpdateClusterResponseTypeDef:  # (3)
    ...

# update_cluster method usage example with argument unpacking

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

parent.update_cluster(**kwargs)

See UpdateClusterRequestRequestTypeDef

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,
) -> UpdateClusterSoftwareResponseTypeDef:  # (1)
    ...

See UpdateClusterSoftwareResponseTypeDef

# update_cluster_software method usage example with argument unpacking

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

parent.update_cluster_software(**kwargs)

See UpdateClusterSoftwareRequestRequestTypeDef

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

# update_code_repository method usage example with argument unpacking

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

parent.update_code_repository(**kwargs)

See UpdateCodeRepositoryInputRequestTypeDef

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

See UpdateContextResponseTypeDef

# update_context method usage example with argument unpacking

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

parent.update_context(**kwargs)

See UpdateContextRequestRequestTypeDef

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

See EdgeOutputConfigTypeDef
See EmptyResponseMetadataTypeDef

# update_device_fleet method usage example with argument unpacking

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

parent.update_device_fleet(**kwargs)

See UpdateDeviceFleetRequestRequestTypeDef

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

See DeviceTypeDef
See EmptyResponseMetadataTypeDef

# update_devices method usage example with argument unpacking

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

parent.update_devices(**kwargs)

See UpdateDevicesRequestRequestTypeDef

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: UserSettingsTypeDef = ...,  # (1)
    DomainSettingsForUpdate: DomainSettingsForUpdateTypeDef = ...,  # (2)
    AppSecurityGroupManagement: AppSecurityGroupManagementType = ...,  # (3)
    DefaultSpaceSettings: DefaultSpaceSettingsTypeDef = ...,  # (4)
    SubnetIds: Sequence[str] = ...,
    AppNetworkAccessType: AppNetworkAccessTypeType = ...,  # (5)
    TagPropagation: TagPropagationType = ...,  # (6)
) -> UpdateDomainResponseTypeDef:  # (7)
    ...

# update_domain method usage example with argument unpacking

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

parent.update_domain(**kwargs)

See UpdateDomainRequestRequestTypeDef

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: DeploymentConfigTypeDef = ...,  # (2)
    RetainDeploymentConfig: bool = ...,
) -> UpdateEndpointOutputTypeDef:  # (3)
    ...

# update_endpoint method usage example with argument unpacking

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

parent.update_endpoint(**kwargs)

See UpdateEndpointInputRequestTypeDef

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

# update_endpoint_weights_and_capacities method usage example with argument unpacking

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

parent.update_endpoint_weights_and_capacities(**kwargs)

See UpdateEndpointWeightsAndCapacitiesInputRequestTypeDef

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

See UpdateExperimentResponseTypeDef

# update_experiment method usage example with argument unpacking

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

parent.update_experiment(**kwargs)

See UpdateExperimentRequestRequestTypeDef

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

# update_feature_group method usage example with argument unpacking

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

parent.update_feature_group(**kwargs)

See UpdateFeatureGroupRequestRequestTypeDef

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

See FeatureParameterTypeDef
See EmptyResponseMetadataTypeDef

# update_feature_metadata method usage example with argument unpacking

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

parent.update_feature_metadata(**kwargs)

See UpdateFeatureMetadataRequestRequestTypeDef

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

See UpdateHubResponseTypeDef

# update_hub method usage example with argument unpacking

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

parent.update_hub(**kwargs)

See UpdateHubRequestRequestTypeDef

update_image#

Updates the properties of a SageMaker 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)
    ...

See UpdateImageResponseTypeDef

# update_image method usage example with argument unpacking

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

parent.update_image(**kwargs)

See UpdateImageRequestRequestTypeDef

update_image_version#

Updates the properties of a SageMaker 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)
    ...

# update_image_version method usage example with argument unpacking

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

parent.update_image_version(**kwargs)

See UpdateImageVersionRequestRequestTypeDef

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)
) -> UpdateInferenceComponentOutputTypeDef:  # (3)
    ...

# update_inference_component method usage example with argument unpacking

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

parent.update_inference_component(**kwargs)

See UpdateInferenceComponentInputRequestTypeDef

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

# update_inference_component_runtime_config method usage example with argument unpacking

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

parent.update_inference_component_runtime_config(**kwargs)

See UpdateInferenceComponentRuntimeConfigInputRequestTypeDef

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: InferenceExperimentScheduleTypeDef = ...,  # (1)
    Description: str = ...,
    ModelVariants: Sequence[ModelVariantConfigTypeDef] = ...,  # (2)
    DataStorageConfig: InferenceExperimentDataStorageConfigTypeDef = ...,  # (3)
    ShadowModeConfig: ShadowModeConfigTypeDef = ...,  # (4)
) -> UpdateInferenceExperimentResponseTypeDef:  # (5)
    ...

# update_inference_experiment method usage example with argument unpacking

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

parent.update_inference_experiment(**kwargs)

See UpdateInferenceExperimentRequestRequestTypeDef

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

# update_mlflow_tracking_server method usage example with argument unpacking

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

parent.update_mlflow_tracking_server(**kwargs)

See UpdateMlflowTrackingServerRequestRequestTypeDef

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

See ModelCardStatusType
See UpdateModelCardResponseTypeDef

# update_model_card method usage example with argument unpacking

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

parent.update_model_card(**kwargs)

See UpdateModelCardRequestRequestTypeDef

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[AdditionalInferenceSpecificationDefinitionTypeDef] = ...,  # (2)
    InferenceSpecification: InferenceSpecificationTypeDef = ...,  # (3)
    SourceUri: str = ...,
    ModelCard: ModelPackageModelCardTypeDef = ...,  # (4)
    ModelLifeCycle: ModelLifeCycleTypeDef = ...,  # (5)
    ClientToken: str = ...,
) -> UpdateModelPackageOutputTypeDef:  # (6)
    ...

See ModelApprovalStatusType
See AdditionalInferenceSpecificationDefinitionTypeDef
See InferenceSpecificationTypeDef
See ModelPackageModelCardTypeDef
See ModelLifeCycleTypeDef
See UpdateModelPackageOutputTypeDef

# update_model_package method usage example with argument unpacking

kwargs: UpdateModelPackageInputRequestTypeDef = {  # (1)
    "ModelPackageArn": ...,
}

parent.update_model_package(**kwargs)

See UpdateModelPackageInputRequestTypeDef

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

See UpdateMonitoringAlertResponseTypeDef

# update_monitoring_alert method usage example with argument unpacking

kwargs: UpdateMonitoringAlertRequestRequestTypeDef = {  # (1)
    "MonitoringScheduleName": ...,
    "MonitoringAlertName": ...,
    "DatapointsToAlert": ...,
    "EvaluationPeriod": ...,
}

parent.update_monitoring_alert(**kwargs)

See UpdateMonitoringAlertRequestRequestTypeDef

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: MonitoringScheduleConfigTypeDef,  # (1)
) -> UpdateMonitoringScheduleResponseTypeDef:  # (2)
    ...

# update_monitoring_schedule method usage example with argument unpacking

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

parent.update_monitoring_schedule(**kwargs)

See UpdateMonitoringScheduleRequestRequestTypeDef

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]:
    ...

See InstanceTypeType
See NotebookInstanceAcceleratorTypeType
See RootAccessType
See InstanceMetadataServiceConfigurationTypeDef

# update_notebook_instance method usage example with argument unpacking

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

parent.update_notebook_instance(**kwargs)

See UpdateNotebookInstanceInputRequestTypeDef

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]:
    ...

# update_notebook_instance_lifecycle_config method usage example with argument unpacking

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

parent.update_notebook_instance_lifecycle_config(**kwargs)

See UpdateNotebookInstanceLifecycleConfigInputRequestTypeDef

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

# update_pipeline method usage example with argument unpacking

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

parent.update_pipeline(**kwargs)

See UpdatePipelineRequestRequestTypeDef

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

# update_pipeline_execution method usage example with argument unpacking

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

parent.update_pipeline_execution(**kwargs)

See UpdatePipelineExecutionRequestRequestTypeDef

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)
) -> UpdateProjectOutputTypeDef:  # (3)
    ...

See ServiceCatalogProvisioningUpdateDetailsTypeDef
See TagTypeDef
See UpdateProjectOutputTypeDef

# update_project method usage example with argument unpacking

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

parent.update_project(**kwargs)

See UpdateProjectInputRequestTypeDef

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: SpaceSettingsTypeDef = ...,  # (1)
    SpaceDisplayName: str = ...,
) -> UpdateSpaceResponseTypeDef:  # (2)
    ...

See SpaceSettingsTypeDef
See UpdateSpaceResponseTypeDef

# update_space method usage example with argument unpacking

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

parent.update_space(**kwargs)

See UpdateSpaceRequestRequestTypeDef

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[ProfilerRuleConfigurationTypeDef] = ...,  # (2)
    ResourceConfig: ResourceConfigForUpdateTypeDef = ...,  # (3)
    RemoteDebugConfig: RemoteDebugConfigForUpdateTypeDef = ...,  # (4)
) -> UpdateTrainingJobResponseTypeDef:  # (5)
    ...

# update_training_job method usage example with argument unpacking

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

parent.update_training_job(**kwargs)

See UpdateTrainingJobRequestRequestTypeDef

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

See UpdateTrialResponseTypeDef

# update_trial method usage example with argument unpacking

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

parent.update_trial(**kwargs)

See UpdateTrialRequestRequestTypeDef

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

# update_trial_component method usage example with argument unpacking

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

parent.update_trial_component(**kwargs)

See UpdateTrialComponentRequestRequestTypeDef

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: UserSettingsTypeDef = ...,  # (1)
) -> UpdateUserProfileResponseTypeDef:  # (2)
    ...

See UserSettingsTypeDef
See UpdateUserProfileResponseTypeDef

# update_user_profile method usage example with argument unpacking

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

parent.update_user_profile(**kwargs)

See UpdateUserProfileRequestRequestTypeDef

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: SourceIpConfigTypeDef = ...,  # (1)
    OidcConfig: OidcConfigTypeDef = ...,  # (2)
    WorkforceVpcConfig: WorkforceVpcConfigRequestTypeDef = ...,  # (3)
) -> UpdateWorkforceResponseTypeDef:  # (4)
    ...

# update_workforce method usage example with argument unpacking

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

parent.update_workforce(**kwargs)

See UpdateWorkforceRequestRequestTypeDef

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[MemberDefinitionTypeDef] = ...,  # (1)
    Description: str = ...,
    NotificationConfiguration: NotificationConfigurationTypeDef = ...,  # (2)
    WorkerAccessConfiguration: WorkerAccessConfigurationTypeDef = ...,  # (3)
) -> UpdateWorkteamResponseTypeDef:  # (4)
    ...

# update_workteam method usage example with argument unpacking

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

parent.update_workteam(**kwargs)

See UpdateWorkteamRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("sagemaker").get_paginator method with overloads.

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_clusters") -> ListClustersPaginator
client.get_paginator("list_code_repositories") -> ListCodeRepositoriesPaginator
client.get_paginator("list_compilation_jobs") -> ListCompilationJobsPaginator
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_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_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