Api-Sagemaker-2017-07-24 - AWS SDK for PHP V3

Client: Aws\SageMaker\SageMakerClient

Service ID: sagemaker

Version: 2017-07-24

This page describes the parameters and results for the operations of the Amazon SageMaker Service (2017-07-24), and shows how to use the Aws\SageMaker\SageMakerClient object to call the described operations. This documentation is specific to the 2017-07-24 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AddAssociation ( array $params = [] ): Creates an association between the source and the destination.
AddTags ( array $params = [] ): Adds or overwrites one or more tags for the specified SageMaker resource.
AssociateTrialComponent ( array $params = [] ): Associates a trial component with a trial.
AttachClusterNodeNetworkInterface ( array $params = [] ): Attaches an elastic network interface (ENI) to a node in a HyperPod cluster.
AttachClusterNodeVolume ( array $params = [] ): Attaches your Amazon Elastic Block Store (Amazon EBS) volume to a node in your EKS orchestrated HyperPod cluster.
BatchAddClusterNodes ( array $params = [] ): Adds nodes to a HyperPod cluster by incrementing the target count for one or more instance groups.
BatchDeleteClusterNodes ( array $params = [] ): Deletes specific nodes within a SageMaker HyperPod cluster.
BatchDescribeModelPackage ( array $params = [] ): This action batch describes a list of versioned model packages
BatchRebootClusterNodes ( array $params = [] ): Reboots specific nodes within a SageMaker HyperPod cluster using a soft recovery mechanism.
BatchReplaceClusterNodes ( array $params = [] ): Replaces specific nodes within a SageMaker HyperPod cluster with new hardware.
CreateAIBenchmarkJob ( array $params = [] ): Creates a benchmark job that runs performance benchmarks against inference infrastructure using a predefined AI workload configuration.
CreateAIRecommendationJob ( array $params = [] ): Creates a recommendation job that generates intelligent optimization recommendations for generative AI inference deployments.
CreateAIWorkloadConfig ( array $params = [] ): Creates a reusable AI workload configuration that defines datasets, data sources, and benchmark tool settings for consistent performance testing of generative AI inference deployments on Amazon SageMaker AI.
CreateAction ( array $params = [] ): Creates an action.
CreateAlgorithm ( array $params = [] ): Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace.
CreateApp ( array $params = [] ): Creates a running app for the specified UserProfile.
CreateAppImageConfig ( array $params = [] ): Creates a configuration for running a SageMaker AI image as a KernelGateway app.
CreateArtifact ( array $params = [] ): Creates an artifact.
CreateAutoMLJob ( array $params = [] ): Creates an Autopilot job also referred to as Autopilot experiment or AutoML job.
CreateAutoMLJobV2 ( array $params = [] ): Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2.
CreateCluster ( array $params = [] ): Creates an Amazon SageMaker HyperPod cluster.
CreateClusterSchedulerConfig ( array $params = [] ): Create cluster policy configuration.
CreateCodeRepository ( array $params = [] ): Creates a Git repository as a resource in your SageMaker AI account.
CreateCompilationJob ( array $params = [] ): Starts a model compilation job.
CreateComputeQuota ( array $params = [] ): Create compute allocation definition.
CreateContext ( array $params = [] ): Creates a context.
CreateDataQualityJobDefinition ( array $params = [] ): Creates a definition for a job that monitors data quality and drift.
CreateDeviceFleet ( array $params = [] ): Creates a device fleet.
CreateDomain ( array $params = [] ): Creates a Domain.
CreateEdgeDeploymentPlan ( array $params = [] ): Creates an edge deployment plan, consisting of multiple stages.
CreateEdgeDeploymentStage ( array $params = [] ): Creates a new stage in an existing edge deployment plan.
CreateEdgePackagingJob ( array $params = [] ): Starts a SageMaker Edge Manager model packaging job.
CreateEndpoint ( array $params = [] ): Creates an endpoint using the endpoint configuration specified in the request.
CreateEndpointConfig ( array $params = [] ): Creates an endpoint configuration that SageMaker hosting services uses to deploy models.
CreateExperiment ( array $params = [] ): Creates a SageMaker experiment.
CreateFeatureGroup ( array $params = [] ): Create a new FeatureGroup.
CreateFlowDefinition ( array $params = [] ): Creates a flow definition.
CreateHub ( array $params = [] ): Create a hub.
CreateHubContentPresignedUrls ( array $params = [] ): Creates presigned URLs for accessing hub content artifacts.
CreateHubContentReference ( array $params = [] ): Create a hub content reference in order to add a model in the JumpStart public hub to a private hub.
CreateHumanTaskUi ( array $params = [] ): Defines the settings you will use for the human review workflow user interface.
CreateHyperParameterTuningJob ( array $params = [] ): Starts a hyperparameter tuning job.
CreateImage ( array $params = [] ): Creates a custom SageMaker AI image.
CreateImageVersion ( array $params = [] ): Creates a version of the SageMaker AI image specified by ImageName.
CreateInferenceComponent ( array $params = [] ): Creates an inference component, which is a SageMaker AI hosting object that you can use to deploy a model to an endpoint.
CreateInferenceExperiment ( array $params = [] ): Creates an inference experiment using the configurations specified in the request.
CreateInferenceRecommendationsJob ( array $params = [] ): Starts a recommendation job.
CreateJob ( array $params = [] ): Creates a model customization job in Amazon SageMaker.
CreateLabelingJob ( array $params = [] ): Creates a job that uses workers to label the data objects in your input dataset.
CreateMlflowApp ( array $params = [] ): Creates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact store.
CreateMlflowTrackingServer ( array $params = [] ): Creates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact store.
CreateModel ( array $params = [] ): Creates a model in SageMaker.
CreateModelBiasJobDefinition ( array $params = [] ): Creates the definition for a model bias job.
CreateModelCard ( array $params = [] ): Creates an Amazon SageMaker Model Card.
CreateModelCardExportJob ( array $params = [] ): Creates an Amazon SageMaker Model Card export job.
CreateModelExplainabilityJobDefinition ( array $params = [] ): Creates the definition for a model explainability job.
CreateModelPackage ( array $params = [] ): 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.
CreateModelPackageGroup ( array $params = [] ): Creates a model group.
CreateModelQualityJobDefinition ( array $params = [] ): Creates a definition for a job that monitors model quality and drift.
CreateMonitoringSchedule ( array $params = [] ): Creates a schedule that regularly starts Amazon SageMaker AI Processing Jobs to monitor the data captured for an Amazon SageMaker AI Endpoint.
CreateNotebookInstance ( array $params = [] ): Creates an SageMaker AI notebook instance.
CreateNotebookInstanceLifecycleConfig ( array $params = [] ): Creates a lifecycle configuration that you can associate with a notebook instance.
CreateOptimizationJob ( array $params = [] ): Creates a job that optimizes a model for inference performance.
CreatePartnerApp ( array $params = [] ): Creates an Amazon SageMaker Partner AI App.
CreatePartnerAppPresignedUrl ( array $params = [] ): Creates a presigned URL to access an Amazon SageMaker Partner AI App.
CreatePipeline ( array $params = [] ): Creates a pipeline using a JSON pipeline definition.
CreatePresignedDomainUrl ( array $params = [] ): Creates a URL for a specified UserProfile in a Domain.
CreatePresignedMlflowAppUrl ( array $params = [] ): Returns a presigned URL that you can use to connect to the MLflow UI attached to your MLflow App.
CreatePresignedMlflowTrackingServerUrl ( array $params = [] ): Returns a presigned URL that you can use to connect to the MLflow UI attached to your tracking server.
CreatePresignedNotebookInstanceUrl ( array $params = [] ): Returns a URL that you can use to connect to the Jupyter server from a notebook instance.
CreateProcessingJob ( array $params = [] ): Creates a processing job.
CreateProject ( array $params = [] ): 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.
CreateSpace ( array $params = [] ): Creates a private space or a space used for real time collaboration in a domain.
CreateStudioLifecycleConfig ( array $params = [] ): Creates a new Amazon SageMaker AI Studio Lifecycle Configuration.
CreateTrainingJob ( array $params = [] ): Starts a model training job.
CreateTrainingPlan ( array $params = [] ): Creates a new training plan in SageMaker to reserve compute capacity.
CreateTransformJob ( array $params = [] ): Starts a transform job.
CreateTrial ( array $params = [] ): Creates an SageMaker trial.
CreateTrialComponent ( array $params = [] ): Creates a trial component, which is a stage of a machine learning trial.
CreateUserProfile ( array $params = [] ): Creates a user profile.
CreateWorkforce ( array $params = [] ): Use this operation to create a workforce.
CreateWorkteam ( array $params = [] ): Creates a new work team for labeling your data.
DeleteAIBenchmarkJob ( array $params = [] ): Deletes the specified AI benchmark job.
DeleteAIRecommendationJob ( array $params = [] ): Deletes the specified AI recommendation job.
DeleteAIWorkloadConfig ( array $params = [] ): Deletes the specified AI workload configuration.
DeleteAction ( array $params = [] ): Deletes an action.
DeleteAlgorithm ( array $params = [] ): Removes the specified algorithm from your account.
DeleteApp ( array $params = [] ): Used to stop and delete an app.
DeleteAppImageConfig ( array $params = [] ): Deletes an AppImageConfig.
DeleteArtifact ( array $params = [] ): Deletes an artifact.
DeleteAssociation ( array $params = [] ): Deletes an association.
DeleteCluster ( array $params = [] ): Delete a SageMaker HyperPod cluster.
DeleteClusterSchedulerConfig ( array $params = [] ): Deletes the cluster policy of the cluster.
DeleteCodeRepository ( array $params = [] ): Deletes the specified Git repository from your account.
DeleteCompilationJob ( array $params = [] ): Deletes the specified compilation job.
DeleteComputeQuota ( array $params = [] ): Deletes the compute allocation from the cluster.
DeleteContext ( array $params = [] ): Deletes an context.
DeleteDataQualityJobDefinition ( array $params = [] ): Deletes a data quality monitoring job definition.
DeleteDeviceFleet ( array $params = [] ): Deletes a fleet.
DeleteDomain ( array $params = [] ): Used to delete a domain.
DeleteEdgeDeploymentPlan ( array $params = [] ): 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.
DeleteEdgeDeploymentStage ( array $params = [] ): Delete a stage in an edge deployment plan if (and only if) the stage is inactive.
DeleteEndpoint ( array $params = [] ): Deletes an endpoint.
DeleteEndpointConfig ( array $params = [] ): Deletes an endpoint configuration.
DeleteExperiment ( array $params = [] ): Deletes an SageMaker experiment.
DeleteFeatureGroup ( array $params = [] ): Delete the FeatureGroup and any data that was written to the OnlineStore of the FeatureGroup.
DeleteFlowDefinition ( array $params = [] ): Deletes the specified flow definition.
DeleteHub ( array $params = [] ): Delete a hub.
DeleteHubContent ( array $params = [] ): Delete the contents of a hub.
DeleteHubContentReference ( array $params = [] ): Delete a hub content reference in order to remove a model from a private hub.
DeleteHumanTaskUi ( array $params = [] ): Use this operation to delete a human task user interface (worker task template).
DeleteHyperParameterTuningJob ( array $params = [] ): Deletes a hyperparameter tuning job.
DeleteImage ( array $params = [] ): Deletes a SageMaker AI image and all versions of the image.
DeleteImageVersion ( array $params = [] ): Deletes a version of a SageMaker AI image.
DeleteInferenceComponent ( array $params = [] ): Deletes an inference component.
DeleteInferenceExperiment ( array $params = [] ): Deletes an inference experiment.
DeleteJob ( array $params = [] ): Deletes a job.
DeleteMlflowApp ( array $params = [] ): Deletes an MLflow App.
DeleteMlflowTrackingServer ( array $params = [] ): Deletes an MLflow Tracking Server.
DeleteModel ( array $params = [] ): Deletes a model.
DeleteModelBiasJobDefinition ( array $params = [] ): Deletes an Amazon SageMaker AI model bias job definition.
DeleteModelCard ( array $params = [] ): Deletes an Amazon SageMaker Model Card.
DeleteModelExplainabilityJobDefinition ( array $params = [] ): Deletes an Amazon SageMaker AI model explainability job definition.
DeleteModelPackage ( array $params = [] ): Deletes a model package.
DeleteModelPackageGroup ( array $params = [] ): Deletes the specified model group.
DeleteModelPackageGroupPolicy ( array $params = [] ): Deletes a model group resource policy.
DeleteModelQualityJobDefinition ( array $params = [] ): Deletes the secified model quality monitoring job definition.
DeleteMonitoringSchedule ( array $params = [] ): Deletes a monitoring schedule.
DeleteNotebookInstance ( array $params = [] ): Deletes an SageMaker AI notebook instance.
DeleteNotebookInstanceLifecycleConfig ( array $params = [] ): Deletes a notebook instance lifecycle configuration.
DeleteOptimizationJob ( array $params = [] ): Deletes an optimization job.
DeletePartnerApp ( array $params = [] ): Deletes a SageMaker Partner AI App.
DeletePipeline ( array $params = [] ): Deletes a pipeline if there are no running instances of the pipeline.
DeleteProcessingJob ( array $params = [] ): Deletes a processing job.
DeleteProject ( array $params = [] ): Delete the specified project.
DeleteSpace ( array $params = [] ): Used to delete a space.
DeleteStudioLifecycleConfig ( array $params = [] ): Deletes the Amazon SageMaker AI Studio Lifecycle Configuration.
DeleteTags ( array $params = [] ): Deletes the specified tags from an SageMaker resource.
DeleteTrainingJob ( array $params = [] ): Deletes a training job.
DeleteTrial ( array $params = [] ): Deletes the specified trial.
DeleteTrialComponent ( array $params = [] ): Deletes the specified trial component.
DeleteUserProfile ( array $params = [] ): Deletes a user profile.
DeleteWorkforce ( array $params = [] ): Use this operation to delete a workforce.
DeleteWorkteam ( array $params = [] ): Deletes an existing work team.
DeregisterDevices ( array $params = [] ): Deregisters the specified devices.
DescribeAIBenchmarkJob ( array $params = [] ): Returns details of an AI benchmark job, including its status, configuration, target endpoint, and timing information.
DescribeAIRecommendationJob ( array $params = [] ): Returns details of an AI recommendation job, including its status, model source, performance targets, optimization recommendations, and deployment configurations.
DescribeAIWorkloadConfig ( array $params = [] ): Returns details of an AI workload configuration, including the dataset configuration, benchmark tool settings, tags, and creation time.
DescribeAction ( array $params = [] ): Describes an action.
DescribeAlgorithm ( array $params = [] ): Returns a description of the specified algorithm that is in your account.
DescribeApp ( array $params = [] ): Describes the app.
DescribeAppImageConfig ( array $params = [] ): Describes an AppImageConfig.
DescribeArtifact ( array $params = [] ): Describes an artifact.
DescribeAutoMLJob ( array $params = [] ): Returns information about an AutoML job created by calling CreateAutoMLJob.
DescribeAutoMLJobV2 ( array $params = [] ): Returns information about an AutoML job created by calling CreateAutoMLJobV2 or CreateAutoMLJob.
DescribeCluster ( array $params = [] ): Retrieves information of a SageMaker HyperPod cluster.
DescribeClusterEvent ( array $params = [] ): Retrieves detailed information about a specific event for a given HyperPod cluster.
DescribeClusterNode ( array $params = [] ): Retrieves information of a node (also called a instance interchangeably) of a SageMaker HyperPod cluster.
DescribeClusterSchedulerConfig ( array $params = [] ): Description of the cluster policy.
DescribeCodeRepository ( array $params = [] ): Gets details about the specified Git repository.
DescribeCompilationJob ( array $params = [] ): Returns information about a model compilation job.
DescribeComputeQuota ( array $params = [] ): Description of the compute allocation definition.
DescribeContext ( array $params = [] ): Describes a context.
DescribeDataQualityJobDefinition ( array $params = [] ): Gets the details of a data quality monitoring job definition.
DescribeDevice ( array $params = [] ): Describes the device.
DescribeDeviceFleet ( array $params = [] ): A description of the fleet the device belongs to.
DescribeDomain ( array $params = [] ): The description of the domain.
DescribeEdgeDeploymentPlan ( array $params = [] ): Describes an edge deployment plan with deployment status per stage.
DescribeEdgePackagingJob ( array $params = [] ): A description of edge packaging jobs.
DescribeEndpoint ( array $params = [] ): Returns the description of an endpoint.
DescribeEndpointConfig ( array $params = [] ): Returns the description of an endpoint configuration created using the CreateEndpointConfig API.
DescribeExperiment ( array $params = [] ): Provides a list of an experiment's properties.
DescribeFeatureGroup ( array $params = [] ): Use this operation to describe a FeatureGroup.
DescribeFeatureMetadata ( array $params = [] ): Shows the metadata for a feature within a feature group.
DescribeFlowDefinition ( array $params = [] ): Returns information about the specified flow definition.
DescribeHub ( array $params = [] ): Describes a hub.
DescribeHubContent ( array $params = [] ): Describe the content of a hub.
DescribeHumanTaskUi ( array $params = [] ): Returns information about the requested human task user interface (worker task template).
DescribeHyperParameterTuningJob ( array $params = [] ): Returns a description of a hyperparameter tuning job, depending on the fields selected.
DescribeImage ( array $params = [] ): Describes a SageMaker AI image.
DescribeImageVersion ( array $params = [] ): Describes a version of a SageMaker AI image.
DescribeInferenceComponent ( array $params = [] ): Returns information about an inference component.
DescribeInferenceExperiment ( array $params = [] ): Returns details about an inference experiment.
DescribeInferenceRecommendationsJob ( array $params = [] ): Provides the results of the Inference Recommender job.
DescribeJob ( array $params = [] ): Returns detailed information about a job, including its current status, secondary status, configuration, and timestamps.
DescribeJobSchemaVersion ( array $params = [] ): Returns the JSON schema for a specified job category and schema version.
DescribeLabelingJob ( array $params = [] ): Gets information about a labeling job.
DescribeLineageGroup ( array $params = [] ): Provides a list of properties for the requested lineage group.
DescribeMlflowApp ( array $params = [] ): Returns information about an MLflow App.
DescribeMlflowTrackingServer ( array $params = [] ): Returns information about an MLflow Tracking Server.
DescribeModel ( array $params = [] ): Describes a model that you created using the CreateModel API.
DescribeModelBiasJobDefinition ( array $params = [] ): Returns a description of a model bias job definition.
DescribeModelCard ( array $params = [] ): Describes the content, creation time, and security configuration of an Amazon SageMaker Model Card.
DescribeModelCardExportJob ( array $params = [] ): Describes an Amazon SageMaker Model Card export job.
DescribeModelExplainabilityJobDefinition ( array $params = [] ): Returns a description of a model explainability job definition.
DescribeModelPackage ( array $params = [] ): Returns a description of the specified model package, which is used to create SageMaker models or list them on Amazon Web Services Marketplace.
DescribeModelPackageGroup ( array $params = [] ): Gets a description for the specified model group.
DescribeModelQualityJobDefinition ( array $params = [] ): Returns a description of a model quality job definition.
DescribeMonitoringSchedule ( array $params = [] ): Describes the schedule for a monitoring job.
DescribeNotebookInstance ( array $params = [] ): Returns information about a notebook instance.
DescribeNotebookInstanceLifecycleConfig ( array $params = [] ): Returns a description of a notebook instance lifecycle configuration.
DescribeOptimizationJob ( array $params = [] ): Provides the properties of the specified optimization job.
DescribePartnerApp ( array $params = [] ): Gets information about a SageMaker Partner AI App.
DescribePipeline ( array $params = [] ): Describes the details of a pipeline.
DescribePipelineDefinitionForExecution ( array $params = [] ): Describes the details of an execution's pipeline definition.
DescribePipelineExecution ( array $params = [] ): Describes the details of a pipeline execution.
DescribeProcessingJob ( array $params = [] ): Returns a description of a processing job.
DescribeProject ( array $params = [] ): Describes the details of a project.
DescribeReservedCapacity ( array $params = [] ): Retrieves details about a reserved capacity.
DescribeSpace ( array $params = [] ): Describes the space.
DescribeStudioLifecycleConfig ( array $params = [] ): Describes the Amazon SageMaker AI Studio Lifecycle Configuration.
DescribeSubscribedWorkteam ( array $params = [] ): Gets information about a work team provided by a vendor.
DescribeTrainingJob ( array $params = [] ): Returns information about a training job.
DescribeTrainingPlan ( array $params = [] ): Retrieves detailed information about a specific training plan.
DescribeTrainingPlanExtensionHistory ( array $params = [] ): Retrieves the extension history for a specified training plan.
DescribeTransformJob ( array $params = [] ): Returns information about a transform job.
DescribeTrial ( array $params = [] ): Provides a list of a trial's properties.
DescribeTrialComponent ( array $params = [] ): Provides a list of a trials component's properties.
DescribeUserProfile ( array $params = [] ): Describes a user profile.
DescribeWorkforce ( array $params = [] ): Lists private workforce information, including workforce name, Amazon Resource Name (ARN), and, if applicable, allowed IP address ranges (CIDRs).
DescribeWorkteam ( array $params = [] ): Gets information about a specific work team.
DetachClusterNodeVolume ( array $params = [] ): Detaches your Amazon Elastic Block Store (Amazon EBS) volume from a node in your EKS orchestrated SageMaker HyperPod cluster.
DisableSagemakerServicecatalogPortfolio ( array $params = [] ): Disables using Service Catalog in SageMaker.
DisassociateTrialComponent ( array $params = [] ): Disassociates a trial component from a trial.
EnableSagemakerServicecatalogPortfolio ( array $params = [] ): Enables using Service Catalog in SageMaker.
ExtendTrainingPlan ( array $params = [] ): Extends an existing training plan by purchasing an extension offering.
GetDeviceFleetReport ( array $params = [] ): Describes a fleet.
GetLineageGroupPolicy ( array $params = [] ): The resource policy for the lineage group.
GetModelPackageGroupPolicy ( array $params = [] ): Gets a resource policy that manages access for a model group.
GetSagemakerServicecatalogPortfolioStatus ( array $params = [] ): Gets the status of Service Catalog in SageMaker.
GetScalingConfigurationRecommendation ( array $params = [] ): Starts an Amazon SageMaker Inference Recommender autoscaling recommendation job.
GetSearchSuggestions ( array $params = [] ): An auto-complete API for the search functionality in the SageMaker console.
ImportHubContent ( array $params = [] ): Import hub content.
ListAIBenchmarkJobs ( array $params = [] ): Returns a list of AI benchmark jobs in your account.
ListAIRecommendationJobs ( array $params = [] ): Returns a list of AI recommendation jobs in your account.
ListAIWorkloadConfigs ( array $params = [] ): Returns a list of AI workload configurations in your account.
ListActions ( array $params = [] ): Lists the actions in your account and their properties.
ListAlgorithms ( array $params = [] ): Lists the machine learning algorithms that have been created.
ListAliases ( array $params = [] ): Lists the aliases of a specified image or image version.
ListAppImageConfigs ( array $params = [] ): Lists the AppImageConfigs in your account and their properties.
ListApps ( array $params = [] ): Lists apps.
ListArtifacts ( array $params = [] ): Lists the artifacts in your account and their properties.
ListAssociations ( array $params = [] ): Lists the associations in your account and their properties.
ListAutoMLJobs ( array $params = [] ): Request a list of jobs.
ListCandidatesForAutoMLJob ( array $params = [] ): List the candidates created for the job.
ListClusterEvents ( array $params = [] ): Retrieves a list of event summaries for a specified HyperPod cluster.
ListClusterNodes ( array $params = [] ): Retrieves the list of instances (also called nodes interchangeably) in a SageMaker HyperPod cluster.
ListClusterSchedulerConfigs ( array $params = [] ): List the cluster policy configurations.
ListClusters ( array $params = [] ): Retrieves the list of SageMaker HyperPod clusters.
ListCodeRepositories ( array $params = [] ): Gets a list of the Git repositories in your account.
ListCompilationJobs ( array $params = [] ): Lists model compilation jobs that satisfy various filters.
ListComputeQuotas ( array $params = [] ): List the resource allocation definitions.
ListContexts ( array $params = [] ): Lists the contexts in your account and their properties.
ListDataQualityJobDefinitions ( array $params = [] ): Lists the data quality job definitions in your account.
ListDeviceFleets ( array $params = [] ): Returns a list of devices in the fleet.
ListDevices ( array $params = [] ): A list of devices.
ListDomains ( array $params = [] ): Lists the domains.
ListEdgeDeploymentPlans ( array $params = [] ): Lists all edge deployment plans.
ListEdgePackagingJobs ( array $params = [] ): Returns a list of edge packaging jobs.
ListEndpointConfigs ( array $params = [] ): Lists endpoint configurations.
ListEndpoints ( array $params = [] ): Lists endpoints.
ListExperiments ( array $params = [] ): Lists all the experiments in your account.
ListFeatureGroups ( array $params = [] ): List FeatureGroups based on given filter and order.
ListFlowDefinitions ( array $params = [] ): Returns information about the flow definitions in your account.
ListHubContentVersions ( array $params = [] ): List hub content versions.
ListHubContents ( array $params = [] ): List the contents of a hub.
ListHubs ( array $params = [] ): List all existing hubs.
ListHumanTaskUis ( array $params = [] ): Returns information about the human task user interfaces in your account.
ListHyperParameterTuningJobs ( array $params = [] ): Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.
ListImageVersions ( array $params = [] ): Lists the versions of a specified image and their properties.
ListImages ( array $params = [] ): Lists the images in your account and their properties.
ListInferenceComponents ( array $params = [] ): Lists the inference components in your account and their properties.
ListInferenceExperiments ( array $params = [] ): Returns the list of all inference experiments.
ListInferenceRecommendationsJobSteps ( array $params = [] ): Returns a list of the subtasks for an Inference Recommender job.
ListInferenceRecommendationsJobs ( array $params = [] ): Lists recommendation jobs that satisfy various filters.
ListJobSchemaVersions ( array $params = [] ): Lists available configuration schema versions for a specified job category.
ListJobs ( array $params = [] ): Lists jobs in a specified category.
ListLabelingJobs ( array $params = [] ): Gets a list of labeling jobs.
ListLabelingJobsForWorkteam ( array $params = [] ): Gets a list of labeling jobs assigned to a specified work team.
ListLineageGroups ( array $params = [] ): A list of lineage groups shared with your Amazon Web Services account.
ListMlflowApps ( array $params = [] ): Lists all MLflow Apps
ListMlflowTrackingServers ( array $params = [] ): Lists all MLflow Tracking Servers.
ListModelBiasJobDefinitions ( array $params = [] ): Lists model bias jobs definitions that satisfy various filters.
ListModelCardExportJobs ( array $params = [] ): List the export jobs for the Amazon SageMaker Model Card.
ListModelCardVersions ( array $params = [] ): List existing versions of an Amazon SageMaker Model Card.
ListModelCards ( array $params = [] ): List existing model cards.
ListModelExplainabilityJobDefinitions ( array $params = [] ): Lists model explainability job definitions that satisfy various filters.
ListModelMetadata ( array $params = [] ): Lists the domain, framework, task, and model name of standard machine learning models found in common model zoos.
ListModelPackageGroups ( array $params = [] ): Gets a list of the model groups in your Amazon Web Services account.
ListModelPackages ( array $params = [] ): Lists the model packages that have been created.
ListModelQualityJobDefinitions ( array $params = [] ): Gets a list of model quality monitoring job definitions in your account.
ListModels ( array $params = [] ): Lists models created with the CreateModel API.
ListMonitoringAlertHistory ( array $params = [] ): Gets a list of past alerts in a model monitoring schedule.
ListMonitoringAlerts ( array $params = [] ): Gets the alerts for a single monitoring schedule.
ListMonitoringExecutions ( array $params = [] ): Returns list of all monitoring job executions.
ListMonitoringSchedules ( array $params = [] ): Returns list of all monitoring schedules.
ListNotebookInstanceLifecycleConfigs ( array $params = [] ): Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.
ListNotebookInstances ( array $params = [] ): Returns a list of the SageMaker AI notebook instances in the requester's account in an Amazon Web Services Region.
ListOptimizationJobs ( array $params = [] ): Lists the optimization jobs in your account and their properties.
ListPartnerApps ( array $params = [] ): Lists all of the SageMaker Partner AI Apps in an account.
ListPipelineExecutionSteps ( array $params = [] ): Gets a list of PipeLineExecutionStep objects.
ListPipelineExecutions ( array $params = [] ): Gets a list of the pipeline executions.
ListPipelineParametersForExecution ( array $params = [] ): Gets a list of parameters for a pipeline execution.
ListPipelineVersions ( array $params = [] ): Gets a list of all versions of the pipeline.
ListPipelines ( array $params = [] ): Gets a list of pipelines.
ListProcessingJobs ( array $params = [] ): Lists processing jobs that satisfy various filters.
ListProjects ( array $params = [] ): Gets a list of the projects in an Amazon Web Services account.
ListResourceCatalogs ( array $params = [] ): Lists Amazon SageMaker Catalogs based on given filters and orders.
ListSpaces ( array $params = [] ): Lists spaces.
ListStageDevices ( array $params = [] ): Lists devices allocated to the stage, containing detailed device information and deployment status.
ListStudioLifecycleConfigs ( array $params = [] ): Lists the Amazon SageMaker AI Studio Lifecycle Configurations in your Amazon Web Services Account.
ListSubscribedWorkteams ( array $params = [] ): Gets a list of the work teams that you are subscribed to in the Amazon Web Services Marketplace.
ListTags ( array $params = [] ): Returns the tags for the specified SageMaker resource.
ListTrainingJobs ( array $params = [] ): Lists training jobs.
ListTrainingJobsForHyperParameterTuningJob ( array $params = [] ): Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.
ListTrainingPlans ( array $params = [] ): Retrieves a list of training plans for the current account.
ListTransformJobs ( array $params = [] ): Lists transform jobs.
ListTrialComponents ( array $params = [] ): Lists the trial components in your account.
ListTrials ( array $params = [] ): Lists the trials in your account.
ListUltraServersByReservedCapacity ( array $params = [] ): Lists all UltraServers that are part of a specified reserved capacity.
ListUserProfiles ( array $params = [] ): Lists user profiles.
ListWorkforces ( array $params = [] ): Use this operation to list all private and vendor workforces in an Amazon Web Services Region.
ListWorkteams ( array $params = [] ): Gets a list of private work teams that you have defined in a region.
PutModelPackageGroupPolicy ( array $params = [] ): Adds a resouce policy to control access to a model group.
QueryLineage ( array $params = [] ): Use this action to inspect your lineage and discover relationships between entities.
RegisterDevices ( array $params = [] ): Register devices.
RenderUiTemplate ( array $params = [] ): Renders the UI template so that you can preview the worker's experience.
RetryPipelineExecution ( array $params = [] ): Retry the execution of the pipeline.
Search ( array $params = [] ): Finds SageMaker resources that match a search query.
SearchTrainingPlanOfferings ( array $params = [] ): Searches for available training plan offerings based on specified criteria.
SendPipelineExecutionStepFailure ( array $params = [] ): Notifies the pipeline that the execution of a callback step failed, along with a message describing why.
SendPipelineExecutionStepSuccess ( array $params = [] ): Notifies the pipeline that the execution of a callback step succeeded and provides a list of the step's output parameters.
StartClusterHealthCheck ( array $params = [] ): Start deep health checks for a SageMaker HyperPod cluster.
StartEdgeDeploymentStage ( array $params = [] ): Starts a stage in an edge deployment plan.
StartInferenceExperiment ( array $params = [] ): Starts an inference experiment.
StartMlflowTrackingServer ( array $params = [] ): Programmatically start an MLflow Tracking Server.
StartMonitoringSchedule ( array $params = [] ): Starts a previously stopped monitoring schedule.
StartNotebookInstance ( array $params = [] ): Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume.
StartPipelineExecution ( array $params = [] ): Starts a pipeline execution.
StartSession ( array $params = [] ): Initiates a remote connection session between a local integrated development environments (IDEs) and a remote SageMaker space.
StopAIBenchmarkJob ( array $params = [] ): Stops a running AI benchmark job.
StopAIRecommendationJob ( array $params = [] ): Stops a running AI recommendation job.
StopAutoMLJob ( array $params = [] ): A method for forcing a running job to shut down.
StopCompilationJob ( array $params = [] ): Stops a model compilation job.
StopEdgeDeploymentStage ( array $params = [] ): Stops a stage in an edge deployment plan.
StopEdgePackagingJob ( array $params = [] ): Request to stop an edge packaging job.
StopHyperParameterTuningJob ( array $params = [] ): Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched.
StopInferenceExperiment ( array $params = [] ): Stops an inference experiment.
StopInferenceRecommendationsJob ( array $params = [] ): Stops an Inference Recommender job.
StopJob ( array $params = [] ): Stops a running job.
StopLabelingJob ( array $params = [] ): Stops a running labeling job.
StopMlflowTrackingServer ( array $params = [] ): Programmatically stop an MLflow Tracking Server.
StopMonitoringSchedule ( array $params = [] ): Stops a previously started monitoring schedule.
StopNotebookInstance ( array $params = [] ): Terminates the ML compute instance.
StopOptimizationJob ( array $params = [] ): Ends a running inference optimization job.
StopPipelineExecution ( array $params = [] ): Stops a pipeline execution.
StopProcessingJob ( array $params = [] ): Stops a processing job.
StopTrainingJob ( array $params = [] ): Stops a training job.
StopTransformJob ( array $params = [] ): Stops a batch transform job.
UpdateAction ( array $params = [] ): Updates an action.
UpdateAppImageConfig ( array $params = [] ): Updates the properties of an AppImageConfig.
UpdateArtifact ( array $params = [] ): Updates an artifact.
UpdateCluster ( array $params = [] ): Updates a SageMaker HyperPod cluster.
UpdateClusterSchedulerConfig ( array $params = [] ): Update the cluster policy configuration.
UpdateClusterSoftware ( array $params = [] ): Updates the platform software of a SageMaker HyperPod cluster for security patching.
UpdateCodeRepository ( array $params = [] ): Updates the specified Git repository with the specified values.
UpdateComputeQuota ( array $params = [] ): Update the compute allocation definition.
UpdateContext ( array $params = [] ): Updates a context.
UpdateDeviceFleet ( array $params = [] ): Updates a fleet of devices.
UpdateDevices ( array $params = [] ): Updates one or more devices in a fleet.
UpdateDomain ( array $params = [] ): Updates the default settings for new user profiles in the domain.
UpdateEndpoint ( array $params = [] ): Deploys the EndpointConfig specified in the request to a new fleet of instances.
UpdateEndpointWeightsAndCapacities ( array $params = [] ): Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint.
UpdateExperiment ( array $params = [] ): Adds, updates, or removes the description of an experiment.
UpdateFeatureGroup ( array $params = [] ): Updates the feature group by either adding features or updating the online store configuration.
UpdateFeatureMetadata ( array $params = [] ): Updates the description and parameters of the feature group.
UpdateHub ( array $params = [] ): Update a hub.
UpdateHubContent ( array $params = [] ): Updates SageMaker hub content (either a Model or Notebook resource).
UpdateHubContentReference ( array $params = [] ): Updates the contents of a SageMaker hub for a ModelReference resource.
UpdateImage ( array $params = [] ): Updates the properties of a SageMaker AI image.
UpdateImageVersion ( array $params = [] ): Updates the properties of a SageMaker AI image version.
UpdateInferenceComponent ( array $params = [] ): Updates an inference component.
UpdateInferenceComponentRuntimeConfig ( array $params = [] ): Runtime settings for a model that is deployed with an inference component.
UpdateInferenceExperiment ( array $params = [] ): Updates an inference experiment that you created.
UpdateMlflowApp ( array $params = [] ): Updates an MLflow App.
UpdateMlflowTrackingServer ( array $params = [] ): Updates properties of an existing MLflow Tracking Server.
UpdateModelCard ( array $params = [] ): Update an Amazon SageMaker Model Card.
UpdateModelPackage ( array $params = [] ): Updates a versioned model.
UpdateMonitoringAlert ( array $params = [] ): Update the parameters of a model monitor alert.
UpdateMonitoringSchedule ( array $params = [] ): Updates a previously created schedule.
UpdateNotebookInstance ( array $params = [] ): Updates a notebook instance.
UpdateNotebookInstanceLifecycleConfig ( array $params = [] ): Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.
UpdatePartnerApp ( array $params = [] ): Updates all of the SageMaker Partner AI Apps in an account.
UpdatePipeline ( array $params = [] ): Updates a pipeline.
UpdatePipelineExecution ( array $params = [] ): Updates a pipeline execution.
UpdatePipelineVersion ( array $params = [] ): Updates a pipeline version.
UpdateProject ( array $params = [] ): 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.
UpdateSpace ( array $params = [] ): Updates the settings of a space.
UpdateTrainingJob ( array $params = [] ): Update a model training job to request a new Debugger profiling configuration or to change warm pool retention length.
UpdateTrial ( array $params = [] ): Updates the display name of a trial.
UpdateTrialComponent ( array $params = [] ): Updates one or more properties of a trial component.
UpdateUserProfile ( array $params = [] ): Updates a user profile.
UpdateWorkforce ( array $params = [] ): Use this operation to update your workforce.
UpdateWorkteam ( array $params = [] ): Updates an existing work team with new member definitions or description.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

CreateHubContentPresignedUrls
DescribeTrainingPlanExtensionHistory
ListAIBenchmarkJobs
ListAIRecommendationJobs
ListAIWorkloadConfigs
ListActions
ListAlgorithms
ListAliases
ListAppImageConfigs
ListApps
ListArtifacts
ListAssociations
ListAutoMLJobs
ListCandidatesForAutoMLJob
ListClusterEvents
ListClusterNodes
ListClusterSchedulerConfigs
ListClusters
ListCodeRepositories
ListCompilationJobs
ListComputeQuotas
ListContexts
ListDataQualityJobDefinitions
ListDeviceFleets
ListDevices
ListDomains
ListEdgeDeploymentPlans
ListEdgePackagingJobs
ListEndpointConfigs
ListEndpoints
ListExperiments
ListFeatureGroups
ListFlowDefinitions
ListHumanTaskUis
ListHyperParameterTuningJobs
ListImageVersions
ListImages
ListInferenceComponents
ListInferenceExperiments
ListInferenceRecommendationsJobSteps
ListInferenceRecommendationsJobs
ListJobSchemaVersions
ListJobs
ListLabelingJobs
ListLabelingJobsForWorkteam
ListLineageGroups
ListMlflowApps
ListMlflowTrackingServers
ListModelBiasJobDefinitions
ListModelCardExportJobs
ListModelCardVersions
ListModelCards
ListModelExplainabilityJobDefinitions
ListModelMetadata
ListModelPackageGroups
ListModelPackages
ListModelQualityJobDefinitions
ListModels
ListMonitoringAlertHistory
ListMonitoringAlerts
ListMonitoringExecutions
ListMonitoringSchedules
ListNotebookInstanceLifecycleConfigs
ListNotebookInstances
ListOptimizationJobs
ListPartnerApps
ListPipelineExecutionSteps
ListPipelineExecutions
ListPipelineParametersForExecution
ListPipelineVersions
ListPipelines
ListProcessingJobs
ListProjects
ListResourceCatalogs
ListSpaces
ListStageDevices
ListStudioLifecycleConfigs
ListSubscribedWorkteams
ListTags
ListTrainingJobs
ListTrainingJobsForHyperParameterTuningJob
ListTrainingPlans
ListTransformJobs
ListTrialComponents
ListTrials
ListUltraServersByReservedCapacity
ListUserProfiles
ListWorkforces
ListWorkteams
QueryLineage
Search

Waiters

Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:

Waiter name	API Operation	Delay	Max Attempts
EndpointDeleted	DescribeEndpoint	30	60
EndpointInService	DescribeEndpoint	30	120
ImageCreated	DescribeImage	60	60
ImageDeleted	DescribeImage	60	60
ImageUpdated	DescribeImage	60	60
ImageVersionCreated	DescribeImageVersion	60	60
ImageVersionDeleted	DescribeImageVersion	60	60
NotebookInstanceDeleted	DescribeNotebookInstance	30	60
NotebookInstanceInService	DescribeNotebookInstance	30	60
NotebookInstanceStopped	DescribeNotebookInstance	30	60
ProcessingJobCompletedOrStopped	DescribeProcessingJob	60	60
TrainingJobCompletedOrStopped	DescribeTrainingJob	120	180
TransformJobCompletedOrStopped	DescribeTransformJob	60	60

Operations

AddAssociation

$result = $client->addAssociation([/* ... */]);
$promise = $client->addAssociationAsync([/* ... */]);

Creates an association between the source and the destination. A source can be associated with multiple destinations, and a destination can be associated with multiple sources. An association is a lineage tracking entity. For more information, see Amazon SageMaker ML Lineage Tracking.

Parameter Syntax

$result = $client->addAssociation([
    'AssociationType' => 'ContributedTo|AssociatedWith|DerivedFrom|Produced|SameAs',
    'DestinationArn' => '<string>', // REQUIRED
    'SourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

AssociationType

: Type: string

The type of association. The following are suggested uses for each type. Amazon SageMaker places no restrictions on their use.

ContributedTo - The source contributed to the destination or had a part in enabling the destination. For example, the training data contributed to the training job.
AssociatedWith - The source is connected to the destination. For example, an approval workflow is associated with a model deployment.
DerivedFrom - The destination is a modification of the source. For example, a digest output of a channel input for a processing job is derived from the original inputs.
Produced - The source generated the destination. For example, a training job produced a model artifact.

DestinationArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the destination.

SourceArn

: Required: Yes
: Type: string

The ARN of the source.

Result Syntax

[
    'DestinationArn' => '<string>',
    'SourceArn' => '<string>',
]

Result Details

Members

DestinationArn

: Type: string

The Amazon Resource Name (ARN) of the destination.

SourceArn

: Type: string

The ARN of the source.

Errors

ResourceNotFound:: Resource being access is not found.
ResourceLimitExceeded:: You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

AddTags

$result = $client->addTags([/* ... */]);
$promise = $client->addTagsAsync([/* ... */]);

Adds or overwrites one or more tags for the specified SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints.

Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.

Tags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you first create the tuning job by specifying them in the Tags parameter of CreateHyperParameterTuningJob

Tags that you add to a SageMaker Domain or User Profile by calling this API are also added to any Apps that the Domain or User Profile launches after you call this API, but not to Apps that the Domain or User Profile launched before you called this API. To make sure that the tags associated with a Domain or User Profile are also added to all Apps that the Domain or User Profile launches, add the tags when you first create the Domain or User Profile by specifying them in the Tags parameter of CreateDomain or CreateUserProfile.

Parameter Syntax

$result = $client->addTags([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

ResourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the resource that you want to tag.

Tags

: Required: Yes
: Type: Array of Tag structures

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

Tags

: Type: Array of Tag structures

A list of tags associated with the SageMaker resource.

Errors

There are no errors described for this operation.

AssociateTrialComponent

$result = $client->associateTrialComponent([/* ... */]);
$promise = $client->associateTrialComponentAsync([/* ... */]);

Associates a trial component with a trial. A trial component can be associated with multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.

Parameter Syntax

$result = $client->associateTrialComponent([
    'TrialComponentName' => '<string>', // REQUIRED
    'TrialName' => '<string>', // REQUIRED
]);

Parameter Details

Members

TrialComponentName

: Required: Yes
: Type: string

The name of the component to associated with the trial.

TrialName

: Required: Yes
: Type: string

The name of the trial to associate with.

Result Syntax

[
    'TrialArn' => '<string>',
    'TrialComponentArn' => '<string>',
]

Result Details

Members

TrialArn

: Type: string

The Amazon Resource Name (ARN) of the trial.

TrialComponentArn

: Type: string

The Amazon Resource Name (ARN) of the trial component.

Errors

ResourceNotFound:: Resource being access is not found.
ResourceLimitExceeded:: You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

AttachClusterNodeNetworkInterface

$result = $client->attachClusterNodeNetworkInterface([/* ... */]);
$promise = $client->attachClusterNodeNetworkInterfaceAsync([/* ... */]);

Attaches an elastic network interface (ENI) to a node in a HyperPod cluster.

To use this operation, you must have the sagemaker:AttachClusterNodeNetworkInterface permission.

Parameter Syntax

$result = $client->attachClusterNodeNetworkInterface([
    'ClusterName' => '<string>', // REQUIRED
    'NetworkInterfaceId' => '<string>', // REQUIRED
    'NodeId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ClusterName

: Required: Yes
: Type: string

The name or Amazon Resource Name (ARN) of the SageMaker HyperPod cluster that contains the target node.

NetworkInterfaceId

Amazon SageMaker Service 2017-07-24

Operation Summary

Paginators

Waiters

Operations

AddAssociation

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AddTags

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AssociateTrialComponent

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AttachClusterNodeNetworkInterface

Parameter Syntax

Parameter Details

Members