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

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.

Usage example

client = boto3.client("sagemaker")

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

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

Method definition

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

1. See AssociationEdgeTypeType
2. See AddAssociationResponseTypeDef

Usage example with kwargs

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

parent.add_association(**kwargs)

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

Method definition

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

1. See TagTypeDef
2. See AddTagsOutputTypeDef

Usage example with kwargs

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

parent.add_tags(**kwargs)

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

Method definition

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

1. See AssociateTrialComponentResponseTypeDef

Usage example with kwargs

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

parent.associate_trial_component(**kwargs)

1. See AssociateTrialComponentRequestRequestTypeDef

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

Method definition

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

1. See BatchDescribeModelPackageOutputTypeDef

Usage example with kwargs

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

parent.batch_describe_model_package(**kwargs)

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

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

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

Method definition

def create_action(
    self,
    *,
    ActionName: str,
    Source: ActionSourceTypeDef,  # (1)
    ActionType: str,
    Description: str = ...,
    Status: ActionStatusType = ...,  # (2)
    Properties: Mapping[str, str] = ...,
    MetadataProperties: MetadataPropertiesTypeDef = ...,  # (3)
    Tags: Sequence[TagTypeDef] = ...,  # (4)
) -> CreateActionResponseTypeDef:  # (5)
    ...

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

Usage example with kwargs

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

parent.create_action(**kwargs)

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

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

1. See TrainingSpecificationTypeDef
2. See InferenceSpecificationTypeDef
3. See AlgorithmValidationSpecificationTypeDef
4. See TagTypeDef
5. See CreateAlgorithmOutputTypeDef

Usage example with kwargs

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

parent.create_algorithm(**kwargs)

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

Method definition

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

1. See AppTypeType
2. See TagTypeDef
3. See ResourceSpecTypeDef
4. See CreateAppResponseTypeDef

Usage example with kwargs

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

parent.create_app(**kwargs)

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

Method definition

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

1. See TagTypeDef
2. See KernelGatewayImageConfigTypeDef
3. See CreateAppImageConfigResponseTypeDef

Usage example with kwargs

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

parent.create_app_image_config(**kwargs)

1. See CreateAppImageConfigRequestRequestTypeDef

create_artifact

Creates an artifact.

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

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

1. See ArtifactSourceTypeDef
2. See MetadataPropertiesTypeDef
3. See TagTypeDef
4. See CreateArtifactResponseTypeDef

Usage example with kwargs

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

parent.create_artifact(**kwargs)

1. See CreateArtifactRequestRequestTypeDef

create_auto_ml_job

Creates an Autopilot job.

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

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

1. See AutoMLChannelTypeDef
2. See AutoMLOutputDataConfigTypeDef
3. See ProblemTypeType
4. See AutoMLJobObjectiveTypeDef
5. See AutoMLJobConfigTypeDef
6. See TagTypeDef
7. See ModelDeployConfigTypeDef
8. See CreateAutoMLJobResponseTypeDef

Usage example with kwargs

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

parent.create_auto_ml_job(**kwargs)

1. See CreateAutoMLJobRequestRequestTypeDef

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

Method definition

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

1. See GitConfigTypeDef
2. See TagTypeDef
3. See CreateCodeRepositoryOutputTypeDef

Usage example with kwargs

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

parent.create_code_repository(**kwargs)

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

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

1. See OutputConfigTypeDef
2. See StoppingConditionTypeDef
3. See InputConfigTypeDef
4. See NeoVpcConfigTypeDef
5. See TagTypeDef
6. See CreateCompilationJobResponseTypeDef

Usage example with kwargs

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

parent.create_compilation_job(**kwargs)

1. See CreateCompilationJobRequestRequestTypeDef

create_context

Creates a context.

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

Method definition

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

1. See ContextSourceTypeDef
2. See TagTypeDef
3. See CreateContextResponseTypeDef

Usage example with kwargs

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

parent.create_context(**kwargs)

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

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

1. See DataQualityAppSpecificationTypeDef
2. See DataQualityJobInputTypeDef
3. See MonitoringOutputConfigTypeDef
4. See MonitoringResourcesTypeDef
5. See DataQualityBaselineConfigTypeDef
6. See MonitoringNetworkConfigTypeDef
7. See MonitoringStoppingConditionTypeDef
8. See TagTypeDef
9. See CreateDataQualityJobDefinitionResponseTypeDef

Usage example with kwargs

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

parent.create_data_quality_job_definition(**kwargs)

1. See CreateDataQualityJobDefinitionRequestRequestTypeDef

create_device_fleet

Creates a device fleet.

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

Method definition

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

1. See EdgeOutputConfigTypeDef
2. See TagTypeDef
3. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.create_device_fleet(**kwargs)

1. See CreateDeviceFleetRequestRequestTypeDef

create_domain

Creates a Domain used by Amazon SageMaker Studio.

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

Method definition

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

1. See AuthModeType
2. See UserSettingsTypeDef
3. See TagTypeDef
4. See AppNetworkAccessTypeType
5. See AppSecurityGroupManagementType
6. See DomainSettingsTypeDef
7. See DefaultSpaceSettingsTypeDef
8. See CreateDomainResponseTypeDef

Usage example with kwargs

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

parent.create_domain(**kwargs)

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

Method definition

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

1. See EdgeDeploymentModelConfigTypeDef
2. See DeploymentStageTypeDef
3. See TagTypeDef
4. See CreateEdgeDeploymentPlanResponseTypeDef

Usage example with kwargs

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

parent.create_edge_deployment_plan(**kwargs)

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

Method definition

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

1. See DeploymentStageTypeDef
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.create_edge_deployment_stage(**kwargs)

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

Method definition

def create_edge_packaging_job(
    self,
    *,
    EdgePackagingJobName: str,
    CompilationJobName: str,
    ModelName: str,
    ModelVersion: str,
    RoleArn: str,
    OutputConfig: EdgeOutputConfigTypeDef,  # (1)
    ResourceKey: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...

1. See EdgeOutputConfigTypeDef
2. See TagTypeDef
3. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.create_edge_packaging_job(**kwargs)

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

Method definition

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

1. See DeploymentConfigTypeDef
2. See TagTypeDef
3. See CreateEndpointOutputTypeDef

Usage example with kwargs

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

parent.create_endpoint(**kwargs)

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

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

1. See ProductionVariantTypeDef
2. See DataCaptureConfigTypeDef
3. See TagTypeDef
4. See AsyncInferenceConfigTypeDef
5. See ExplainerConfigTypeDef
6. See ProductionVariantTypeDef
7. See CreateEndpointConfigOutputTypeDef

Usage example with kwargs

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

parent.create_endpoint_config(**kwargs)

1. See CreateEndpointConfigInputRequestTypeDef

create_experiment

Creates a SageMaker experiment.

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

Method definition

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

1. See TagTypeDef
2. See CreateExperimentResponseTypeDef

Usage example with kwargs

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

parent.create_experiment(**kwargs)

1. See CreateExperimentRequestRequestTypeDef

create_feature_group

Create a new FeatureGroup.

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

Method definition

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

1. See FeatureDefinitionTypeDef
2. See OnlineStoreConfigTypeDef
3. See OfflineStoreConfigTypeDef
4. See TagTypeDef
5. See CreateFeatureGroupResponseTypeDef

Usage example with kwargs

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

parent.create_feature_group(**kwargs)

1. See CreateFeatureGroupRequestRequestTypeDef

create_flow_definition

Creates a flow definition.

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

Method definition

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

1. See HumanLoopConfigTypeDef
2. See FlowDefinitionOutputConfigTypeDef
3. See HumanLoopRequestSourceTypeDef
4. See HumanLoopActivationConfigTypeDef
5. See TagTypeDef
6. See CreateFlowDefinitionResponseTypeDef

Usage example with kwargs

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

parent.create_flow_definition(**kwargs)

1. See CreateFlowDefinitionRequestRequestTypeDef

create_hub

Create a hub.

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

Method definition

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

1. See HubS3StorageConfigTypeDef
2. See TagTypeDef
3. See CreateHubResponseTypeDef

Usage example with kwargs

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

parent.create_hub(**kwargs)

1. See CreateHubRequestRequestTypeDef

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

Method definition

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

1. See UiTemplateTypeDef
2. See TagTypeDef
3. See CreateHumanTaskUiResponseTypeDef

Usage example with kwargs

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

parent.create_human_task_ui(**kwargs)

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

Method definition

def create_hyper_parameter_tuning_job(
    self,
    *,
    HyperParameterTuningJobName: str,
    HyperParameterTuningJobConfig: HyperParameterTuningJobConfigTypeDef,  # (1)
    TrainingJobDefinition: HyperParameterTrainingJobDefinitionTypeDef = ...,  # (2)
    TrainingJobDefinitions: Sequence[HyperParameterTrainingJobDefinitionTypeDef] = ...,  # (3)
    WarmStartConfig: HyperParameterTuningJobWarmStartConfigTypeDef = ...,  # (4)
    Tags: Sequence[TagTypeDef] = ...,  # (5)
) -> CreateHyperParameterTuningJobResponseTypeDef:  # (6)
    ...

1. See HyperParameterTuningJobConfigTypeDef
2. See HyperParameterTrainingJobDefinitionTypeDef
3. See HyperParameterTrainingJobDefinitionTypeDef
4. See HyperParameterTuningJobWarmStartConfigTypeDef
5. See TagTypeDef
6. See CreateHyperParameterTuningJobResponseTypeDef

Usage example with kwargs

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

parent.create_hyper_parameter_tuning_job(**kwargs)

1. See CreateHyperParameterTuningJobRequestRequestTypeDef

create_image

Creates a custom SageMaker image.

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

Method definition

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

1. See TagTypeDef
2. See CreateImageResponseTypeDef

Usage example with kwargs

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

parent.create_image(**kwargs)

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

Method definition

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

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

Usage example with kwargs

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

parent.create_image_version(**kwargs)

1. See CreateImageVersionRequestRequestTypeDef

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

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

1. See InferenceExperimentTypeType
2. See ModelVariantConfigTypeDef
3. See ShadowModeConfigTypeDef
4. See InferenceExperimentScheduleTypeDef
5. See InferenceExperimentDataStorageConfigTypeDef
6. See TagTypeDef
7. See CreateInferenceExperimentResponseTypeDef

Usage example with kwargs

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

parent.create_inference_experiment(**kwargs)

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

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

1. See RecommendationJobTypeType
2. See RecommendationJobInputConfigTypeDef
3. See RecommendationJobStoppingConditionsTypeDef
4. See RecommendationJobOutputConfigTypeDef
5. See TagTypeDef
6. See CreateInferenceRecommendationsJobResponseTypeDef

Usage example with kwargs

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

parent.create_inference_recommendations_job(**kwargs)

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

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

1. See LabelingJobInputConfigTypeDef
2. See LabelingJobOutputConfigTypeDef
3. See HumanTaskConfigTypeDef
4. See LabelingJobStoppingConditionsTypeDef
5. See LabelingJobAlgorithmsConfigTypeDef
6. See TagTypeDef
7. See CreateLabelingJobResponseTypeDef

Usage example with kwargs

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

parent.create_labeling_job(**kwargs)

1. See CreateLabelingJobRequestRequestTypeDef

create_model

Creates a model in SageMaker.

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

Method definition

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

1. See ContainerDefinitionTypeDef
2. See ContainerDefinitionTypeDef
3. See InferenceExecutionConfigTypeDef
4. See TagTypeDef
5. See VpcConfigTypeDef
6. See CreateModelOutputTypeDef

Usage example with kwargs

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

parent.create_model(**kwargs)

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

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

1. See ModelBiasAppSpecificationTypeDef
2. See ModelBiasJobInputTypeDef
3. See MonitoringOutputConfigTypeDef
4. See MonitoringResourcesTypeDef
5. See ModelBiasBaselineConfigTypeDef
6. See MonitoringNetworkConfigTypeDef
7. See MonitoringStoppingConditionTypeDef
8. See TagTypeDef
9. See CreateModelBiasJobDefinitionResponseTypeDef

Usage example with kwargs

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

parent.create_model_bias_job_definition(**kwargs)

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

Method definition

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

1. See ModelCardStatusType
2. See ModelCardSecurityConfigTypeDef
3. See TagTypeDef
4. See CreateModelCardResponseTypeDef

Usage example with kwargs

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

parent.create_model_card(**kwargs)

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

Method definition

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

1. See ModelCardExportOutputConfigTypeDef
2. See CreateModelCardExportJobResponseTypeDef

Usage example with kwargs

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

parent.create_model_card_export_job(**kwargs)

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

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

1. See ModelExplainabilityAppSpecificationTypeDef
2. See ModelExplainabilityJobInputTypeDef
3. See MonitoringOutputConfigTypeDef
4. See MonitoringResourcesTypeDef
5. See ModelExplainabilityBaselineConfigTypeDef
6. See MonitoringNetworkConfigTypeDef
7. See MonitoringStoppingConditionTypeDef
8. See TagTypeDef
9. See CreateModelExplainabilityJobDefinitionResponseTypeDef

Usage example with kwargs

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

parent.create_model_explainability_job_definition(**kwargs)

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

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 = ...,
    CustomerMetadataProperties: Mapping[str, str] = ...,
    DriftCheckBaselines: DriftCheckBaselinesTypeDef = ...,  # (8)
    Domain: str = ...,
    Task: str = ...,
    SamplePayloadUrl: str = ...,
    AdditionalInferenceSpecifications: Sequence[AdditionalInferenceSpecificationDefinitionTypeDef] = ...,  # (9)
) -> CreateModelPackageOutputTypeDef:  # (10)
    ...

1. See InferenceSpecificationTypeDef
2. See ModelPackageValidationSpecificationTypeDef
3. See SourceAlgorithmSpecificationTypeDef
4. See TagTypeDef
5. See ModelApprovalStatusType
6. See MetadataPropertiesTypeDef
7. See ModelMetricsTypeDef
8. See DriftCheckBaselinesTypeDef
9. See AdditionalInferenceSpecificationDefinitionTypeDef
10. See CreateModelPackageOutputTypeDef

Usage example with kwargs

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

parent.create_model_package(**kwargs)

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

Method definition

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

1. See TagTypeDef
2. See CreateModelPackageGroupOutputTypeDef

Usage example with kwargs

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

parent.create_model_package_group(**kwargs)

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

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

1. See ModelQualityAppSpecificationTypeDef
2. See ModelQualityJobInputTypeDef
3. See MonitoringOutputConfigTypeDef
4. See MonitoringResourcesTypeDef
5. See ModelQualityBaselineConfigTypeDef
6. See MonitoringNetworkConfigTypeDef
7. See MonitoringStoppingConditionTypeDef
8. See TagTypeDef
9. See CreateModelQualityJobDefinitionResponseTypeDef

Usage example with kwargs

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

parent.create_model_quality_job_definition(**kwargs)

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

Method definition

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

1. See MonitoringScheduleConfigTypeDef
2. See TagTypeDef
3. See CreateMonitoringScheduleResponseTypeDef

Usage example with kwargs

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

parent.create_monitoring_schedule(**kwargs)

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

Method definition

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

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

Usage example with kwargs

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

parent.create_notebook_instance(**kwargs)

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

Method definition

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

1. See NotebookInstanceLifecycleHookTypeDef
2. See NotebookInstanceLifecycleHookTypeDef
3. See CreateNotebookInstanceLifecycleConfigOutputTypeDef

Usage example with kwargs

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

parent.create_notebook_instance_lifecycle_config(**kwargs)

1. See CreateNotebookInstanceLifecycleConfigInputRequestTypeDef

create_pipeline

Creates a pipeline using a JSON pipeline definition.

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

Method definition

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

1. See PipelineDefinitionS3LocationTypeDef
2. See TagTypeDef
3. See ParallelismConfigurationTypeDef
4. See CreatePipelineResponseTypeDef

Usage example with kwargs

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

parent.create_pipeline(**kwargs)

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

Method definition

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

1. See CreatePresignedDomainUrlResponseTypeDef

Usage example with kwargs

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

parent.create_presigned_domain_url(**kwargs)

1. See CreatePresignedDomainUrlRequestRequestTypeDef

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

Method definition

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

1. See CreatePresignedNotebookInstanceUrlOutputTypeDef

Usage example with kwargs

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

parent.create_presigned_notebook_instance_url(**kwargs)

1. See CreatePresignedNotebookInstanceUrlInputRequestTypeDef

create_processing_job

Creates a processing job.

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

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

1. See ProcessingResourcesTypeDef
2. See AppSpecificationTypeDef
3. See ProcessingInputTypeDef
4. See ProcessingOutputConfigTypeDef
5. See ProcessingStoppingConditionTypeDef
6. See NetworkConfigTypeDef
7. See TagTypeDef
8. See ExperimentConfigTypeDef
9. See CreateProcessingJobResponseTypeDef

Usage example with kwargs

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

parent.create_processing_job(**kwargs)

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

Method definition

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

1. See ServiceCatalogProvisioningDetailsTypeDef
2. See TagTypeDef
3. See CreateProjectOutputTypeDef

Usage example with kwargs

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

parent.create_project(**kwargs)

1. See CreateProjectInputRequestTypeDef

create_space

Creates a space used for real time collaboration in a Domain.

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

Method definition

def create_space(
    self,
    *,
    DomainId: str,
    SpaceName: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    SpaceSettings: SpaceSettingsTypeDef = ...,  # (2)
) -> CreateSpaceResponseTypeDef:  # (3)
    ...

1. See TagTypeDef
2. See SpaceSettingsTypeDef
3. See CreateSpaceResponseTypeDef

Usage example with kwargs

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

parent.create_space(**kwargs)

1. See CreateSpaceRequestRequestTypeDef

create_studio_lifecycle_config

Creates a new Studio Lifecycle Configuration.

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

Method definition

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

1. See StudioLifecycleConfigAppTypeType
2. See TagTypeDef
3. See CreateStudioLifecycleConfigResponseTypeDef

Usage example with kwargs

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

parent.create_studio_lifecycle_config(**kwargs)

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

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[ChannelTypeDef] = ...,  # (5)
    VpcConfig: VpcConfigTypeDef = ...,  # (6)
    Tags: Sequence[TagTypeDef] = ...,  # (7)
    EnableNetworkIsolation: bool = ...,
    EnableInterContainerTrafficEncryption: bool = ...,
    EnableManagedSpotTraining: bool = ...,
    CheckpointConfig: CheckpointConfigTypeDef = ...,  # (8)
    DebugHookConfig: DebugHookConfigTypeDef = ...,  # (9)
    DebugRuleConfigurations: Sequence[DebugRuleConfigurationTypeDef] = ...,  # (10)
    TensorBoardOutputConfig: TensorBoardOutputConfigTypeDef = ...,  # (11)
    ExperimentConfig: ExperimentConfigTypeDef = ...,  # (12)
    ProfilerConfig: ProfilerConfigTypeDef = ...,  # (13)
    ProfilerRuleConfigurations: Sequence[ProfilerRuleConfigurationTypeDef] = ...,  # (14)
    Environment: Mapping[str, str] = ...,
    RetryStrategy: RetryStrategyTypeDef = ...,  # (15)
) -> CreateTrainingJobResponseTypeDef:  # (16)
    ...

1. See AlgorithmSpecificationTypeDef
2. See OutputDataConfigTypeDef
3. See ResourceConfigTypeDef
4. See StoppingConditionTypeDef
5. See ChannelTypeDef
6. See VpcConfigTypeDef
7. See TagTypeDef
8. See CheckpointConfigTypeDef
9. See DebugHookConfigTypeDef
10. See DebugRuleConfigurationTypeDef
11. See TensorBoardOutputConfigTypeDef
12. See ExperimentConfigTypeDef
13. See ProfilerConfigTypeDef
14. See ProfilerRuleConfigurationTypeDef
15. See RetryStrategyTypeDef
16. See CreateTrainingJobResponseTypeDef

Usage example with kwargs

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

parent.create_training_job(**kwargs)

1. See CreateTrainingJobRequestRequestTypeDef

create_transform_job

Starts a transform job.

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

Method definition

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

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

Usage example with kwargs

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

parent.create_transform_job(**kwargs)

1. See CreateTransformJobRequestRequestTypeDef

create_trial

Creates an SageMaker trial.

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

Method definition

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

1. See MetadataPropertiesTypeDef
2. See TagTypeDef
3. See CreateTrialResponseTypeDef

Usage example with kwargs

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

parent.create_trial(**kwargs)

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

Method definition

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

1. See TrialComponentStatusTypeDef
2. See TrialComponentParameterValueTypeDef
3. See TrialComponentArtifactTypeDef
4. See TrialComponentArtifactTypeDef
5. See MetadataPropertiesTypeDef
6. See TagTypeDef
7. See CreateTrialComponentResponseTypeDef

Usage example with kwargs

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

parent.create_trial_component(**kwargs)

1. See CreateTrialComponentRequestRequestTypeDef

create_user_profile

Creates a user profile.

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

Method definition

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

1. See TagTypeDef
2. See UserSettingsTypeDef
3. See CreateUserProfileResponseTypeDef

Usage example with kwargs

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

parent.create_user_profile(**kwargs)

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

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

1. See CognitoConfigTypeDef
2. See OidcConfigTypeDef
3. See SourceIpConfigTypeDef
4. See TagTypeDef
5. See WorkforceVpcConfigRequestTypeDef
6. See CreateWorkforceResponseTypeDef

Usage example with kwargs

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

parent.create_workforce(**kwargs)

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

Method definition

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

1. See MemberDefinitionTypeDef
2. See NotificationConfigurationTypeDef
3. See TagTypeDef
4. See CreateWorkteamResponseTypeDef

Usage example with kwargs

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

parent.create_workteam(**kwargs)

1. See CreateWorkteamRequestRequestTypeDef

delete_action

Deletes an action.

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

Method definition

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

1. See DeleteActionResponseTypeDef

Usage example with kwargs

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

parent.delete_action(**kwargs)

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_algorithm(**kwargs)

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

Method definition

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

1. See AppTypeType
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_app(**kwargs)

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_app_image_config(**kwargs)

1. See DeleteAppImageConfigRequestRequestTypeDef

delete_artifact

Deletes an artifact.

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

Method definition

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

1. See ArtifactSourceTypeDef
2. See DeleteArtifactResponseTypeDef

Usage example with kwargs

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

parent.delete_artifact(**kwargs)

1. See DeleteArtifactRequestRequestTypeDef

delete_association

Deletes an association.

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

Method definition

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

1. See DeleteAssociationResponseTypeDef

Usage example with kwargs

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

parent.delete_association(**kwargs)

1. See DeleteAssociationRequestRequestTypeDef

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_code_repository(**kwargs)

1. See DeleteCodeRepositoryInputRequestTypeDef

delete_context

Deletes an context.

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

Method definition

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

1. See DeleteContextResponseTypeDef

Usage example with kwargs

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

parent.delete_context(**kwargs)

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_data_quality_job_definition(**kwargs)

1. See DeleteDataQualityJobDefinitionRequestRequestTypeDef

delete_device_fleet

Deletes a fleet.

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_device_fleet(**kwargs)

1. See DeleteDeviceFleetRequestRequestTypeDef

delete_domain

Used to delete a domain.

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

Method definition

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

1. See RetentionPolicyTypeDef
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_domain(**kwargs)

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_edge_deployment_plan(**kwargs)

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_edge_deployment_stage(**kwargs)

1. See DeleteEdgeDeploymentStageRequestRequestTypeDef

delete_endpoint

Deletes an endpoint.

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_endpoint(**kwargs)

1. See DeleteEndpointInputRequestTypeDef

delete_endpoint_config

Deletes an endpoint configuration.

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_endpoint_config(**kwargs)

1. See DeleteEndpointConfigInputRequestTypeDef

delete_experiment

Deletes an SageMaker experiment.

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

Method definition

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

1. See DeleteExperimentResponseTypeDef

Usage example with kwargs

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

parent.delete_experiment(**kwargs)

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_feature_group(**kwargs)

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

Method definition

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

Usage example with kwargs

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

parent.delete_flow_definition(**kwargs)

1. See DeleteFlowDefinitionRequestRequestTypeDef

delete_hub

Delete a hub.

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_hub(**kwargs)

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

Method definition

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

1. See HubContentTypeType
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_hub_content(**kwargs)

1. See DeleteHubContentRequestRequestTypeDef

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

Method definition

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

Usage example with kwargs

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

parent.delete_human_task_ui(**kwargs)

1. See DeleteHumanTaskUiRequestRequestTypeDef

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

Method definition

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

Usage example with kwargs

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

parent.delete_image(**kwargs)

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

Method definition

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

Usage example with kwargs

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

parent.delete_image_version(**kwargs)

1. See DeleteImageVersionRequestRequestTypeDef

delete_inference_experiment

Deletes an inference experiment.

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

Method definition

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

1. See DeleteInferenceExperimentResponseTypeDef

Usage example with kwargs

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

parent.delete_inference_experiment(**kwargs)

1. See DeleteInferenceExperimentRequestRequestTypeDef

delete_model

Deletes a model.

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_model(**kwargs)

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_model_bias_job_definition(**kwargs)

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_model_card(**kwargs)

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_model_explainability_job_definition(**kwargs)

1. See DeleteModelExplainabilityJobDefinitionRequestRequestTypeDef

delete_model_package

Deletes a model package.

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_model_package(**kwargs)

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_model_package_group(**kwargs)

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_model_package_group_policy(**kwargs)

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_model_quality_job_definition(**kwargs)

1. See DeleteModelQualityJobDefinitionRequestRequestTypeDef

delete_monitoring_schedule

Deletes a monitoring schedule.

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_monitoring_schedule(**kwargs)

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_notebook_instance(**kwargs)

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_notebook_instance_lifecycle_config(**kwargs)

1. See DeleteNotebookInstanceLifecycleConfigInputRequestTypeDef

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

Method definition

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

1. See DeletePipelineResponseTypeDef

Usage example with kwargs

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

parent.delete_pipeline(**kwargs)

1. See DeletePipelineRequestRequestTypeDef

delete_project

Delete the specified project.

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_project(**kwargs)

1. See DeleteProjectInputRequestTypeDef

delete_space

Used to delete a space.

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_space(**kwargs)

1. See DeleteSpaceRequestRequestTypeDef

delete_studio_lifecycle_config

Deletes the Studio Lifecycle Configuration.

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_studio_lifecycle_config(**kwargs)

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

Method definition

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

Usage example with kwargs

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

parent.delete_tags(**kwargs)

1. See DeleteTagsInputRequestTypeDef

delete_trial

Deletes the specified trial.

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

Method definition

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

1. See DeleteTrialResponseTypeDef

Usage example with kwargs

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

parent.delete_trial(**kwargs)

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

Method definition

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

1. See DeleteTrialComponentResponseTypeDef

Usage example with kwargs

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

parent.delete_trial_component(**kwargs)

1. See DeleteTrialComponentRequestRequestTypeDef

delete_user_profile

Deletes a user profile.

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_user_profile(**kwargs)

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

Method definition

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

Usage example with kwargs

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

parent.delete_workforce(**kwargs)

1. See DeleteWorkforceRequestRequestTypeDef

delete_workteam

Deletes an existing work team.

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

Method definition

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

1. See DeleteWorkteamResponseTypeDef

Usage example with kwargs

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

parent.delete_workteam(**kwargs)

1. See DeleteWorkteamRequestRequestTypeDef

deregister_devices

Deregisters the specified devices.

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.deregister_devices(**kwargs)

1. See DeregisterDevicesRequestRequestTypeDef

describe_action

Describes an action.

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

Method definition

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

1. See DescribeActionResponseTypeDef

Usage example with kwargs

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

parent.describe_action(**kwargs)

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

Method definition

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

1. See DescribeAlgorithmOutputTypeDef

Usage example with kwargs

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

parent.describe_algorithm(**kwargs)

1. See DescribeAlgorithmInputRequestTypeDef

describe_app

Describes the app.

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

Method definition

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

1. See AppTypeType
2. See DescribeAppResponseTypeDef

Usage example with kwargs

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

parent.describe_app(**kwargs)

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

Method definition

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

1. See DescribeAppImageConfigResponseTypeDef

Usage example with kwargs

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

parent.describe_app_image_config(**kwargs)

1. See DescribeAppImageConfigRequestRequestTypeDef

describe_artifact

Describes an artifact.

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

Method definition

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

1. See DescribeArtifactResponseTypeDef

Usage example with kwargs

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

parent.describe_artifact(**kwargs)

1. See DescribeArtifactRequestRequestTypeDef

describe_auto_ml_job

Returns information about an Amazon SageMaker AutoML job.

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

Method definition

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

1. See DescribeAutoMLJobResponseTypeDef

Usage example with kwargs

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

parent.describe_auto_ml_job(**kwargs)

1. See DescribeAutoMLJobRequestRequestTypeDef

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

Method definition

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

1. See DescribeCodeRepositoryOutputTypeDef

Usage example with kwargs

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

parent.describe_code_repository(**kwargs)

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

Method definition

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

1. See DescribeCompilationJobResponseTypeDef

Usage example with kwargs

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

parent.describe_compilation_job(**kwargs)

1. See DescribeCompilationJobRequestRequestTypeDef

describe_context

Describes a context.

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

Method definition

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

1. See DescribeContextResponseTypeDef

Usage example with kwargs

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

parent.describe_context(**kwargs)

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

Method definition

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

1. See DescribeDataQualityJobDefinitionResponseTypeDef

Usage example with kwargs

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

parent.describe_data_quality_job_definition(**kwargs)

1. See DescribeDataQualityJobDefinitionRequestRequestTypeDef

describe_device

Describes the device.

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

Method definition

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

1. See DescribeDeviceResponseTypeDef

Usage example with kwargs

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

parent.describe_device(**kwargs)

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

Method definition

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

1. See DescribeDeviceFleetResponseTypeDef

Usage example with kwargs

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

parent.describe_device_fleet(**kwargs)

1. See DescribeDeviceFleetRequestRequestTypeDef

describe_domain

The description of the domain.

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

Method definition

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

1. See DescribeDomainResponseTypeDef

Usage example with kwargs

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

parent.describe_domain(**kwargs)

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

Method definition

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

1. See DescribeEdgeDeploymentPlanResponseTypeDef

Usage example with kwargs

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

parent.describe_edge_deployment_plan(**kwargs)

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

Method definition

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

1. See DescribeEdgePackagingJobResponseTypeDef

Usage example with kwargs

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

parent.describe_edge_packaging_job(**kwargs)

1. See DescribeEdgePackagingJobRequestRequestTypeDef

describe_endpoint

Returns the description of an endpoint.

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

Method definition

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

1. See DescribeEndpointOutputTypeDef

Usage example with kwargs

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

parent.describe_endpoint(**kwargs)

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

Method definition

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

1. See DescribeEndpointConfigOutputTypeDef

Usage example with kwargs

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

parent.describe_endpoint_config(**kwargs)

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

Method definition

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

1. See DescribeExperimentResponseTypeDef

Usage example with kwargs

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

parent.describe_experiment(**kwargs)

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

Method definition

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

1. See DescribeFeatureGroupResponseTypeDef

Usage example with kwargs

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

parent.describe_feature_group(**kwargs)

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

Method definition

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

1. See DescribeFeatureMetadataResponseTypeDef

Usage example with kwargs

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

parent.describe_feature_metadata(**kwargs)

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

Method definition

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

1. See DescribeFlowDefinitionResponseTypeDef

Usage example with kwargs

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

parent.describe_flow_definition(**kwargs)

1. See DescribeFlowDefinitionRequestRequestTypeDef

describe_hub

Describe a hub.

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

Method definition

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

1. See DescribeHubResponseTypeDef

Usage example with kwargs

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

parent.describe_hub(**kwargs)

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

Method definition

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

1. See HubContentTypeType
2. See DescribeHubContentResponseTypeDef

Usage example with kwargs

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

parent.describe_hub_content(**kwargs)

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

Method definition

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

1. See DescribeHumanTaskUiResponseTypeDef

Usage example with kwargs

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

parent.describe_human_task_ui(**kwargs)

1. See DescribeHumanTaskUiRequestRequestTypeDef

describe_hyper_parameter_tuning_job

Gets a description of a hyperparameter tuning job.

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

Method definition

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

1. See DescribeHyperParameterTuningJobResponseTypeDef

Usage example with kwargs

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

parent.describe_hyper_parameter_tuning_job(**kwargs)

1. See DescribeHyperParameterTuningJobRequestRequestTypeDef

describe_image

Describes a SageMaker image.

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

Method definition

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

1. See DescribeImageResponseTypeDef

Usage example with kwargs

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

parent.describe_image(**kwargs)

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

Method definition

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

1. See DescribeImageVersionResponseTypeDef

Usage example with kwargs

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

parent.describe_image_version(**kwargs)

1. See DescribeImageVersionRequestRequestTypeDef

describe_inference_experiment

Returns details about an inference experiment.

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

Method definition

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

1. See DescribeInferenceExperimentResponseTypeDef

Usage example with kwargs

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

parent.describe_inference_experiment(**kwargs)

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

Method definition

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

1. See DescribeInferenceRecommendationsJobResponseTypeDef

Usage example with kwargs

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

parent.describe_inference_recommendations_job(**kwargs)

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

Method definition

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

1. See DescribeLabelingJobResponseTypeDef

Usage example with kwargs

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

parent.describe_labeling_job(**kwargs)

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

Method definition

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

1. See DescribeLineageGroupResponseTypeDef

Usage example with kwargs

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

parent.describe_lineage_group(**kwargs)

1. See DescribeLineageGroupRequestRequestTypeDef

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

Method definition

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

1. See DescribeModelOutputTypeDef

Usage example with kwargs

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

parent.describe_model(**kwargs)

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

Method definition

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

1. See DescribeModelBiasJobDefinitionResponseTypeDef

Usage example with kwargs

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

parent.describe_model_bias_job_definition(**kwargs)

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

Method definition

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

1. See DescribeModelCardResponseTypeDef

Usage example with kwargs

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

parent.describe_model_card(**kwargs)

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

Method definition

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

1. See DescribeModelCardExportJobResponseTypeDef

Usage example with kwargs

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

parent.describe_model_card_export_job(**kwargs)

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

Method definition

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

1. See DescribeModelExplainabilityJobDefinitionResponseTypeDef

Usage example with kwargs

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

parent.describe_model_explainability_job_definition(**kwargs)

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

Method definition

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

1. See DescribeModelPackageOutputTypeDef

Usage example with kwargs

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

parent.describe_model_package(**kwargs)

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

Method definition

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

1. See DescribeModelPackageGroupOutputTypeDef

Usage example with kwargs

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

parent.describe_model_package_group(**kwargs)

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

Method definition

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

1. See DescribeModelQualityJobDefinitionResponseTypeDef

Usage example with kwargs

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

parent.describe_model_quality_job_definition(**kwargs)

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

Method definition

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

1. See DescribeMonitoringScheduleResponseTypeDef

Usage example with kwargs

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

parent.describe_monitoring_schedule(**kwargs)

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

Method definition

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

1. See DescribeNotebookInstanceOutputTypeDef

Usage example with kwargs

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

parent.describe_notebook_instance(**kwargs)

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

Method definition

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

1. See DescribeNotebookInstanceLifecycleConfigOutputTypeDef

Usage example with kwargs

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

parent.describe_notebook_instance_lifecycle_config(**kwargs)

1. See DescribeNotebookInstanceLifecycleConfigInputRequestTypeDef

describe_pipeline

Describes the details of a pipeline.

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

Method definition

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

1. See DescribePipelineResponseTypeDef

Usage example with kwargs

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

parent.describe_pipeline(**kwargs)

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

Method definition

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

1. See DescribePipelineDefinitionForExecutionResponseTypeDef

Usage example with kwargs

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

parent.describe_pipeline_definition_for_execution(**kwargs)

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

Method definition

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

1. See DescribePipelineExecutionResponseTypeDef

Usage example with kwargs

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

parent.describe_pipeline_execution(**kwargs)

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

Method definition

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

1. See DescribeProcessingJobResponseTypeDef

Usage example with kwargs

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

parent.describe_processing_job(**kwargs)

1. See DescribeProcessingJobRequestRequestTypeDef

describe_project

Describes the details of a project.

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

Method definition

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

1. See DescribeProjectOutputTypeDef

Usage example with kwargs

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

parent.describe_project(**kwargs)

1. See DescribeProjectInputRequestTypeDef

describe_space

Describes the space.

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

Method definition

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

1. See DescribeSpaceResponseTypeDef

Usage example with kwargs

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

parent.describe_space(**kwargs)

1. See DescribeSpaceRequestRequestTypeDef

describe_studio_lifecycle_config

Describes the Studio Lifecycle Configuration.

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

Method definition

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

1. See DescribeStudioLifecycleConfigResponseTypeDef

Usage example with kwargs

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

parent.describe_studio_lifecycle_config(**kwargs)

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

Method definition

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

1. See DescribeSubscribedWorkteamResponseTypeDef

Usage example with kwargs

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

parent.describe_subscribed_workteam(**kwargs)

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

Method definition

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

1. See DescribeTrainingJobResponseTypeDef

Usage example with kwargs

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

parent.describe_training_job(**kwargs)

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

Method definition

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

1. See DescribeTransformJobResponseTypeDef

Usage example with kwargs

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

parent.describe_transform_job(**kwargs)

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

Method definition

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

1. See DescribeTrialResponseTypeDef

Usage example with kwargs

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

parent.describe_trial(**kwargs)

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

Method definition

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

1. See DescribeTrialComponentResponseTypeDef

Usage example with kwargs

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

parent.describe_trial_component(**kwargs)

1. See DescribeTrialComponentRequestRequestTypeDef

describe_user_profile

Describes a user profile.

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

Method definition

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

1. See DescribeUserProfileResponseTypeDef

Usage example with kwargs

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

parent.describe_user_profile(**kwargs)

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

Method definition

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

1. See DescribeWorkforceResponseTypeDef

Usage example with kwargs

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

parent.describe_workforce(**kwargs)

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

Method definition

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

1. See DescribeWorkteamResponseTypeDef

Usage example with kwargs

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

parent.describe_workteam(**kwargs)

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

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

Method definition

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

1. See DisassociateTrialComponentResponseTypeDef

Usage example with kwargs

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

parent.disassociate_trial_component(**kwargs)

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

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

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

Method definition

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

1. See GetDeviceFleetReportResponseTypeDef

Usage example with kwargs

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

parent.get_device_fleet_report(**kwargs)

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

Method definition

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

1. See GetLineageGroupPolicyResponseTypeDef

Usage example with kwargs

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

parent.get_lineage_group_policy(**kwargs)

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

Method definition

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

1. See GetModelPackageGroupPolicyOutputTypeDef

Usage example with kwargs

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

parent.get_model_package_group_policy(**kwargs)

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

Method definition

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

1. See GetSagemakerServicecatalogPortfolioStatusOutputTypeDef

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

Method definition

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

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

Usage example with kwargs

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

parent.get_search_suggestions(**kwargs)

1. See GetSearchSuggestionsRequestRequestTypeDef

import_hub_content

Import hub content.

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

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

1. See HubContentTypeType
2. See TagTypeDef
3. See ImportHubContentResponseTypeDef

Usage example with kwargs

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

parent.import_hub_content(**kwargs)

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

Method definition

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

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

Usage example with kwargs

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

parent.list_actions(**kwargs)

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

Method definition

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

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

Usage example with kwargs

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

parent.list_algorithms(**kwargs)

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

Method definition

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

1. See ListAliasesResponseTypeDef

Usage example with kwargs

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

parent.list_aliases(**kwargs)

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

Method definition

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

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

Usage example with kwargs

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

parent.list_app_image_configs(**kwargs)

1. See ListAppImageConfigsRequestRequestTypeDef

list_apps

Lists apps.

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

Method definition

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

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

Usage example with kwargs

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

parent.list_apps(**kwargs)

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

Method definition

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

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

Usage example with kwargs

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

parent.list_artifacts(**kwargs)

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

Method definition

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

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

Usage example with kwargs

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

parent.list_associations(**kwargs)

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

Method definition

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

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

Usage example with kwargs

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

parent.list_auto_ml_jobs(**kwargs)

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

Method definition

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

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

Usage example with kwargs

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

parent.list_candidates_for_auto_ml_job(**kwargs)

1. See ListCandidatesForAutoMLJobRequestRequestTypeDef

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

Method definition

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

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

Usage example with kwargs

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

parent.list_code_repositories(**kwargs)

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

Method definition

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

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

Usage example with kwargs

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

parent.list_compilation_jobs(**kwargs)

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

Method definition

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

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

Usage example with kwargs

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

parent.list_contexts(**kwargs)

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

Method definition

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

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

Usage example with kwargs

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

parent.list_data_quality_job_definitions(**kwargs)

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

Method definition

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

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

Usage example with kwargs

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

parent.list_device_fleets(**kwargs)

1. See ListDeviceFleetsRequestRequestTypeDef

list_devices

A list of devices.

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

Method definition

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

1. See ListDevicesResponseTypeDef

Usage example with kwargs

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

parent.list_devices(**kwargs)

1. See ListDevicesRequestRequestTypeDef

list_domains

Lists the domains.

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

Method definition

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

1. See ListDomainsResponseTypeDef

Usage example with kwargs

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

parent.list_domains(**kwargs)

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

Method definition

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

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

Usage example with kwargs

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

parent.list_edge_deployment_plans(**kwargs)

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

Method definition

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

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

Usage example with kwargs

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

parent.list_edge_packaging_jobs(**kwargs)

1. See ListEdgePackagingJobsRequestRequestTypeDef

list_endpoint_configs

Lists endpoint configurations.

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

Method definition

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

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

Usage example with kwargs

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

parent.list_endpoint_configs(**kwargs)

1. See ListEndpointConfigsInputRequestTypeDef

list_endpoints

Lists endpoints.

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

Method definition

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

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

Usage example with kwargs

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

parent.list_endpoints(**kwargs)

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

Method definition

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

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

Usage example with kwargs

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

parent.list_experiments(**kwargs)

1. See ListExperimentsRequestRequestTypeDef

list_feature_groups

List FeatureGroup s based on given filter and order.

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

Method definition

def list_feature_groups(
    self,
    *,
    NameContains: str = ...,
    FeatureGroupStatusEquals: FeatureGroupStatusType = ...,  # (1)
    OfflineStoreStatusEquals: OfflineStoreStatusValueType = ...,  # (2)
    CreationTimeAfter: Union[datetime, str] = ...,
    CreationTimeBefore: Union[datetime, str] = ...,
    SortOrder: FeatureGroupSortOrderType = ...,  # (3)
    SortBy: FeatureGroupSortByType = ...,  # (4)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListFeatureGroupsResponseTypeDef:  # (5)
    ...

1. See FeatureGroupStatusType
2. See OfflineStoreStatusValueType
3. See FeatureGroupSortOrderType
4. See FeatureGroupSortByType
5. See ListFeatureGroupsResponseTypeDef

Usage example with kwargs

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

parent.list_feature_groups(**kwargs)

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

Method definition

def list_flow_definitions(
    self,
    *,
    CreationTimeAfter: Union[datetime, str] = ...,
    CreationTimeBefore: Union[datetime, str] = ...,
    SortOrder: SortOrderType = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListFlowDefinitionsResponseTypeDef:  # (2)
    ...

1. See SortOrderType
2. See ListFlowDefinitionsResponseTypeDef

Usage example with kwargs

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

parent.list_flow_definitions(**kwargs)

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

Method definition

def list_hub_content_versions(
    self,
    *,
    HubName: str,
    HubContentType: HubContentTypeType,  # (1)
    HubContentName: str,
    MinVersion: str = ...,
    MaxSchemaVersion: str = ...,
    CreationTimeBefore: Union[datetime, str] = ...,
    CreationTimeAfter: Union[datetime, str] = ...,
    SortBy: HubContentSortByType = ...,  # (2)
    SortOrder: SortOrderType = ...,  # (3)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListHubContentVersionsResponseTypeDef:  # (4)
    ...

1. See HubContentTypeType
2. See HubContentSortByType
3. See SortOrderType
4. See ListHubContentVersionsResponseTypeDef

Usage example with kwargs

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

parent.list_hub_content_versions(**kwargs)

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

Method definition

def list_hub_contents(
    self,
    *,
    HubName: str,
    HubContentType: HubContentTypeType,  # (1)
    NameContains: str = ...,
    MaxSchemaVersion: str = ...,
    CreationTimeBefore: Union[datetime, str] = ...,
    CreationTimeAfter: Union[datetime, str] = ...,
    SortBy: HubContentSortByType = ...,  # (2)
    SortOrder: SortOrderType = ...,  # (3)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListHubContentsResponseTypeDef:  # (4)
    ...

1. See HubContentTypeType
2. See HubContentSortByType
3. See SortOrderType
4. See ListHubContentsResponseTypeDef

Usage example with kwargs

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

parent.list_hub_contents(**kwargs)

1. See ListHubContentsRequestRequestTypeDef

list_hubs

List all existing hubs.

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

Method definition

def list_hubs(
    self,
    *,
    NameContains: str = ...,
    CreationTimeBefore: Union[datetime, str] = ...,
    CreationTimeAfter: Union[datetime, str] = ...,
    LastModifiedTimeBefore: Union[datetime, str] = ...,
    LastModifiedTimeAfter: Union[datetime, str] = ...,
    SortBy: HubSortByType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListHubsResponseTypeDef:  # (3)
    ...

1. See HubSortByType
2. See SortOrderType
3. See ListHubsResponseTypeDef

Usage example with kwargs

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

parent.list_hubs(**kwargs)

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

Method definition

def list_human_task_uis(
    self,
    *,
    CreationTimeAfter: Union[datetime, str] = ...,
    CreationTimeBefore: Union[datetime, str] = ...,
    SortOrder: SortOrderType = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListHumanTaskUisResponseTypeDef:  # (2)
    ...

1. See SortOrderType
2. See ListHumanTaskUisResponseTypeDef

Usage example with kwargs

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

parent.list_human_task_uis(**kwargs)

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

Method definition

def list_hyper_parameter_tuning_jobs(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    SortBy: HyperParameterTuningJobSortByOptionsType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    NameContains: str = ...,
    CreationTimeAfter: Union[datetime, str] = ...,
    CreationTimeBefore: Union[datetime, str] = ...,
    LastModifiedTimeAfter: Union[datetime, str] = ...,
    LastModifiedTimeBefore: Union[datetime, str] = ...,
    StatusEquals: HyperParameterTuningJobStatusType = ...,  # (3)
) -> ListHyperParameterTuningJobsResponseTypeDef:  # (4)
    ...

1. See HyperParameterTuningJobSortByOptionsType
2. See SortOrderType
3. See HyperParameterTuningJobStatusType
4. See ListHyperParameterTuningJobsResponseTypeDef

Usage example with kwargs

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

parent.list_hyper_parameter_tuning_jobs(**kwargs)

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

Method definition

def list_image_versions(
    self,
    *,
    ImageName: str,
    CreationTimeAfter: Union[datetime, str] = ...,
    CreationTimeBefore: Union[datetime, str] = ...,
    LastModifiedTimeAfter: Union[datetime, str] = ...,
    LastModifiedTimeBefore: Union[datetime, str] = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
    SortBy: ImageVersionSortByType = ...,  # (1)
    SortOrder: ImageVersionSortOrderType = ...,  # (2)
) -> ListImageVersionsResponseTypeDef:  # (3)
    ...

1. See ImageVersionSortByType
2. See ImageVersionSortOrderType
3. See ListImageVersionsResponseTypeDef

Usage example with kwargs

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

parent.list_image_versions(**kwargs)

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

Method definition

def list_images(
    self,
    *,
    CreationTimeAfter: Union[datetime, str] = ...,
    CreationTimeBefore: Union[datetime, str] = ...,
    LastModifiedTimeAfter: Union[datetime, str] = ...,
    LastModifiedTimeBefore: Union[datetime, str] = ...,
    MaxResults: int = ...,
    NameContains: str = ...,
    NextToken: str = ...,
    SortBy: ImageSortByType = ...,  # (1)
    SortOrder: ImageSortOrderType = ...,  # (2)
) -> ListImagesResponseTypeDef:  # (3)
    ...

1. See ImageSortByType
2. See ImageSortOrderType
3. See ListImagesResponseTypeDef

Usage example with kwargs

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

parent.list_images(**kwargs)

1. See ListImagesRequestRequestTypeDef

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

Method definition

def list_inference_experiments(
    self,
    *,
    NameContains: str = ...,
    Type: InferenceExperimentTypeType = ...,  # (1)
    StatusEquals: InferenceExperimentStatusType = ...,  # (2)
    CreationTimeAfter: Union[datetime, str] = ...,
    CreationTimeBefore: Union[datetime, str] = ...,
    LastModifiedTimeAfter: Union[datetime, str] = ...,
    LastModifiedTimeBefore: Union[datetime, str] = ...,
    SortBy: SortInferenceExperimentsByType = ...,  # (3)
    SortOrder: SortOrderType = ...,  # (4)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListInferenceExperimentsResponseTypeDef:  # (5)
    ...

1. See InferenceExperimentTypeType
2. See InferenceExperimentStatusType
3. See SortInferenceExperimentsByType
4. See SortOrderType
5. See ListInferenceExperimentsResponseTypeDef

Usage example with kwargs

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

parent.list_inference_experiments(**kwargs)

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

Method definition

def list_inference_recommendations_job_steps(
    self,
    *,
    JobName: str,
    Status: RecommendationJobStatusType = ...,  # (1)
    StepType: RecommendationStepTypeType = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListInferenceRecommendationsJobStepsResponseTypeDef:  # (3)
    ...

1. See RecommendationJobStatusType
2. See RecommendationStepTypeType
3. See ListInferenceRecommendationsJobStepsResponseTypeDef

Usage example with kwargs

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

parent.list_inference_recommendations_job_steps(**kwargs)

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

Method definition

def list_inference_recommendations_jobs(
    self,
    *,
    CreationTimeAfter: Union[datetime, str] = ...,
    CreationTimeBefore: Union[datetime, str] = ...,
    LastModifiedTimeAfter: Union[datetime, str] = ...,
    LastModifiedTimeBefore: Union[datetime, str] = ...,
    NameContains: str = ...,
    StatusEquals: RecommendationJobStatusType = ...,  # (1)
    SortBy: ListInferenceRecommendationsJobsSortByType = ...,  # (2)
    SortOrder: SortOrderType = ...,  # (3)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListInferenceRecommendationsJobsResponseTypeDef:  # (4)
    ...

1. See RecommendationJobStatusType
2. See ListInferenceRecommendationsJobsSortByType
3. See SortOrderType
4. See ListInferenceRecommendationsJobsResponseTypeDef

Usage example with kwargs

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

parent.list_inference_recommendations_jobs(**kwargs)

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

Method definition

def list_labeling_jobs(
    self,
    *,
    CreationTimeAfter: Union[datetime, str] = ...,
    CreationTimeBefore: Union[datetime, str] = ...,
    LastModifiedTimeAfter: Union[datetime, str] = ...,
    LastModifiedTimeBefore: Union[datetime, str] = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
    NameContains: str = ...,
    SortBy: SortByType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    StatusEquals: LabelingJobStatusType = ...,  # (3)
) -> ListLabelingJobsResponseTypeDef:  # (4)
    ...

1. See SortByType
2. See SortOrderType
3. See LabelingJobStatusType
4. See ListLabelingJobsResponseTypeDef

Usage example with kwargs

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

parent.list_labeling_jobs(**kwargs)

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

Method definition

def list_labeling_jobs_for_workteam(
    self,
    *,
    WorkteamArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    CreationTimeAfter: Union[datetime, str] = ...,
    CreationTimeBefore: Union[datetime, str] = ...,
    JobReferenceCodeContains: str = ...,
    SortBy: ListLabelingJobsForWorkteamSortByOptionsType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
) -> ListLabelingJobsForWorkteamResponseTypeDef:  # (3)
    ...

1. See ListLabelingJobsForWorkteamSortByOptionsType
2. See SortOrderType
3. See ListLabelingJobsForWorkteamResponseTypeDef

Usage example with kwargs

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

parent.list_labeling_jobs_for_workteam(**kwargs)

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

Method definition

def list_lineage_groups(
    self,
    *,
    CreatedAfter: Union[datetime, str] = ...,
    CreatedBefore: Union[datetime, str] = ...,
    SortBy: SortLineageGroupsByType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListLineageGroupsResponseTypeDef:  # (3)
    ...

1. See SortLineageGroupsByType
2. See SortOrderType
3. See ListLineageGroupsResponseTypeDef

Usage example with kwargs

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

parent.list_lineage_groups(**kwargs)

1. See ListLineageGroupsRequestRequestTypeDef

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

Method definition

def list_model_bias_job_definitions(
    self,
    *,
    EndpointName: str = ...,
    SortBy: MonitoringJobDefinitionSortKeyType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
    NameContains: str = ...,
    CreationTimeBefore: Union[datetime, str] = ...,
    CreationTimeAfter: Union[datetime, str] = ...,
) -> ListModelBiasJobDefinitionsResponseTypeDef:  # (3)
    ...

1. See MonitoringJobDefinitionSortKeyType
2. See SortOrderType
3. See ListModelBiasJobDefinitionsResponseTypeDef

Usage example with kwargs

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

parent.list_model_bias_job_definitions(**kwargs)

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

Method definition

def list_model_card_export_jobs(
    self,
    *,
    ModelCardName: str,
    ModelCardVersion: int = ...,
    CreationTimeAfter: Union[datetime, str] = ...,
    CreationTimeBefore: Union[datetime, str] = ...,
    ModelCardExportJobNameContains: str = ...,
    StatusEquals: ModelCardExportJobStatusType = ...,  # (1)
    SortBy: ModelCardExportJobSortByType = ...,  # (2)
    SortOrder: ModelCardExportJobSortOrderType = ...,  # (3)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListModelCardExportJobsResponseTypeDef:  # (4)
    ...

1. See ModelCardExportJobStatusType
2. See ModelCardExportJobSortByType
3. See ModelCardExportJobSortOrderType
4. See ListModelCardExportJobsResponseTypeDef

Usage example with kwargs

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

parent.list_model_card_export_jobs(**kwargs)

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

Method definition

def list_model_card_versions(
    self,
    *,
    ModelCardName: str,
    CreationTimeAfter: Union[datetime, str] = ...,
    CreationTimeBefore: Union[datetime, str] = ...,
    MaxResults: int = ...,
    ModelCardStatus: ModelCardStatusType = ...,  # (1)
    NextToken: str = ...,
    SortBy: ModelCardVersionSortByType = ...,  # (2)
    SortOrder: ModelCardSortOrderType = ...,  # (3)
) -> ListModelCardVersionsResponseTypeDef:  # (4)
    ...

1. See ModelCardStatusType
2. See ModelCardVersionSortByType
3. See ModelCardSortOrderType
4. See ListModelCardVersionsResponseTypeDef

Usage example with kwargs

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

parent.list_model_card_versions(**kwargs)

1. See ListModelCardVersionsRequestRequestTypeDef

list_model_cards

List existing model cards.

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

Method definition

def list_model_cards(
    self,
    *,
    CreationTimeAfter: Union[datetime, str] = ...,
    CreationTimeBefore: Union[datetime, str] = ...,
    MaxResults: int = ...,
    NameContains: str = ...,
    ModelCardStatus: ModelCardStatusType = ...,  # (1)
    NextToken: str = ...,
    SortBy: ModelCardSortByType = ...,  # (2)
    SortOrder: ModelCardSortOrderType = ...,  # (3)
) -> ListModelCardsResponseTypeDef:  # (4)
    ...

1. See ModelCardStatusType
2. See ModelCardSortByType
3. See ModelCardSortOrderType
4. See ListModelCardsResponseTypeDef

Usage example with kwargs

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

parent.list_model_cards(**kwargs)

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

Method definition

def list_model_explainability_job_definitions(
    self,
    *,
    EndpointName: str = ...,
    SortBy: MonitoringJobDefinitionSortKeyType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
    NameContains: str = ...,
    CreationTimeBefore: Union[datetime, str] = ...,
    CreationTimeAfter: Union[datetime, str] = ...,
) -> ListModelExplainabilityJobDefinitionsResponseTypeDef:  # (3)
    ...

1. See MonitoringJobDefinitionSortKeyType
2. See SortOrderType
3. See ListModelExplainabilityJobDefinitionsResponseTypeDef

Usage example with kwargs

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

parent.list_model_explainability_job_definitions(**kwargs)

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

Method definition

def list_model_metadata(
    self,
    *,
    SearchExpression: ModelMetadataSearchExpressionTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListModelMetadataResponseTypeDef:  # (2)
    ...

1. See ModelMetadataSearchExpressionTypeDef
2. See ListModelMetadataResponseTypeDef

Usage example with kwargs

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

parent.list_model_metadata(**kwargs)

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

Method definition

def list_model_package_groups(
    self,
    *,
    CreationTimeAfter: Union[datetime, str] = ...,
    CreationTimeBefore: Union[datetime, str] = ...,
    MaxResults: int = ...,
    NameContains: str = ...,
    NextToken: str = ...,
    SortBy: ModelPackageGroupSortByType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
) -> ListModelPackageGroupsOutputTypeDef:  # (3)
    ...

1. See ModelPackageGroupSortByType
2. See SortOrderType
3. See ListModelPackageGroupsOutputTypeDef

Usage example with kwargs

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

parent.list_model_package_groups(**kwargs)

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

Method definition

def list_model_packages(
    self,
    *,
    CreationTimeAfter: Union[datetime, str] = ...,
    CreationTimeBefore: Union[datetime, str] = ...,
    MaxResults: int = ...,
    NameContains: str = ...,
    ModelApprovalStatus: ModelApprovalStatusType = ...,  # (1)
    ModelPackageGroupName: str = ...,
    ModelPackageType: ModelPackageTypeType = ...,  # (2)
    NextToken: str = ...,
    SortBy: ModelPackageSortByType = ...,  # (3)
    SortOrder: SortOrderType = ...,  # (4)
) -> ListModelPackagesOutputTypeDef:  # (5)
    ...

1. See ModelApprovalStatusType
2. See ModelPackageTypeType
3. See ModelPackageSortByType
4. See SortOrderType
5. See ListModelPackagesOutputTypeDef

Usage example with kwargs

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

parent.list_model_packages(**kwargs)

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

Method definition

def list_model_quality_job_definitions(
    self,
    *,
    EndpointName: str = ...,
    SortBy: MonitoringJobDefinitionSortKeyType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
    NameContains: str = ...,
    CreationTimeBefore: Union[datetime, str] = ...,
    CreationTimeAfter: Union[datetime, str] = ...,
) -> ListModelQualityJobDefinitionsResponseTypeDef:  # (3)
    ...

1. See MonitoringJobDefinitionSortKeyType
2. See SortOrderType
3. See ListModelQualityJobDefinitionsResponseTypeDef

Usage example with kwargs

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

parent.list_model_quality_job_definitions(**kwargs)

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

Method definition

def list_models(
    self,
    *,
    SortBy: ModelSortKeyType = ...,  # (1)
    SortOrder: OrderKeyType = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
    NameContains: str = ...,
    CreationTimeBefore: Union[datetime, str] = ...,
    CreationTimeAfter: Union[datetime, str] = ...,
) -> ListModelsOutputTypeDef:  # (3)
    ...

1. See ModelSortKeyType
2. See OrderKeyType
3. See ListModelsOutputTypeDef

Usage example with kwargs

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

parent.list_models(**kwargs)

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

Method definition

def list_monitoring_alert_history(
    self,
    *,
    MonitoringScheduleName: str = ...,
    MonitoringAlertName: str = ...,
    SortBy: MonitoringAlertHistorySortKeyType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
    CreationTimeBefore: Union[datetime, str] = ...,
    CreationTimeAfter: Union[datetime, str] = ...,
    StatusEquals: MonitoringAlertStatusType = ...,  # (3)
) -> ListMonitoringAlertHistoryResponseTypeDef:  # (4)
    ...

1. See MonitoringAlertHistorySortKeyType
2. See SortOrderType
3. See MonitoringAlertStatusType
4. See ListMonitoringAlertHistoryResponseTypeDef

Usage example with kwargs

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

parent.list_monitoring_alert_history(**kwargs)

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

Method definition

def list_monitoring_alerts(
    self,
    *,
    MonitoringScheduleName: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListMonitoringAlertsResponseTypeDef:  # (1)
    ...

1. See ListMonitoringAlertsResponseTypeDef

Usage example with kwargs

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

parent.list_monitoring_alerts(**kwargs)

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

Method definition

def list_monitoring_executions(
    self,
    *,
    MonitoringScheduleName: str = ...,
    EndpointName: str = ...,
    SortBy: MonitoringExecutionSortKeyType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
    ScheduledTimeBefore: Union[datetime, str] = ...,
    ScheduledTimeAfter: Union[datetime, str] = ...,
    CreationTimeBefore: Union[datetime, str] = ...,
    CreationTimeAfter: Union[datetime, str] = ...,
    LastModifiedTimeBefore: Union[datetime, str] = ...,
    LastModifiedTimeAfter: Union[datetime, str] = ...,
    StatusEquals: ExecutionStatusType = ...,  # (3)
    MonitoringJobDefinitionName: str = ...,
    MonitoringTypeEquals: MonitoringTypeType = ...,  # (4)
) -> ListMonitoringExecutionsResponseTypeDef:  # (5)
    ...

1. See MonitoringExecutionSortKeyType
2. See SortOrderType
3. See ExecutionStatusType
4. See MonitoringTypeType
5. See ListMonitoringExecutionsResponseTypeDef

Usage example with kwargs

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

parent.list_monitoring_executions(**kwargs)

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

Method definition

def list_monitoring_schedules(
    self,
    *,
    EndpointName: str = ...,
    SortBy: MonitoringScheduleSortKeyType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
    NameContains: str = ...,
    CreationTimeBefore: Union[datetime, str] = ...,
    CreationTimeAfter: Union[datetime, str] = ...,
    LastModifiedTimeBefore: Union[datetime, str] = ...,
    LastModifiedTimeAfter: Union[datetime, str] = ...,
    StatusEquals: ScheduleStatusType = ...,  # (3)
    MonitoringJobDefinitionName: str = ...,
    MonitoringTypeEquals: MonitoringTypeType = ...,  # (4)
) -> ListMonitoringSchedulesResponseTypeDef:  # (5)
    ...

1. See MonitoringScheduleSortKeyType
2. See SortOrderType
3. See ScheduleStatusType
4. See MonitoringTypeType
5. See ListMonitoringSchedulesResponseTypeDef

Usage example with kwargs

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

parent.list_monitoring_schedules(**kwargs)

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

Method definition

def list_notebook_instance_lifecycle_configs(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    SortBy: NotebookInstanceLifecycleConfigSortKeyType = ...,  # (1)
    SortOrder: NotebookInstanceLifecycleConfigSortOrderType = ...,  # (2)
    NameContains: str = ...,
    CreationTimeBefore: Union[datetime, str] = ...,
    CreationTimeAfter: Union[datetime, str] = ...,
    LastModifiedTimeBefore: Union[datetime, str] = ...,
    LastModifiedTimeAfter: Union[datetime, str] = ...,
) -> ListNotebookInstanceLifecycleConfigsOutputTypeDef:  # (3)
    ...

1. See NotebookInstanceLifecycleConfigSortKeyType
2. See NotebookInstanceLifecycleConfigSortOrderType
3. See ListNotebookInstanceLifecycleConfigsOutputTypeDef

Usage example with kwargs

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

parent.list_notebook_instance_lifecycle_configs(**kwargs)

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

Method definition

def list_notebook_instances(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    SortBy: NotebookInstanceSortKeyType = ...,  # (1)
    SortOrder: NotebookInstanceSortOrderType = ...,  # (2)
    NameContains: str = ...,
    CreationTimeBefore: Union[datetime, str] = ...,
    CreationTimeAfter: Union[datetime, str] = ...,
    LastModifiedTimeBefore: Union[datetime, str] = ...,
    LastModifiedTimeAfter: Union[datetime, str] = ...,
    StatusEquals: NotebookInstanceStatusType = ...,  # (3)
    NotebookInstanceLifecycleConfigNameContains: str = ...,
    DefaultCodeRepositoryContains: str = ...,
    AdditionalCodeRepositoryEquals: str = ...,
) -> ListNotebookInstancesOutputTypeDef:  # (4)
    ...

1. See NotebookInstanceSortKeyType
2. See NotebookInstanceSortOrderType
3. See NotebookInstanceStatusType
4. See ListNotebookInstancesOutputTypeDef

Usage example with kwargs

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

parent.list_notebook_instances(**kwargs)

1. See ListNotebookInstancesInputRequestTypeDef

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

Method definition

def list_pipeline_execution_steps(
    self,
    *,
    PipelineExecutionArn: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
    SortOrder: SortOrderType = ...,  # (1)
) -> ListPipelineExecutionStepsResponseTypeDef:  # (2)
    ...

1. See SortOrderType
2. See ListPipelineExecutionStepsResponseTypeDef

Usage example with kwargs

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

parent.list_pipeline_execution_steps(**kwargs)

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

Method definition

def list_pipeline_executions(
    self,
    *,
    PipelineName: str,
    CreatedAfter: Union[datetime, str] = ...,
    CreatedBefore: Union[datetime, str] = ...,
    SortBy: SortPipelineExecutionsByType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListPipelineExecutionsResponseTypeDef:  # (3)
    ...

1. See SortPipelineExecutionsByType
2. See SortOrderType
3. See ListPipelineExecutionsResponseTypeDef

Usage example with kwargs

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

parent.list_pipeline_executions(**kwargs)

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

Method definition

def list_pipeline_parameters_for_execution(
    self,
    *,
    PipelineExecutionArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListPipelineParametersForExecutionResponseTypeDef:  # (1)
    ...

1. See ListPipelineParametersForExecutionResponseTypeDef

Usage example with kwargs

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

parent.list_pipeline_parameters_for_execution(**kwargs)

1. See ListPipelineParametersForExecutionRequestRequestTypeDef

list_pipelines

Gets a list of pipelines.

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

Method definition

def list_pipelines(
    self,
    *,
    PipelineNamePrefix: str = ...,
    CreatedAfter: Union[datetime, str] = ...,
    CreatedBefore: Union[datetime, str] = ...,
    SortBy: SortPipelinesByType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListPipelinesResponseTypeDef:  # (3)
    ...

1. See SortPipelinesByType
2. See SortOrderType
3. See ListPipelinesResponseTypeDef

Usage example with kwargs

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

parent.list_pipelines(**kwargs)

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

Method definition

def list_processing_jobs(
    self,
    *,
    CreationTimeAfter: Union[datetime, str] = ...,
    CreationTimeBefore: Union[datetime, str] = ...,
    LastModifiedTimeAfter: Union[datetime, str] = ...,
    LastModifiedTimeBefore: Union[datetime, str] = ...,
    NameContains: str = ...,
    StatusEquals: ProcessingJobStatusType = ...,  # (1)
    SortBy: SortByType = ...,  # (2)
    SortOrder: SortOrderType = ...,  # (3)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListProcessingJobsResponseTypeDef:  # (4)
    ...

1. See ProcessingJobStatusType
2. See SortByType
3. See SortOrderType
4. See ListProcessingJobsResponseTypeDef

Usage example with kwargs

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

parent.list_processing_jobs(**kwargs)

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

Method definition

def list_projects(
    self,
    *,
    CreationTimeAfter: Union[datetime, str] = ...,
    CreationTimeBefore: Union[datetime, str] = ...,
    MaxResults: int = ...,
    NameContains: str = ...,
    NextToken: str = ...,
    SortBy: ProjectSortByType = ...,  # (1)
    SortOrder: ProjectSortOrderType = ...,  # (2)
) -> ListProjectsOutputTypeDef:  # (3)
    ...

1. See ProjectSortByType
2. See ProjectSortOrderType
3. See ListProjectsOutputTypeDef

Usage example with kwargs

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

parent.list_projects(**kwargs)

1. See ListProjectsInputRequestTypeDef

list_spaces

Lists spaces.

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

Method definition

def list_spaces(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    SortOrder: SortOrderType = ...,  # (1)
    SortBy: SpaceSortKeyType = ...,  # (2)
    DomainIdEquals: str = ...,
    SpaceNameContains: str = ...,
) -> ListSpacesResponseTypeDef:  # (3)
    ...

1. See SortOrderType
2. See SpaceSortKeyType
3. See ListSpacesResponseTypeDef

Usage example with kwargs

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

parent.list_spaces(**kwargs)

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

Method definition

def list_stage_devices(
    self,
    *,
    EdgeDeploymentPlanName: str,
    StageName: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    ExcludeDevicesDeployedInOtherStage: bool = ...,
) -> ListStageDevicesResponseTypeDef:  # (1)
    ...

1. See ListStageDevicesResponseTypeDef

Usage example with kwargs

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

parent.list_stage_devices(**kwargs)

1. See ListStageDevicesRequestRequestTypeDef

list_studio_lifecycle_configs

Lists the 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

Method definition

def list_studio_lifecycle_configs(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
    NameContains: str = ...,
    AppTypeEquals: StudioLifecycleConfigAppTypeType = ...,  # (1)
    CreationTimeBefore: Union[datetime, str] = ...,
    CreationTimeAfter: Union[datetime, str] = ...,
    ModifiedTimeBefore: Union[datetime, str] = ...,
    ModifiedTimeAfter: Union[datetime, str] = ...,
    SortBy: StudioLifecycleConfigSortKeyType = ...,  # (2)
    SortOrder: SortOrderType = ...,  # (3)
) -> ListStudioLifecycleConfigsResponseTypeDef:  # (4)
    ...

1. See StudioLifecycleConfigAppTypeType
2. See StudioLifecycleConfigSortKeyType
3. See SortOrderType
4. See ListStudioLifecycleConfigsResponseTypeDef

Usage example with kwargs

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

parent.list_studio_lifecycle_configs(**kwargs)

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

Method definition

def list_subscribed_workteams(
    self,
    *,
    NameContains: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListSubscribedWorkteamsResponseTypeDef:  # (1)
    ...

1. See ListSubscribedWorkteamsResponseTypeDef

Usage example with kwargs

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

parent.list_subscribed_workteams(**kwargs)

1. See ListSubscribedWorkteamsRequestRequestTypeDef

list_tags

Returns the tags for the specified SageMaker resource.

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

Method definition

def list_tags(
    self,
    *,
    ResourceArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListTagsOutputTypeDef:  # (1)
    ...

1. See ListTagsOutputTypeDef

Usage example with kwargs

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

parent.list_tags(**kwargs)

1. See ListTagsInputRequestTypeDef

list_training_jobs

Lists training jobs.

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

Method definition

def list_training_jobs(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    CreationTimeAfter: Union[datetime, str] = ...,
    CreationTimeBefore: Union[datetime, str] = ...,
    LastModifiedTimeAfter: Union[datetime, str] = ...,
    LastModifiedTimeBefore: Union[datetime, str] = ...,
    NameContains: str = ...,
    StatusEquals: TrainingJobStatusType = ...,  # (1)
    SortBy: SortByType = ...,  # (2)
    SortOrder: SortOrderType = ...,  # (3)
    WarmPoolStatusEquals: WarmPoolResourceStatusType = ...,  # (4)
) -> ListTrainingJobsResponseTypeDef:  # (5)
    ...

1. See TrainingJobStatusType
2. See SortByType
3. See SortOrderType
4. See WarmPoolResourceStatusType
5. See ListTrainingJobsResponseTypeDef

Usage example with kwargs

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

parent.list_training_jobs(**kwargs)

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

Method definition

def list_training_jobs_for_hyper_parameter_tuning_job(
    self,
    *,
    HyperParameterTuningJobName: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    StatusEquals: TrainingJobStatusType = ...,  # (1)
    SortBy: TrainingJobSortByOptionsType = ...,  # (2)
    SortOrder: SortOrderType = ...,  # (3)
) -> ListTrainingJobsForHyperParameterTuningJobResponseTypeDef:  # (4)
    ...

1. See TrainingJobStatusType
2. See TrainingJobSortByOptionsType
3. See SortOrderType
4. See ListTrainingJobsForHyperParameterTuningJobResponseTypeDef

Usage example with kwargs

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

parent.list_training_jobs_for_hyper_parameter_tuning_job(**kwargs)

1. See ListTrainingJobsForHyperParameterTuningJobRequestRequestTypeDef

list_transform_jobs

Lists transform jobs.

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

Method definition

def list_transform_jobs(
    self,
    *,
    CreationTimeAfter: Union[datetime, str] = ...,
    CreationTimeBefore: Union[datetime, str] = ...,
    LastModifiedTimeAfter: Union[datetime, str] = ...,
    LastModifiedTimeBefore: Union[datetime, str] = ...,
    NameContains: str = ...,
    StatusEquals: TransformJobStatusType = ...,  # (1)
    SortBy: SortByType = ...,  # (2)
    SortOrder: SortOrderType = ...,  # (3)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListTransformJobsResponseTypeDef:  # (4)
    ...

1. See TransformJobStatusType
2. See SortByType
3. See SortOrderType
4. See ListTransformJobsResponseTypeDef

Usage example with kwargs

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

parent.list_transform_jobs(**kwargs)

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

Method definition

def list_trial_components(
    self,
    *,
    ExperimentName: str = ...,
    TrialName: str = ...,
    SourceArn: str = ...,
    CreatedAfter: Union[datetime, str] = ...,
    CreatedBefore: Union[datetime, str] = ...,
    SortBy: SortTrialComponentsByType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListTrialComponentsResponseTypeDef:  # (3)
    ...

1. See SortTrialComponentsByType
2. See SortOrderType
3. See ListTrialComponentsResponseTypeDef

Usage example with kwargs

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

parent.list_trial_components(**kwargs)

1. See ListTrialComponentsRequestRequestTypeDef

list_trials

Lists the trials in your account.

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

Method definition

def list_trials(
    self,
    *,
    ExperimentName: str = ...,
    TrialComponentName: str = ...,
    CreatedAfter: Union[datetime, str] = ...,
    CreatedBefore: Union[datetime, str] = ...,
    SortBy: SortTrialsByType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListTrialsResponseTypeDef:  # (3)
    ...

1. See SortTrialsByType
2. See SortOrderType
3. See ListTrialsResponseTypeDef

Usage example with kwargs

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

parent.list_trials(**kwargs)

1. See ListTrialsRequestRequestTypeDef

list_user_profiles

Lists user profiles.

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

Method definition

def list_user_profiles(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    SortOrder: SortOrderType = ...,  # (1)
    SortBy: UserProfileSortKeyType = ...,  # (2)
    DomainIdEquals: str = ...,
    UserProfileNameContains: str = ...,
) -> ListUserProfilesResponseTypeDef:  # (3)
    ...

1. See SortOrderType
2. See UserProfileSortKeyType
3. See ListUserProfilesResponseTypeDef

Usage example with kwargs

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

parent.list_user_profiles(**kwargs)

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

Method definition

def list_workforces(
    self,
    *,
    SortBy: ListWorkforcesSortByOptionsType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    NameContains: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListWorkforcesResponseTypeDef:  # (3)
    ...

1. See ListWorkforcesSortByOptionsType
2. See SortOrderType
3. See ListWorkforcesResponseTypeDef

Usage example with kwargs

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

parent.list_workforces(**kwargs)

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

Method definition

def list_workteams(
    self,
    *,
    SortBy: ListWorkteamsSortByOptionsType = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    NameContains: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListWorkteamsResponseTypeDef:  # (3)
    ...

1. See ListWorkteamsSortByOptionsType
2. See SortOrderType
3. See ListWorkteamsResponseTypeDef

Usage example with kwargs

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

parent.list_workteams(**kwargs)

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

Method definition

def put_model_package_group_policy(
    self,
    *,
    ModelPackageGroupName: str,
    ResourcePolicy: str,
) -> PutModelPackageGroupPolicyOutputTypeDef:  # (1)
    ...

1. See PutModelPackageGroupPolicyOutputTypeDef

Usage example with kwargs

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

parent.put_model_package_group_policy(**kwargs)

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

Method definition

def query_lineage(
    self,
    *,
    StartArns: Sequence[str] = ...,
    Direction: DirectionType = ...,  # (1)
    IncludeEdges: bool = ...,
    Filters: QueryFiltersTypeDef = ...,  # (2)
    MaxDepth: int = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> QueryLineageResponseTypeDef:  # (3)
    ...

1. See DirectionType
2. See QueryFiltersTypeDef
3. See QueryLineageResponseTypeDef

Usage example with kwargs

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

parent.query_lineage(**kwargs)

1. See QueryLineageRequestRequestTypeDef

register_devices

Register devices.

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

Method definition

def register_devices(
    self,
    *,
    DeviceFleetName: str,
    Devices: Sequence[DeviceTypeDef],  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...

1. See DeviceTypeDef
2. See TagTypeDef
3. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.register_devices(**kwargs)

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

Method definition

def render_ui_template(
    self,
    *,
    Task: RenderableTaskTypeDef,  # (1)
    RoleArn: str,
    UiTemplate: UiTemplateTypeDef = ...,  # (2)
    HumanTaskUiArn: str = ...,
) -> RenderUiTemplateResponseTypeDef:  # (3)
    ...

1. See RenderableTaskTypeDef
2. See UiTemplateTypeDef
3. See RenderUiTemplateResponseTypeDef

Usage example with kwargs

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

parent.render_ui_template(**kwargs)

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

Method definition

def retry_pipeline_execution(
    self,
    *,
    PipelineExecutionArn: str,
    ClientRequestToken: str,
    ParallelismConfiguration: ParallelismConfigurationTypeDef = ...,  # (1)
) -> RetryPipelineExecutionResponseTypeDef:  # (2)
    ...

1. See ParallelismConfigurationTypeDef
2. See RetryPipelineExecutionResponseTypeDef

Usage example with kwargs

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

parent.retry_pipeline_execution(**kwargs)

1. See RetryPipelineExecutionRequestRequestTypeDef

search

Finds SageMaker resources that match a search query.

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

Method definition

def search(
    self,
    *,
    Resource: ResourceTypeType,  # (1)
    SearchExpression: SearchExpressionTypeDef = ...,  # (2)
    SortBy: str = ...,
    SortOrder: SearchSortOrderType = ...,  # (3)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> SearchResponseTypeDef:  # (4)
    ...

1. See ResourceTypeType
2. See SearchExpressionTypeDef
3. See SearchSortOrderType
4. See SearchResponseTypeDef

Usage example with kwargs

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

parent.search(**kwargs)

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

Method definition

def send_pipeline_execution_step_failure(
    self,
    *,
    CallbackToken: str,
    FailureReason: str = ...,
    ClientRequestToken: str = ...,
) -> SendPipelineExecutionStepFailureResponseTypeDef:  # (1)
    ...

1. See SendPipelineExecutionStepFailureResponseTypeDef

Usage example with kwargs

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

parent.send_pipeline_execution_step_failure(**kwargs)

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

Method definition

def send_pipeline_execution_step_success(
    self,
    *,
    CallbackToken: str,
    OutputParameters: Sequence[OutputParameterTypeDef] = ...,  # (1)
    ClientRequestToken: str = ...,
) -> SendPipelineExecutionStepSuccessResponseTypeDef:  # (2)
    ...

1. See OutputParameterTypeDef
2. See SendPipelineExecutionStepSuccessResponseTypeDef

Usage example with kwargs

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

parent.send_pipeline_execution_step_success(**kwargs)

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.start_edge_deployment_stage(**kwargs)

1. See StartEdgeDeploymentStageRequestRequestTypeDef

start_inference_experiment

Starts an inference experiment.

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

Method definition

def start_inference_experiment(
    self,
    *,
    Name: str,
) -> StartInferenceExperimentResponseTypeDef:  # (1)
    ...

1. See StartInferenceExperimentResponseTypeDef

Usage example with kwargs

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

parent.start_inference_experiment(**kwargs)

1. See StartInferenceExperimentRequestRequestTypeDef

start_monitoring_schedule

Starts a previously stopped monitoring schedule.

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.start_monitoring_schedule(**kwargs)

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.start_notebook_instance(**kwargs)

1. See StartNotebookInstanceInputRequestTypeDef

start_pipeline_execution

Starts a pipeline execution.

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

Method definition

def start_pipeline_execution(
    self,
    *,
    PipelineName: str,
    ClientRequestToken: str,
    PipelineExecutionDisplayName: str = ...,
    PipelineParameters: Sequence[ParameterTypeDef] = ...,  # (1)
    PipelineExecutionDescription: str = ...,
    ParallelismConfiguration: ParallelismConfigurationTypeDef = ...,  # (2)
) -> StartPipelineExecutionResponseTypeDef:  # (3)
    ...

1. See ParameterTypeDef
2. See ParallelismConfigurationTypeDef
3. See StartPipelineExecutionResponseTypeDef

Usage example with kwargs

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

parent.start_pipeline_execution(**kwargs)

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

Method definition

def stop_auto_ml_job(
    self,
    *,
    AutoMLJobName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.stop_auto_ml_job(**kwargs)

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.stop_compilation_job(**kwargs)

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.stop_edge_deployment_stage(**kwargs)

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

Method definition

def stop_edge_packaging_job(
    self,
    *,
    EdgePackagingJobName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.stop_edge_packaging_job(**kwargs)

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.stop_hyper_parameter_tuning_job(**kwargs)

1. See StopHyperParameterTuningJobRequestRequestTypeDef

stop_inference_experiment

Stops an inference experiment.

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

Method definition

def stop_inference_experiment(
    self,
    *,
    Name: str,
    ModelVariantActions: Mapping[str, ModelVariantActionType],  # (1)
    DesiredModelVariants: Sequence[ModelVariantConfigTypeDef] = ...,  # (2)
    DesiredState: InferenceExperimentStopDesiredStateType = ...,  # (3)
    Reason: str = ...,
) -> StopInferenceExperimentResponseTypeDef:  # (4)
    ...

1. See ModelVariantActionType
2. See ModelVariantConfigTypeDef
3. See InferenceExperimentStopDesiredStateType
4. See StopInferenceExperimentResponseTypeDef

Usage example with kwargs

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

parent.stop_inference_experiment(**kwargs)

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

Method definition

def stop_inference_recommendations_job(
    self,
    *,
    JobName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.stop_inference_recommendations_job(**kwargs)

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

Method definition

def stop_labeling_job(
    self,
    *,
    LabelingJobName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.stop_labeling_job(**kwargs)

1. See StopLabelingJobRequestRequestTypeDef

stop_monitoring_schedule

Stops a previously started monitoring schedule.

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.stop_monitoring_schedule(**kwargs)

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.stop_notebook_instance(**kwargs)

1. See StopNotebookInstanceInputRequestTypeDef

stop_pipeline_execution

Stops a pipeline execution.

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

Method definition

def stop_pipeline_execution(
    self,
    *,
    PipelineExecutionArn: str,
    ClientRequestToken: str,
) -> StopPipelineExecutionResponseTypeDef:  # (1)
    ...

1. See StopPipelineExecutionResponseTypeDef

Usage example with kwargs

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

parent.stop_pipeline_execution(**kwargs)

1. See StopPipelineExecutionRequestRequestTypeDef

stop_processing_job

Stops a processing job.

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

Method definition

def stop_processing_job(
    self,
    *,
    ProcessingJobName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.stop_processing_job(**kwargs)

1. See StopProcessingJobRequestRequestTypeDef

stop_training_job

Stops a training job.

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

Method definition

def stop_training_job(
    self,
    *,
    TrainingJobName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.stop_training_job(**kwargs)

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

Method definition

def stop_transform_job(
    self,
    *,
    TransformJobName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.stop_transform_job(**kwargs)

1. See StopTransformJobRequestRequestTypeDef

update_action

Updates an action.

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

Method definition

def update_action(
    self,
    *,
    ActionName: str,
    Description: str = ...,
    Status: ActionStatusType = ...,  # (1)
    Properties: Mapping[str, str] = ...,
    PropertiesToRemove: Sequence[str] = ...,
) -> UpdateActionResponseTypeDef:  # (2)
    ...

1. See ActionStatusType
2. See UpdateActionResponseTypeDef

Usage example with kwargs

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

parent.update_action(**kwargs)

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

Method definition

def update_app_image_config(
    self,
    *,
    AppImageConfigName: str,
    KernelGatewayImageConfig: KernelGatewayImageConfigTypeDef = ...,  # (1)
) -> UpdateAppImageConfigResponseTypeDef:  # (2)
    ...

1. See KernelGatewayImageConfigTypeDef
2. See UpdateAppImageConfigResponseTypeDef

Usage example with kwargs

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

parent.update_app_image_config(**kwargs)

1. See UpdateAppImageConfigRequestRequestTypeDef

update_artifact

Updates an artifact.

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

Method definition

def update_artifact(
    self,
    *,
    ArtifactArn: str,
    ArtifactName: str = ...,
    Properties: Mapping[str, str] = ...,
    PropertiesToRemove: Sequence[str] = ...,
) -> UpdateArtifactResponseTypeDef:  # (1)
    ...

1. See UpdateArtifactResponseTypeDef

Usage example with kwargs

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

parent.update_artifact(**kwargs)

1. See UpdateArtifactRequestRequestTypeDef

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

Method definition

def update_code_repository(
    self,
    *,
    CodeRepositoryName: str,
    GitConfig: GitConfigForUpdateTypeDef = ...,  # (1)
) -> UpdateCodeRepositoryOutputTypeDef:  # (2)
    ...

1. See GitConfigForUpdateTypeDef
2. See UpdateCodeRepositoryOutputTypeDef

Usage example with kwargs

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

parent.update_code_repository(**kwargs)

1. See UpdateCodeRepositoryInputRequestTypeDef

update_context

Updates a context.

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

Method definition

def update_context(
    self,
    *,
    ContextName: str,
    Description: str = ...,
    Properties: Mapping[str, str] = ...,
    PropertiesToRemove: Sequence[str] = ...,
) -> UpdateContextResponseTypeDef:  # (1)
    ...

1. See UpdateContextResponseTypeDef

Usage example with kwargs

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

parent.update_context(**kwargs)

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

Method definition

def update_device_fleet(
    self,
    *,
    DeviceFleetName: str,
    OutputConfig: EdgeOutputConfigTypeDef,  # (1)
    RoleArn: str = ...,
    Description: str = ...,
    EnableIotRoleAlias: bool = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See EdgeOutputConfigTypeDef
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.update_device_fleet(**kwargs)

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

Method definition

def update_devices(
    self,
    *,
    DeviceFleetName: str,
    Devices: Sequence[DeviceTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See DeviceTypeDef
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.update_devices(**kwargs)

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

Method definition

def update_domain(
    self,
    *,
    DomainId: str,
    DefaultUserSettings: UserSettingsTypeDef = ...,  # (1)
    DomainSettingsForUpdate: DomainSettingsForUpdateTypeDef = ...,  # (2)
    DefaultSpaceSettings: DefaultSpaceSettingsTypeDef = ...,  # (3)
    AppSecurityGroupManagement: AppSecurityGroupManagementType = ...,  # (4)
) -> UpdateDomainResponseTypeDef:  # (5)
    ...

1. See UserSettingsTypeDef
2. See DomainSettingsForUpdateTypeDef
3. See DefaultSpaceSettingsTypeDef
4. See AppSecurityGroupManagementType
5. See UpdateDomainResponseTypeDef

Usage example with kwargs

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

parent.update_domain(**kwargs)

1. See UpdateDomainRequestRequestTypeDef

update_endpoint

Deploys the new EndpointConfig specified in the request, switches to using newly created endpoint, and then deletes resources provisioned for the endpoint using the previous EndpointConfig (there is no availability loss).

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

Method definition

def update_endpoint(
    self,
    *,
    EndpointName: str,
    EndpointConfigName: str,
    RetainAllVariantProperties: bool = ...,
    ExcludeRetainedVariantProperties: Sequence[VariantPropertyTypeDef] = ...,  # (1)
    DeploymentConfig: DeploymentConfigTypeDef = ...,  # (2)
    RetainDeploymentConfig: bool = ...,
) -> UpdateEndpointOutputTypeDef:  # (3)
    ...

1. See VariantPropertyTypeDef
2. See DeploymentConfigTypeDef
3. See UpdateEndpointOutputTypeDef

Usage example with kwargs

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

parent.update_endpoint(**kwargs)

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

Method definition

def update_endpoint_weights_and_capacities(
    self,
    *,
    EndpointName: str,
    DesiredWeightsAndCapacities: Sequence[DesiredWeightAndCapacityTypeDef],  # (1)
) -> UpdateEndpointWeightsAndCapacitiesOutputTypeDef:  # (2)
    ...

1. See DesiredWeightAndCapacityTypeDef
2. See UpdateEndpointWeightsAndCapacitiesOutputTypeDef

Usage example with kwargs

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

parent.update_endpoint_weights_and_capacities(**kwargs)

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

Method definition

def update_experiment(
    self,
    *,
    ExperimentName: str,
    DisplayName: str = ...,
    Description: str = ...,
) -> UpdateExperimentResponseTypeDef:  # (1)
    ...

1. See UpdateExperimentResponseTypeDef

Usage example with kwargs

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

parent.update_experiment(**kwargs)

1. See UpdateExperimentRequestRequestTypeDef

update_feature_group

Updates the feature group.

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

Method definition

def update_feature_group(
    self,
    *,
    FeatureGroupName: str,
    FeatureAdditions: Sequence[FeatureDefinitionTypeDef] = ...,  # (1)
) -> UpdateFeatureGroupResponseTypeDef:  # (2)
    ...

1. See FeatureDefinitionTypeDef
2. See UpdateFeatureGroupResponseTypeDef

Usage example with kwargs

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

parent.update_feature_group(**kwargs)

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

Method definition

def update_feature_metadata(
    self,
    *,
    FeatureGroupName: str,
    FeatureName: str,
    Description: str = ...,
    ParameterAdditions: Sequence[FeatureParameterTypeDef] = ...,  # (1)
    ParameterRemovals: Sequence[str] = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See FeatureParameterTypeDef
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.update_feature_metadata(**kwargs)

1. See UpdateFeatureMetadataRequestRequestTypeDef

update_hub

Update a hub.

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

Method definition

def update_hub(
    self,
    *,
    HubName: str,
    HubDescription: str = ...,
    HubDisplayName: str = ...,
    HubSearchKeywords: Sequence[str] = ...,
) -> UpdateHubResponseTypeDef:  # (1)
    ...

1. See UpdateHubResponseTypeDef

Usage example with kwargs

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

parent.update_hub(**kwargs)

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

Method definition

def update_image(
    self,
    *,
    ImageName: str,
    DeleteProperties: Sequence[str] = ...,
    Description: str = ...,
    DisplayName: str = ...,
    RoleArn: str = ...,
) -> UpdateImageResponseTypeDef:  # (1)
    ...

1. See UpdateImageResponseTypeDef

Usage example with kwargs

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

parent.update_image(**kwargs)

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

Method definition

def update_image_version(
    self,
    *,
    ImageName: str,
    Alias: str = ...,
    Version: int = ...,
    AliasesToAdd: Sequence[str] = ...,
    AliasesToDelete: Sequence[str] = ...,
    VendorGuidance: VendorGuidanceType = ...,  # (1)
    JobType: JobTypeType = ...,  # (2)
    MLFramework: str = ...,
    ProgrammingLang: str = ...,
    Processor: ProcessorType = ...,  # (3)
    Horovod: bool = ...,
    ReleaseNotes: str = ...,
) -> UpdateImageVersionResponseTypeDef:  # (4)
    ...

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

Usage example with kwargs

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

parent.update_image_version(**kwargs)

1. See UpdateImageVersionRequestRequestTypeDef

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

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

1. See InferenceExperimentScheduleTypeDef
2. See ModelVariantConfigTypeDef
3. See InferenceExperimentDataStorageConfigTypeDef
4. See ShadowModeConfigTypeDef
5. See UpdateInferenceExperimentResponseTypeDef

Usage example with kwargs

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

parent.update_inference_experiment(**kwargs)

1. See UpdateInferenceExperimentRequestRequestTypeDef

update_model_card

Update an Amazon SageMaker Model Card.

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

Method definition

def update_model_card(
    self,
    *,
    ModelCardName: str,
    Content: str = ...,
    ModelCardStatus: ModelCardStatusType = ...,  # (1)
) -> UpdateModelCardResponseTypeDef:  # (2)
    ...

1. See ModelCardStatusType
2. See UpdateModelCardResponseTypeDef

Usage example with kwargs

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

parent.update_model_card(**kwargs)

1. See UpdateModelCardRequestRequestTypeDef

update_model_package

Updates a versioned model.

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

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

1. See ModelApprovalStatusType
2. See AdditionalInferenceSpecificationDefinitionTypeDef
3. See UpdateModelPackageOutputTypeDef

Usage example with kwargs

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

parent.update_model_package(**kwargs)

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

Method definition

def update_monitoring_alert(
    self,
    *,
    MonitoringScheduleName: str,
    MonitoringAlertName: str,
    DatapointsToAlert: int,
    EvaluationPeriod: int,
) -> UpdateMonitoringAlertResponseTypeDef:  # (1)
    ...

1. See UpdateMonitoringAlertResponseTypeDef

Usage example with kwargs

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

parent.update_monitoring_alert(**kwargs)

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

Method definition

def update_monitoring_schedule(
    self,
    *,
    MonitoringScheduleName: str,
    MonitoringScheduleConfig: MonitoringScheduleConfigTypeDef,  # (1)
) -> UpdateMonitoringScheduleResponseTypeDef:  # (2)
    ...

1. See MonitoringScheduleConfigTypeDef
2. See UpdateMonitoringScheduleResponseTypeDef

Usage example with kwargs

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

parent.update_monitoring_schedule(**kwargs)

1. See UpdateMonitoringScheduleRequestRequestTypeDef

update_notebook_instance

Updates a notebook instance.

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

Method definition

def update_notebook_instance(
    self,
    *,
    NotebookInstanceName: str,
    InstanceType: InstanceTypeType = ...,  # (1)
    RoleArn: str = ...,
    LifecycleConfigName: str = ...,
    DisassociateLifecycleConfig: bool = ...,
    VolumeSizeInGB: int = ...,
    DefaultCodeRepository: str = ...,
    AdditionalCodeRepositories: Sequence[str] = ...,
    AcceleratorTypes: Sequence[NotebookInstanceAcceleratorTypeType] = ...,  # (2)
    DisassociateAcceleratorTypes: bool = ...,
    DisassociateDefaultCodeRepository: bool = ...,
    DisassociateAdditionalCodeRepositories: bool = ...,
    RootAccess: RootAccessType = ...,  # (3)
    InstanceMetadataServiceConfiguration: InstanceMetadataServiceConfigurationTypeDef = ...,  # (4)
) -> Dict[str, Any]:
    ...

1. See InstanceTypeType
2. See NotebookInstanceAcceleratorTypeType
3. See RootAccessType
4. See InstanceMetadataServiceConfigurationTypeDef

Usage example with kwargs

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

parent.update_notebook_instance(**kwargs)

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

Method definition

def update_notebook_instance_lifecycle_config(
    self,
    *,
    NotebookInstanceLifecycleConfigName: str,
    OnCreate: Sequence[NotebookInstanceLifecycleHookTypeDef] = ...,  # (1)
    OnStart: Sequence[NotebookInstanceLifecycleHookTypeDef] = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See NotebookInstanceLifecycleHookTypeDef
2. See NotebookInstanceLifecycleHookTypeDef

Usage example with kwargs

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

parent.update_notebook_instance_lifecycle_config(**kwargs)

1. See UpdateNotebookInstanceLifecycleConfigInputRequestTypeDef

update_pipeline

Updates a pipeline.

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

Method definition

def update_pipeline(
    self,
    *,
    PipelineName: str,
    PipelineDisplayName: str = ...,
    PipelineDefinition: str = ...,
    PipelineDefinitionS3Location: PipelineDefinitionS3LocationTypeDef = ...,  # (1)
    PipelineDescription: str = ...,
    RoleArn: str = ...,
    ParallelismConfiguration: ParallelismConfigurationTypeDef = ...,  # (2)
) -> UpdatePipelineResponseTypeDef:  # (3)
    ...

1. See PipelineDefinitionS3LocationTypeDef
2. See ParallelismConfigurationTypeDef
3. See UpdatePipelineResponseTypeDef

Usage example with kwargs

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

parent.update_pipeline(**kwargs)

1. See UpdatePipelineRequestRequestTypeDef

update_pipeline_execution

Updates a pipeline execution.

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

Method definition

def update_pipeline_execution(
    self,
    *,
    PipelineExecutionArn: str,
    PipelineExecutionDescription: str = ...,
    PipelineExecutionDisplayName: str = ...,
    ParallelismConfiguration: ParallelismConfigurationTypeDef = ...,  # (1)
) -> UpdatePipelineExecutionResponseTypeDef:  # (2)
    ...

1. See ParallelismConfigurationTypeDef
2. See UpdatePipelineExecutionResponseTypeDef

Usage example with kwargs

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

parent.update_pipeline_execution(**kwargs)

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

Method definition

def update_project(
    self,
    *,
    ProjectName: str,
    ProjectDescription: str = ...,
    ServiceCatalogProvisioningUpdateDetails: ServiceCatalogProvisioningUpdateDetailsTypeDef = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> UpdateProjectOutputTypeDef:  # (3)
    ...

1. See ServiceCatalogProvisioningUpdateDetailsTypeDef
2. See TagTypeDef
3. See UpdateProjectOutputTypeDef

Usage example with kwargs

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

parent.update_project(**kwargs)

1. See UpdateProjectInputRequestTypeDef

update_space

Updates the settings of a space.

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

Method definition

def update_space(
    self,
    *,
    DomainId: str,
    SpaceName: str,
    SpaceSettings: SpaceSettingsTypeDef = ...,  # (1)
) -> UpdateSpaceResponseTypeDef:  # (2)
    ...

1. See SpaceSettingsTypeDef
2. See UpdateSpaceResponseTypeDef

Usage example with kwargs

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

parent.update_space(**kwargs)

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

Method definition

def update_training_job(
    self,
    *,
    TrainingJobName: str,
    ProfilerConfig: ProfilerConfigForUpdateTypeDef = ...,  # (1)
    ProfilerRuleConfigurations: Sequence[ProfilerRuleConfigurationTypeDef] = ...,  # (2)
    ResourceConfig: ResourceConfigForUpdateTypeDef = ...,  # (3)
) -> UpdateTrainingJobResponseTypeDef:  # (4)
    ...

1. See ProfilerConfigForUpdateTypeDef
2. See ProfilerRuleConfigurationTypeDef
3. See ResourceConfigForUpdateTypeDef
4. See UpdateTrainingJobResponseTypeDef

Usage example with kwargs

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

parent.update_training_job(**kwargs)

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

Method definition

def update_trial(
    self,
    *,
    TrialName: str,
    DisplayName: str = ...,
) -> UpdateTrialResponseTypeDef:  # (1)
    ...

1. See UpdateTrialResponseTypeDef

Usage example with kwargs

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

parent.update_trial(**kwargs)

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

Method definition

def update_trial_component(
    self,
    *,
    TrialComponentName: str,
    DisplayName: str = ...,
    Status: TrialComponentStatusTypeDef = ...,  # (1)
    StartTime: Union[datetime, str] = ...,
    EndTime: Union[datetime, str] = ...,
    Parameters: Mapping[str, TrialComponentParameterValueTypeDef] = ...,  # (2)
    ParametersToRemove: Sequence[str] = ...,
    InputArtifacts: Mapping[str, TrialComponentArtifactTypeDef] = ...,  # (3)
    InputArtifactsToRemove: Sequence[str] = ...,
    OutputArtifacts: Mapping[str, TrialComponentArtifactTypeDef] = ...,  # (3)
    OutputArtifactsToRemove: Sequence[str] = ...,
) -> UpdateTrialComponentResponseTypeDef:  # (5)
    ...

1. See TrialComponentStatusTypeDef
2. See TrialComponentParameterValueTypeDef
3. See TrialComponentArtifactTypeDef
4. See TrialComponentArtifactTypeDef
5. See UpdateTrialComponentResponseTypeDef

Usage example with kwargs

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

parent.update_trial_component(**kwargs)

1. See UpdateTrialComponentRequestRequestTypeDef

update_user_profile

Updates a user profile.

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

Method definition

def update_user_profile(
    self,
    *,
    DomainId: str,
    UserProfileName: str,
    UserSettings: UserSettingsTypeDef = ...,  # (1)
) -> UpdateUserProfileResponseTypeDef:  # (2)
    ...

1. See UserSettingsTypeDef
2. See UpdateUserProfileResponseTypeDef

Usage example with kwargs

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

parent.update_user_profile(**kwargs)

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

Method definition

def update_workforce(
    self,
    *,
    WorkforceName: str,
    SourceIpConfig: SourceIpConfigTypeDef = ...,  # (1)
    OidcConfig: OidcConfigTypeDef = ...,  # (2)
    WorkforceVpcConfig: WorkforceVpcConfigRequestTypeDef = ...,  # (3)
) -> UpdateWorkforceResponseTypeDef:  # (4)
    ...

1. See SourceIpConfigTypeDef
2. See OidcConfigTypeDef
3. See WorkforceVpcConfigRequestTypeDef
4. See UpdateWorkforceResponseTypeDef

Usage example with kwargs

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

parent.update_workforce(**kwargs)

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

Method definition

def update_workteam(
    self,
    *,
    WorkteamName: str,
    MemberDefinitions: Sequence[MemberDefinitionTypeDef] = ...,  # (1)
    Description: str = ...,
    NotificationConfiguration: NotificationConfigurationTypeDef = ...,  # (2)
) -> UpdateWorkteamResponseTypeDef:  # (3)
    ...

1. See MemberDefinitionTypeDef
2. See NotificationConfigurationTypeDef
3. See UpdateWorkteamResponseTypeDef

Usage example with kwargs

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

parent.update_workteam(**kwargs)

1. 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_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_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") -> ListLabelingJobsPaginator
• client.get_paginator("list_labeling_jobs_for_workteam") -> ListLabelingJobsForWorkteamPaginator
• client.get_paginator("list_lineage_groups") -> ListLineageGroupsPaginator
• 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_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_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") -> ListTrainingJobsPaginator
• client.get_paginator("list_training_jobs_for_hyper_parameter_tuning_job") -> ListTrainingJobsForHyperParameterTuningJobPaginator
• 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