SDK for PHP V3
Amazon SageMaker Service 2017-07-24
- 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 = [] )