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 = [] )
- 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' => '', // REQUIRED
'SourceArn' => '', // 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' => '',
'SourceArn' => '',
]
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' => '', // REQUIRED
'Tags' => [ // REQUIRED
[
'Key' => '', // REQUIRED
'Value' => '', // 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' => '',
'Value' => '',
],
// ...
],
]
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' => '', // REQUIRED
'TrialName' => '', // 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' => '',
'TrialComponentArn' => '',
]
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' => '', // REQUIRED
'NetworkInterfaceId' => '', // REQUIRED
'NodeId' => '', // 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
-
- Required: Yes
- Type: string
The unique identifier of the elastic network interface (ENI) to attach.
- NodeId
-
- Required: Yes
- Type: string
The unique identifier of the cluster node to which you want to attach the network interface. The node must belong to your specified HyperPod cluster and cannot be part of a Restricted Instance Group (RIG).
Result Syntax
[
'AttachmentId' => '',
'ClusterArn' => '',
'NetworkInterfaceId' => '',
'NodeId' => '',
]
Result Details
Members
- AttachmentId
-
- Required: Yes
- Type: string
The unique identifier of the network interface attachment. Use this value to reference or detach the network interface later.
- ClusterArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster where the network interface attachment operation was performed.
- NetworkInterfaceId
-
- Required: Yes
- Type: string
The unique identifier of the elastic network interface (ENI) that was attached.
- NodeId
-
- Required: Yes
- Type: string
The unique identifier of the cluster node where your network interface was attached.
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.
AttachClusterNodeVolume
$result = $client->attachClusterNodeVolume([/* ... */]); $promise = $client->attachClusterNodeVolumeAsync([/* ... */]);
Attaches your Amazon Elastic Block Store (Amazon EBS) volume to a node in your EKS orchestrated HyperPod cluster.
This API works with the Amazon Elastic Block Store (Amazon EBS) Container Storage Interface (CSI) driver to manage the lifecycle of persistent storage in your HyperPod EKS clusters.
Parameter Syntax
$result = $client->attachClusterNodeVolume([
'ClusterArn' => '', // REQUIRED
'NodeId' => '', // REQUIRED
'VolumeId' => '', // REQUIRED
]);
Parameter Details
Members
- ClusterArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster containing the target node. Your cluster must use EKS as the orchestration and be in the
InServicestate. - NodeId
-
- Required: Yes
- Type: string
The unique identifier of the cluster node to which you want to attach the volume. The node must belong to your specified HyperPod cluster and cannot be part of a Restricted Instance Group (RIG).
- VolumeId
-
- Required: Yes
- Type: string
The unique identifier of your EBS volume to attach. The volume must be in the
availablestate.
Result Syntax
[
'AttachTime' => ,
'ClusterArn' => '',
'DeviceName' => '',
'NodeId' => '',
'Status' => 'attaching|attached|detaching|detached|busy',
'VolumeId' => '',
]
Result Details
Members
- AttachTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the volume attachment operation was initiated by the SageMaker HyperPod service.
- ClusterArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster where the volume attachment operation was performed.
- DeviceName
-
- Required: Yes
- Type: string
The device name assigned to your attached volume on the target instance.
- NodeId
-
- Required: Yes
- Type: string
The unique identifier of the cluster node where your volume was attached.
- Status
-
- Required: Yes
- Type: string
The current status of your volume attachment operation.
- VolumeId
-
- Required: Yes
- Type: string
The unique identifier of your EBS volume that was attached.
Errors
- ResourceNotFound:
Resource being access is not found.
BatchAddClusterNodes
$result = $client->batchAddClusterNodes([/* ... */]); $promise = $client->batchAddClusterNodesAsync([/* ... */]);
Adds nodes to a HyperPod cluster by incrementing the target count for one or more instance groups. This operation returns a unique NodeLogicalId for each node being added, which can be used to track the provisioning status of the node. This API provides a safer alternative to UpdateCluster for scaling operations by avoiding unintended configuration changes.
This API is only supported for clusters using Continuous as the NodeProvisioningMode.
Parameter Syntax
$result = $client->batchAddClusterNodes([
'ClientToken' => '',
'ClusterName' => '', // REQUIRED
'NodesToAdd' => [ // REQUIRED
[
'AvailabilityZones' => ['', ...],
'IncrementTargetCountBy' => , // REQUIRED
'InstanceGroupName' => '', // REQUIRED
'InstanceTypes' => ['', ...],
],
// ...
],
]);
Parameter Details
Members
- ClientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token is valid for 8 hours. If you retry the request with the same client token within this timeframe and the same parameters, the API returns the same set of
NodeLogicalIdswith their latest status. - ClusterName
-
- Required: Yes
- Type: string
The name of the HyperPod cluster to which you want to add nodes.
- NodesToAdd
-
- Required: Yes
- Type: Array of AddClusterNodeSpecification structures
A list of instance groups and the number of nodes to add to each. You can specify up to 5 instance groups in a single request, with a maximum of 50 nodes total across all instance groups.
Result Syntax
[
'Failed' => [
[
'AvailabilityZones' => ['', ...],
'ErrorCode' => 'InstanceGroupNotFound|InvalidInstanceGroupStatus|IncompatibleAvailabilityZones|IncompatibleInstanceTypes',
'FailedCount' => ,
'InstanceGroupName' => '',
'InstanceTypes' => ['', ...],
'Message' => '',
],
// ...
],
'Successful' => [
[
'AvailabilityZones' => ['', ...],
'InstanceGroupName' => '',
'InstanceTypes' => ['', ...],
'NodeLogicalId' => '',
'Status' => 'Running|Failure|Pending|ShuttingDown|SystemUpdating|DeepHealthCheckInProgress|NotFound',
],
// ...
],
]
Result Details
Members
- Failed
-
- Required: Yes
- Type: Array of BatchAddClusterNodesError structures
A list of errors that occurred during the node addition operation. Each entry includes the instance group name, error code, number of failed additions, and an error message.
- Successful
-
- Required: Yes
- Type: Array of NodeAdditionResult structures
A list of
NodeLogicalIDsthat were successfully added to the cluster. TheNodeLogicalIDis unique per cluster and does not change between instance replacements. Each entry includes aNodeLogicalIdthat can be used to track the node's provisioning status (withDescribeClusterNode), the instance group name, and the current status of the node.
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.
BatchDeleteClusterNodes
$result = $client->batchDeleteClusterNodes([/* ... */]); $promise = $client->batchDeleteClusterNodesAsync([/* ... */]);
Deletes specific nodes within a SageMaker HyperPod cluster. BatchDeleteClusterNodes accepts a cluster name and a list of node IDs.
-
To safeguard your work, back up your data to Amazon S3 or an FSx for Lustre file system before invoking the API on a worker node group. This will help prevent any potential data loss from the instance root volume. For more information about backup, see Use the backup script provided by SageMaker HyperPod.
-
If you want to invoke this API on an existing cluster, you'll first need to patch the cluster by running the UpdateClusterSoftware API. For more information about patching a cluster, see Update the SageMaker HyperPod platform software of a cluster.
Parameter Syntax
$result = $client->batchDeleteClusterNodes([
'ClusterName' => '', // REQUIRED
'NodeIds' => ['', ...],
'NodeLogicalIds' => ['', ...],
]);
Parameter Details
Members
- ClusterName
-
- Required: Yes
- Type: string
The name of the SageMaker HyperPod cluster from which to delete the specified nodes.
- NodeIds
-
- Type: Array of strings
A list of node IDs to be deleted from the specified cluster.
-
For SageMaker HyperPod clusters using the Slurm workload manager, you cannot remove instances that are configured as Slurm controller nodes.
-
If you need to delete more than 99 instances, contact Support for assistance.
- NodeLogicalIds
-
- Type: Array of strings
A list of
NodeLogicalIdsidentifying the nodes to be deleted. You can specify up to 50NodeLogicalIds. You must specify eitherNodeLogicalIds,InstanceIds, or both, with a combined maximum of 50 identifiers.
Result Syntax
[
'Failed' => [
[
'Code' => 'NodeIdNotFound|InvalidNodeStatus|NodeIdInUse',
'Message' => '',
'NodeId' => '',
],
// ...
],
'FailedNodeLogicalIds' => [
[
'Code' => 'NodeIdNotFound|InvalidNodeStatus|NodeIdInUse',
'Message' => '',
'NodeLogicalId' => '',
],
// ...
],
'Successful' => ['', ...],
'SuccessfulNodeLogicalIds' => ['', ...],
]
Result Details
Members
- Failed
-
- Type: Array of BatchDeleteClusterNodesError structures
A list of errors encountered when deleting the specified nodes.
- FailedNodeLogicalIds
-
- Type: Array of BatchDeleteClusterNodeLogicalIdsError structures
A list of
NodeLogicalIdsthat could not be deleted, along with error information explaining why the deletion failed. - Successful
-
- Type: Array of strings
A list of node IDs that were successfully deleted from the specified cluster.
- SuccessfulNodeLogicalIds
-
- Type: Array of strings
A list of
NodeLogicalIdsthat were successfully deleted from the cluster.
Errors
- ResourceNotFound:
Resource being access is not found.
BatchDescribeModelPackage
$result = $client->batchDescribeModelPackage([/* ... */]); $promise = $client->batchDescribeModelPackageAsync([/* ... */]);
This action batch describes a list of versioned model packages
Parameter Syntax
$result = $client->batchDescribeModelPackage([
'ModelPackageArnList' => ['', ...], // REQUIRED
]);
Parameter Details
Members
- ModelPackageArnList
-
- Required: Yes
- Type: Array of strings
The list of Amazon Resource Name (ARN) of the model package groups.
Result Syntax
[
'BatchDescribeModelPackageErrorMap' => [
'' => [
'ErrorCode' => '',
'ErrorResponse' => '',
],
// ...
],
'ModelPackageSummaries' => [
'' => [
'CreationTime' => ,
'InferenceSpecification' => [
'Containers' => [
[
'AdditionalModelDataSources' => [
[
'ChannelName' => '',
'S3DataSource' => [
'CompressionType' => 'None|Gzip',
'ETag' => '',
'HubAccessConfig' => [
'HubContentArn' => '',
],
'ManifestEtag' => '',
'ManifestS3Uri' => '',
'ModelAccessConfig' => [
'AcceptEula' => true || false,
],
'S3DataType' => 'S3Prefix|S3Object',
'S3Uri' => '',
],
],
// ...
],
'AdditionalS3DataSource' => [
'CompressionType' => 'None|Gzip',
'ETag' => '',
'S3DataType' => 'S3Object|S3Prefix',
'S3Uri' => '',
],
'BaseModel' => [
'HubContentName' => '',
'HubContentVersion' => '',
'RecipeName' => '',
],
'ContainerHostname' => '',
'Environment' => ['', ...],
'Framework' => '',
'FrameworkVersion' => '',
'Image' => '',
'ImageDigest' => '',
'IsCheckpoint' => true || false,
'ModelDataETag' => '',
'ModelDataSource' => [
'S3DataSource' => [
'CompressionType' => 'None|Gzip',
'ETag' => '',
'HubAccessConfig' => [
'HubContentArn' => '',
],
'ManifestEtag' => '',
'ManifestS3Uri' => '',
'ModelAccessConfig' => [
'AcceptEula' => true || false,
],
'S3DataType' => 'S3Prefix|S3Object',
'S3Uri' => '',
],
],
'ModelDataUrl' => '',
'ModelInput' => [
'DataInputConfig' => '',
],
'NearestModelName' => '',
'ProductId' => '',
],
// ...
],
'SupportedContentTypes' => ['', ...],
'SupportedRealtimeInferenceInstanceTypes' => ['', ...],
'SupportedResponseMIMETypes' => ['', ...],
'SupportedTransformInstanceTypes' => ['', ...],
],
'ModelApprovalStatus' => 'Approved|Rejected|PendingManualApproval',
'ModelPackageArn' => '',
'ModelPackageDescription' => '',
'ModelPackageGroupName' => '',
'ModelPackageRegistrationType' => 'Logged|Registered',
'ModelPackageStatus' => 'Pending|InProgress|Completed|Failed|Deleting',
'ModelPackageVersion' => ,
],
// ...
],
]
Result Details
Members
- BatchDescribeModelPackageErrorMap
-
- Type: Associative array of custom strings keys (ModelPackageArn) to BatchDescribeModelPackageError structures
A map of the resource and BatchDescribeModelPackageError objects reporting the error associated with describing the model package.
- ModelPackageSummaries
-
- Type: Associative array of custom strings keys (ModelPackageArn) to BatchDescribeModelPackageSummary structures
The summaries for the model package versions
Errors
There are no errors described for this operation.
BatchRebootClusterNodes
$result = $client->batchRebootClusterNodes([/* ... */]); $promise = $client->batchRebootClusterNodesAsync([/* ... */]);
Reboots specific nodes within a SageMaker HyperPod cluster using a soft recovery mechanism. BatchRebootClusterNodes performs a graceful reboot of the specified nodes by calling the Amazon Elastic Compute Cloud RebootInstances API, which attempts to cleanly shut down the operating system before restarting the instance.
This operation is useful for recovering from transient issues or applying certain configuration changes that require a restart.
-
Rebooting a node may cause temporary service interruption for workloads running on that node. Ensure your workloads can handle node restarts or use appropriate scheduling to minimize impact.
-
You can reboot up to 25 nodes in a single request.
-
For SageMaker HyperPod clusters using the Slurm workload manager, ensure rebooting nodes will not disrupt critical cluster operations.
Parameter Syntax
$result = $client->batchRebootClusterNodes([
'ClusterName' => '', // REQUIRED
'NodeIds' => ['', ...],
'NodeLogicalIds' => ['', ...],
]);
Parameter Details
Members
- ClusterName
-
- Required: Yes
- Type: string
The name or Amazon Resource Name (ARN) of the SageMaker HyperPod cluster containing the nodes to reboot.
- NodeIds
-
- Type: Array of strings
A list of EC2 instance IDs to reboot using soft recovery. You can specify between 1 and 25 instance IDs.
-
Either
NodeIdsorNodeLogicalIdsmust be provided (or both), but at least one is required. -
Each instance ID must follow the pattern
i-followed by 17 hexadecimal characters (for example,i-0123456789abcdef0).
- NodeLogicalIds
-
- Type: Array of strings
A list of logical node IDs to reboot using soft recovery. You can specify between 1 and 25 logical node IDs.
The
NodeLogicalIdis a unique identifier that persists throughout the node's lifecycle and can be used to track nodes that are still being provisioned and don't yet have an EC2 instance ID assigned.-
This parameter is only supported for clusters using
Continuousas theNodeProvisioningMode. For clusters using the default provisioning mode, useNodeIdsinstead. -
Either
NodeIdsorNodeLogicalIdsmust be provided (or both), but at least one is required.
Result Syntax
[
'Failed' => [
[
'ErrorCode' => 'InstanceIdNotFound|InvalidInstanceStatus|InstanceIdInUse|InternalServerError',
'Message' => '',
'NodeId' => '',
],
// ...
],
'FailedNodeLogicalIds' => [
[
'ErrorCode' => 'InstanceIdNotFound|InvalidInstanceStatus|InstanceIdInUse|InternalServerError',
'Message' => '',
'NodeLogicalId' => '',
],
// ...
],
'Successful' => ['', ...],
'SuccessfulNodeLogicalIds' => ['', ...],
]
Result Details
Members
- Failed
-
- Type: Array of BatchRebootClusterNodesError structures
A list of errors encountered for EC2 instance IDs that could not be rebooted. Each error includes the instance ID, an error code, and a descriptive message.
- FailedNodeLogicalIds
-
- Type: Array of BatchRebootClusterNodeLogicalIdsError structures
A list of errors encountered for logical node IDs that could not be rebooted. Each error includes the logical node ID, an error code, and a descriptive message. This field is only present when
NodeLogicalIdswere provided in the request. - Successful
-
- Type: Array of strings
A list of EC2 instance IDs for which the reboot operation was successfully initiated.
- SuccessfulNodeLogicalIds
-
- Type: Array of strings
A list of logical node IDs for which the reboot operation was successfully initiated. This field is only present when
NodeLogicalIdswere provided in the request.
Errors
- ResourceNotFound:
Resource being access is not found.
BatchReplaceClusterNodes
$result = $client->batchReplaceClusterNodes([/* ... */]); $promise = $client->batchReplaceClusterNodesAsync([/* ... */]);
Replaces specific nodes within a SageMaker HyperPod cluster with new hardware. BatchReplaceClusterNodes terminates the specified instances and provisions new replacement instances with the same configuration but fresh hardware. The Amazon Machine Image (AMI) and instance configuration remain the same.
This operation is useful for recovering from hardware failures or persistent issues that cannot be resolved through a reboot.
-
Data Loss Warning: Replacing nodes destroys all instance volumes, including both root and secondary volumes. All data stored on these volumes will be permanently lost and cannot be recovered.
-
To safeguard your work, back up your data to Amazon S3 or an FSx for Lustre file system before invoking the API on a worker node group. This will help prevent any potential data loss from the instance root volume. For more information about backup, see Use the backup script provided by SageMaker HyperPod.
-
If you want to invoke this API on an existing cluster, you'll first need to patch the cluster by running the UpdateClusterSoftware API. For more information about patching a cluster, see Update the SageMaker HyperPod platform software of a cluster.
-
You can replace up to 25 nodes in a single request.
Parameter Syntax
$result = $client->batchReplaceClusterNodes([
'ClusterName' => '', // REQUIRED
'NodeIds' => ['', ...],
'NodeLogicalIds' => ['', ...],
]);
Parameter Details
Members
- ClusterName
-
- Required: Yes
- Type: string
The name or Amazon Resource Name (ARN) of the SageMaker HyperPod cluster containing the nodes to replace.
- NodeIds
-
- Type: Array of strings
A list of EC2 instance IDs to replace with new hardware. You can specify between 1 and 25 instance IDs.
Replace operations destroy all instance volumes (root and secondary). Ensure you have backed up any important data before proceeding.
-
Either
NodeIdsorNodeLogicalIdsmust be provided (or both), but at least one is required. -
Each instance ID must follow the pattern
i-followed by 17 hexadecimal characters (for example,i-0123456789abcdef0). -
For SageMaker HyperPod clusters using the Slurm workload manager, you cannot replace instances that are configured as Slurm controller nodes.
- NodeLogicalIds
-
- Type: Array of strings
A list of logical node IDs to replace with new hardware. You can specify between 1 and 25 logical node IDs.
The
NodeLogicalIdis a unique identifier that persists throughout the node's lifecycle and can be used to track nodes that are still being provisioned and don't yet have an EC2 instance ID assigned.-
Replace operations destroy all instance volumes (root and secondary). Ensure you have backed up any important data before proceeding.
-
This parameter is only supported for clusters using
Continuousas theNodeProvisioningMode. For clusters using the default provisioning mode, useNodeIdsinstead. -
Either
NodeIdsorNodeLogicalIdsmust be provided (or both), but at least one is required.
Result Syntax
[
'Failed' => [
[
'ErrorCode' => 'InstanceIdNotFound|InvalidInstanceStatus|InstanceIdInUse|InternalServerError',
'Message' => '',
'NodeId' => '',
],
// ...
],
'FailedNodeLogicalIds' => [
[
'ErrorCode' => 'InstanceIdNotFound|InvalidInstanceStatus|InstanceIdInUse|InternalServerError',
'Message' => '',
'NodeLogicalId' => '',
],
// ...
],
'Successful' => ['', ...],
'SuccessfulNodeLogicalIds' => ['', ...],
]
Result Details
Members
- Failed
-
- Type: Array of BatchReplaceClusterNodesError structures
A list of errors encountered for EC2 instance IDs that could not be replaced. Each error includes the instance ID, an error code, and a descriptive message.
- FailedNodeLogicalIds
-
- Type: Array of BatchReplaceClusterNodeLogicalIdsError structures
A list of errors encountered for logical node IDs that could not be replaced. Each error includes the logical node ID, an error code, and a descriptive message. This field is only present when
NodeLogicalIdswere provided in the request. - Successful
-
- Type: Array of strings
A list of EC2 instance IDs for which the replacement operation was successfully initiated.
- SuccessfulNodeLogicalIds
-
- Type: Array of strings
A list of logical node IDs for which the replacement operation was successfully initiated. This field is only present when
NodeLogicalIdswere provided in the request.
Errors
- ResourceNotFound:
Resource being access is not found.
CreateAIBenchmarkJob
$result = $client->createAIBenchmarkJob([/* ... */]); $promise = $client->createAIBenchmarkJobAsync([/* ... */]);
Creates a benchmark job that runs performance benchmarks against inference infrastructure using a predefined AI workload configuration. The benchmark job measures metrics such as latency, throughput, and cost for your generative AI inference endpoints.
Parameter Syntax
$result = $client->createAIBenchmarkJob([
'AIBenchmarkJobName' => '', // REQUIRED
'AIWorkloadConfigIdentifier' => '', // REQUIRED
'BenchmarkTarget' => [ // REQUIRED
'Endpoint' => [
'Identifier' => '', // REQUIRED
'InferenceComponents' => [
[
'Identifier' => '', // REQUIRED
],
// ...
],
'TargetContainerHostname' => '',
],
],
'NetworkConfig' => [
'VpcConfig' => [
'SecurityGroupIds' => ['', ...], // REQUIRED
'Subnets' => ['', ...], // REQUIRED
],
],
'OutputConfig' => [ // REQUIRED
'MlflowConfig' => [
'MlflowExperimentName' => '',
'MlflowResourceArn' => '', // REQUIRED
'MlflowRunName' => '',
],
'S3OutputLocation' => '', // REQUIRED
],
'RoleArn' => '', // REQUIRED
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- AIBenchmarkJobName
-
- Required: Yes
- Type: string
The name of the AI benchmark job. The name must be unique within your Amazon Web Services account in the current Amazon Web Services Region.
- AIWorkloadConfigIdentifier
-
- Required: Yes
- Type: string
The name or Amazon Resource Name (ARN) of the AI workload configuration to use for this benchmark job.
- BenchmarkTarget
-
- Required: Yes
- Type: AIBenchmarkTarget structure
The target endpoint to benchmark. Specify a SageMaker endpoint by providing its name or Amazon Resource Name (ARN).
- NetworkConfig
-
- Type: AIBenchmarkNetworkConfig structure
The network configuration for the benchmark job, including VPC settings.
- OutputConfig
-
- Required: Yes
- Type: AIBenchmarkOutputConfig structure
The output configuration for the benchmark job, including the Amazon S3 location where benchmark results are stored.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.
- Tags
-
- Type: Array of Tag structures
The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define.
Result Syntax
[
'AIBenchmarkJobArn' => '',
]
Result Details
Members
- AIBenchmarkJobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the created benchmark job.
Errors
- ResourceNotFound:
Resource being access is not found.
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateAIRecommendationJob
$result = $client->createAIRecommendationJob([/* ... */]); $promise = $client->createAIRecommendationJobAsync([/* ... */]);
Creates a recommendation job that generates intelligent optimization recommendations for generative AI inference deployments. The job analyzes your model, workload configuration, and performance targets to recommend optimal instance types, model optimization techniques (such as quantization and speculative decoding), and deployment configurations.
Parameter Syntax
$result = $client->createAIRecommendationJob([
'AIRecommendationJobName' => '', // REQUIRED
'AIWorkloadConfigIdentifier' => '', // REQUIRED
'AdapterSource' => [
'ModelPackageArns' => [
[
'AdapterId' => '', // REQUIRED
'ModelPackageArn' => '', // REQUIRED
],
// ...
],
'S3Uris' => [
[
'AdapterId' => '', // REQUIRED
'S3Uri' => '', // REQUIRED
],
// ...
],
],
'ComputeSpec' => [
'CapacityReservationConfig' => [
'CapacityReservationPreference' => 'capacity-reservations-only',
'MlReservationArns' => ['', ...],
],
'InstanceTypes' => ['', ...],
],
'InferenceSpecification' => [
'Framework' => 'LMI|VLLM',
],
'ModelSource' => [ // REQUIRED
'S3' => [
'S3Uri' => '',
],
],
'OptimizeModel' => true || false,
'OutputConfig' => [ // REQUIRED
'MlflowConfig' => [
'MlflowExperimentName' => '',
'MlflowResourceArn' => '', // REQUIRED
'MlflowRunName' => '',
],
'ModelPackageGroupIdentifier' => '',
'S3OutputLocation' => '',
],
'PerformanceTarget' => [ // REQUIRED
'Constraints' => [ // REQUIRED
[
'Metric' => 'ttft-ms|throughput|cost', // REQUIRED
],
// ...
],
],
'RoleArn' => '', // REQUIRED
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- AIRecommendationJobName
-
- Required: Yes
- Type: string
The name of the AI recommendation job. The name must be unique within your Amazon Web Services account in the current Amazon Web Services Region.
- AIWorkloadConfigIdentifier
-
- Required: Yes
- Type: string
The name or Amazon Resource Name (ARN) of the AI workload configuration to use for this recommendation job.
- AdapterSource
-
- Type: AIAdapterSource structure
The LoRA adapter source for the recommendation job. Specify either a list of model package ARNs or Amazon S3 URIs for your LoRA adapters. When this parameter is absent, the recommendation job runs without LoRA adapter support.
- ComputeSpec
-
- Type: AIRecommendationComputeSpec structure
The compute resource specification for the recommendation job. You can specify up to 3 instance types to consider, and optionally provide capacity reservation configuration.
- InferenceSpecification
-
- Type: AIRecommendationInferenceSpecification structure
The inference framework configuration. Specify the framework (such as LMI or vLLM) for the recommendation job.
- ModelSource
-
- Required: Yes
- Type: AIModelSource structure
The source of the model to optimize. Specify the Amazon S3 location of the model artifacts.
- OptimizeModel
-
- Type: boolean
Whether to allow model optimization techniques such as quantization, speculative decoding, and kernel tuning. The default is
true. - OutputConfig
-
- Required: Yes
- Type: AIRecommendationOutputConfig structure
The output configuration for the recommendation job, including the Amazon S3 location for results and an optional model package group where the optimized model is registered.
- PerformanceTarget
-
- Required: Yes
- Type: AIRecommendationPerformanceTarget structure
The performance targets for the recommendation job. Specify constraints on metrics such as time to first token (
ttft-ms),throughput, orcost. - RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.
- Tags
-
- Type: Array of Tag structures
The metadata that you apply to Amazon Web Services resources to help you categorize and organize them.
Result Syntax
[
'AIRecommendationJobArn' => '',
]
Result Details
Members
- AIRecommendationJobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the created recommendation job.
Errors
- ResourceNotFound:
Resource being access is not found.
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateAIWorkloadConfig
$result = $client->createAIWorkloadConfig([/* ... */]); $promise = $client->createAIWorkloadConfigAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->createAIWorkloadConfig([
'AIWorkloadConfigName' => '', // REQUIRED
'AIWorkloadConfigs' => [
'WorkloadSpec' => [ // REQUIRED
'Inline' => '',
],
],
'DatasetConfig' => [
'InputDataConfig' => [
[
'ChannelName' => '', // REQUIRED
'DataSource' => [ // REQUIRED
'S3DataSource' => [
'S3Uri' => '', // REQUIRED
],
],
],
// ...
],
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- AIWorkloadConfigName
-
- Required: Yes
- Type: string
The name of the AI workload configuration. The name must be unique within your Amazon Web Services account in the current Amazon Web Services Region.
- AIWorkloadConfigs
-
- Type: AIWorkloadConfigs structure
The benchmark tool configuration and workload specification. Provide the specification as an inline YAML or JSON string.
- DatasetConfig
-
- Type: AIDatasetConfig structure
The dataset configuration for the workload. Specify input data channels with their data sources for benchmark workloads.
- Tags
-
- Type: Array of Tag structures
The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
Result Syntax
[
'AIWorkloadConfigArn' => '',
]
Result Details
Members
- AIWorkloadConfigArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the created AI workload configuration.
Errors
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateAction
$result = $client->createAction([/* ... */]); $promise = $client->createActionAsync([/* ... */]);
Creates an action. An action is a lineage tracking entity that represents an action or activity. For example, a model deployment or an HPO job. Generally, an action involves at least one input or output artifact. For more information, see Amazon SageMaker ML Lineage Tracking.
Parameter Syntax
$result = $client->createAction([
'ActionName' => '', // REQUIRED
'ActionType' => '', // REQUIRED
'Description' => '',
'MetadataProperties' => [
'CommitId' => '',
'GeneratedBy' => '',
'ProjectId' => '',
'Repository' => '',
],
'Properties' => ['', ...],
'Source' => [ // REQUIRED
'SourceId' => '',
'SourceType' => '',
'SourceUri' => '', // REQUIRED
],
'Status' => 'Unknown|InProgress|Completed|Failed|Stopping|Stopped',
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ActionName
-
- Required: Yes
- Type: string
The name of the action. Must be unique to your account in an Amazon Web Services Region.
- ActionType
-
- Required: Yes
- Type: string
The action type.
- Description
-
- Type: string
The description of the action.
- MetadataProperties
-
- Type: MetadataProperties structure
Metadata properties of the tracking entity, trial, or trial component.
- Properties
-
- Type: Associative array of custom strings keys (StringParameterValue) to strings
A list of properties to add to the action.
- Source
-
- Required: Yes
- Type: ActionSource structure
The source type, ID, and URI.
- Status
-
- Type: string
The status of the action.
- Tags
-
- Type: Array of Tag structures
A list of tags to apply to the action.
Result Syntax
[
'ActionArn' => '',
]
Result Details
Members
- ActionArn
-
- Type: string
The Amazon Resource Name (ARN) of the action.
Errors
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateAlgorithm
$result = $client->createAlgorithm([/* ... */]); $promise = $client->createAlgorithmAsync([/* ... */]);
Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace.
Parameter Syntax
$result = $client->createAlgorithm([
'AlgorithmDescription' => '',
'AlgorithmName' => '', // REQUIRED
'CertifyForMarketplace' => true || false,
'InferenceSpecification' => [
'Containers' => [ // REQUIRED
[
'AdditionalModelDataSources' => [
[
'ChannelName' => '', // REQUIRED
'S3DataSource' => [ // REQUIRED
'CompressionType' => 'None|Gzip', // REQUIRED
'ETag' => '',
'HubAccessConfig' => [
'HubContentArn' => '', // REQUIRED
],
'ManifestEtag' => '',
'ManifestS3Uri' => '',
'ModelAccessConfig' => [
'AcceptEula' => true || false, // REQUIRED
],
'S3DataType' => 'S3Prefix|S3Object', // REQUIRED
'S3Uri' => '', // REQUIRED
],
],
// ...
],
'AdditionalS3DataSource' => [
'CompressionType' => 'None|Gzip',
'ETag' => '',
'S3DataType' => 'S3Object|S3Prefix', // REQUIRED
'S3Uri' => '', // REQUIRED
],
'BaseModel' => [
'HubContentName' => '',
'HubContentVersion' => '',
'RecipeName' => '',
],
'ContainerHostname' => '',
'Environment' => ['', ...],
'Framework' => '',
'FrameworkVersion' => '',
'Image' => '',
'ImageDigest' => '',
'IsCheckpoint' => true || false,
'ModelDataETag' => '',
'ModelDataSource' => [
'S3DataSource' => [
'CompressionType' => 'None|Gzip', // REQUIRED
'ETag' => '',
'HubAccessConfig' => [
'HubContentArn' => '', // REQUIRED
],
'ManifestEtag' => '',
'ManifestS3Uri' => '',
'ModelAccessConfig' => [
'AcceptEula' => true || false, // REQUIRED
],
'S3DataType' => 'S3Prefix|S3Object', // REQUIRED
'S3Uri' => '', // REQUIRED
],
],
'ModelDataUrl' => '',
'ModelInput' => [
'DataInputConfig' => '', // REQUIRED
],
'NearestModelName' => '',
'ProductId' => '',
],
// ...
],
'SupportedContentTypes' => ['', ...],
'SupportedRealtimeInferenceInstanceTypes' => ['', ...],
'SupportedResponseMIMETypes' => ['', ...],
'SupportedTransformInstanceTypes' => ['', ...],
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
'TrainingSpecification' => [ // REQUIRED
'AdditionalS3DataSource' => [
'CompressionType' => 'None|Gzip',
'ETag' => '',
'S3DataType' => 'S3Object|S3Prefix', // REQUIRED
'S3Uri' => '', // REQUIRED
],
'MetricDefinitions' => [
[
'Name' => '', // REQUIRED
'Regex' => '', // REQUIRED
],
// ...
],
'SupportedHyperParameters' => [
[
'DefaultValue' => '',
'Description' => '',
'IsRequired' => true || false,
'IsTunable' => true || false,
'Name' => '', // REQUIRED
'Range' => [
'CategoricalParameterRangeSpecification' => [
'Values' => ['', ...], // REQUIRED
],
'ContinuousParameterRangeSpecification' => [
'MaxValue' => '', // REQUIRED
'MinValue' => '', // REQUIRED
],
'IntegerParameterRangeSpecification' => [
'MaxValue' => '', // REQUIRED
'MinValue' => '', // REQUIRED
],
],
'Type' => 'Integer|Continuous|Categorical|FreeText', // REQUIRED
],
// ...
],
'SupportedTrainingInstanceTypes' => ['', ...], // REQUIRED
'SupportedTuningJobObjectiveMetrics' => [
[
'MetricName' => '', // REQUIRED
'Type' => 'Maximize|Minimize', // REQUIRED
],
// ...
],
'SupportsDistributedTraining' => true || false,
'TrainingChannels' => [ // REQUIRED
[
'Description' => '',
'IsRequired' => true || false,
'Name' => '', // REQUIRED
'SupportedCompressionTypes' => ['', ...],
'SupportedContentTypes' => ['', ...], // REQUIRED
'SupportedInputModes' => ['', ...], // REQUIRED
],
// ...
],
'TrainingImage' => '', // REQUIRED
'TrainingImageDigest' => '',
],
'ValidationSpecification' => [
'ValidationProfiles' => [ // REQUIRED
[
'ProfileName' => '', // REQUIRED
'TrainingJobDefinition' => [ // REQUIRED
'HyperParameters' => ['', ...],
'InputDataConfig' => [ // REQUIRED
[
'ChannelName' => '', // REQUIRED
'CompressionType' => 'None|Gzip',
'ContentType' => '',
'DataSource' => [ // REQUIRED
'DatasetSource' => [
'DatasetArn' => '', // REQUIRED
],
'FileSystemDataSource' => [
'DirectoryPath' => '', // REQUIRED
'FileSystemAccessMode' => 'rw|ro', // REQUIRED
'FileSystemId' => '', // REQUIRED
'FileSystemType' => 'EFS|FSxLustre', // REQUIRED
],
'S3DataSource' => [
'AttributeNames' => ['', ...],
'HubAccessConfig' => [
'HubContentArn' => '', // REQUIRED
],
'InstanceGroupNames' => ['', ...],
'ModelAccessConfig' => [
'AcceptEula' => true || false, // REQUIRED
],
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile|Converse', // REQUIRED
'S3Uri' => '', // REQUIRED
],
],
'InputMode' => 'Pipe|File|FastFile',
'RecordWrapperType' => 'None|RecordIO',
'ShuffleConfig' => [
'Seed' => , // REQUIRED
],
],
// ...
],
'OutputDataConfig' => [ // REQUIRED
'CompressionType' => 'GZIP|NONE',
'KmsKeyId' => '',
'S3OutputPath' => '', // REQUIRED
],
'ResourceConfig' => [ // REQUIRED
'InstanceCount' => ,
'InstanceGroups' => [
[
'InstanceCount' => , // REQUIRED
'InstanceGroupName' => '', // REQUIRED
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge', // REQUIRED
],
// ...
],
'InstancePlacementConfig' => [
'EnableMultipleJobs' => true || false,
'PlacementSpecifications' => [
[
'InstanceCount' => , // REQUIRED
'UltraServerId' => '',
],
// ...
],
],
'InstancePreferences' => [
[
'InstanceCount' => ,
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge', // REQUIRED
'TrainingPlanArns' => ['', ...],
],
// ...
],
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'KeepAlivePeriodInSeconds' => ,
'SelectedInstanceCount' => ,
'SelectedInstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'TrainingPlanArn' => '',
'VolumeKmsKeyId' => '',
'VolumeSizeInGB' => ,
],
'StoppingCondition' => [ // REQUIRED
'MaxPendingTimeInSeconds' => ,
'MaxRuntimeInSeconds' => ,
'MaxWaitTimeInSeconds' => ,
],
'TrainingInputMode' => 'Pipe|File|FastFile', // REQUIRED
],
'TransformJobDefinition' => [
'BatchStrategy' => 'MultiRecord|SingleRecord',
'Environment' => ['', ...],
'MaxConcurrentTransforms' => ,
'MaxPayloadInMB' => ,
'TransformInput' => [ // REQUIRED
'CompressionType' => 'None|Gzip',
'ContentType' => '',
'DataSource' => [ // REQUIRED
'S3DataSource' => [ // REQUIRED
'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile|Converse', // REQUIRED
'S3Uri' => '', // REQUIRED
],
],
'SplitType' => 'None|Line|RecordIO|TFRecord',
],
'TransformOutput' => [ // REQUIRED
'Accept' => '',
'AssembleWith' => 'None|Line',
'KmsKeyId' => '',
'S3OutputPath' => '', // REQUIRED
],
'TransformResources' => [ // REQUIRED
'InstanceCount' => , // REQUIRED
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge', // REQUIRED
'TransformAmiVersion' => '',
'VolumeKmsKeyId' => '',
],
],
],
// ...
],
'ValidationRole' => '', // REQUIRED
],
]);
Parameter Details
Members
- AlgorithmDescription
-
- Type: string
A description of the algorithm.
- AlgorithmName
-
- Required: Yes
- Type: string
The name of the algorithm.
- CertifyForMarketplace
-
- Type: boolean
Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace.
- InferenceSpecification
-
- Type: InferenceSpecification structure
Specifies details about inference jobs that the algorithm runs, including the following:
-
The Amazon ECR paths of containers that contain the inference code and model artifacts.
-
The instance types that the algorithm supports for transform jobs and real-time endpoints used for inference.
-
The input and output content formats that the algorithm supports for inference.
- Tags
-
- 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.
- TrainingSpecification
-
- Required: Yes
- Type: TrainingSpecification structure
Specifies details about training jobs run by this algorithm, including the following:
-
The Amazon ECR path of the container and the version digest of the algorithm.
-
The hyperparameters that the algorithm supports.
-
The instance types that the algorithm supports for training.
-
Whether the algorithm supports distributed training.
-
The metrics that the algorithm emits to Amazon CloudWatch.
-
Which metrics that the algorithm emits can be used as the objective metric for hyperparameter tuning jobs.
-
The input channels that the algorithm supports for training data. For example, an algorithm might support
train,validation, andtestchannels.
- ValidationSpecification
-
- Type: AlgorithmValidationSpecification structure
Specifies configurations for one or more training jobs and that SageMaker runs to test the algorithm's training code and, optionally, one or more batch transform jobs that SageMaker runs to test the algorithm's inference code.
Result Syntax
[
'AlgorithmArn' => '',
]
Result Details
Members
- AlgorithmArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the new algorithm.
Errors
There are no errors described for this operation.
CreateApp
$result = $client->createApp([/* ... */]); $promise = $client->createAppAsync([/* ... */]);
Creates a running app for the specified UserProfile. This operation is automatically invoked by Amazon SageMaker AI upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.
Parameter Syntax
$result = $client->createApp([
'AppName' => '', // REQUIRED
'AppType' => 'JupyterServer|KernelGateway|DetailedProfiler|TensorBoard|CodeEditor|JupyterLab|RStudioServerPro|RSessionGateway|Canvas', // REQUIRED
'DomainId' => '', // REQUIRED
'RecoveryMode' => true || false,
'ResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
'SpaceName' => '',
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
'UserProfileName' => '',
]);
Parameter Details
Members
- AppName
-
- Required: Yes
- Type: string
The name of the app.
- AppType
-
- Required: Yes
- Type: string
The type of app.
- DomainId
-
- Required: Yes
- Type: string
The domain ID.
- RecoveryMode
-
- Type: boolean
Indicates whether the application is launched in recovery mode.
- ResourceSpec
-
- Type: ResourceSpec structure
The instance type and the Amazon Resource Name (ARN) of the SageMaker AI image created on the instance.
The value of
InstanceTypepassed as part of theResourceSpecin theCreateAppcall overrides the value passed as part of theResourceSpecconfigured for the user profile or the domain. IfInstanceTypeis not specified in any of those threeResourceSpecvalues for aKernelGatewayapp, theCreateAppcall fails with a request validation error. - SpaceName
-
- Type: string
The name of the space. If this value is not set, then
UserProfileNamemust be set. - Tags
-
- Type: Array of Tag structures
Each tag consists of a key and an optional value. Tag keys must be unique per resource.
- UserProfileName
-
- Type: string
The user profile name. If this value is not set, then
SpaceNamemust be set.
Result Syntax
[
'AppArn' => '',
]
Result Details
Members
- AppArn
-
- Type: string
The Amazon Resource Name (ARN) of the app.
Errors
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateAppImageConfig
$result = $client->createAppImageConfig([/* ... */]); $promise = $client->createAppImageConfigAsync([/* ... */]);
Creates a configuration for running a SageMaker AI image as a KernelGateway app. The configuration specifies the Amazon Elastic File System storage volume on the image, and a list of the kernels in the image.
Parameter Syntax
$result = $client->createAppImageConfig([
'AppImageConfigName' => '', // REQUIRED
'CodeEditorAppImageConfig' => [
'ContainerConfig' => [
'ContainerArguments' => ['', ...],
'ContainerEntrypoint' => ['', ...],
'ContainerEnvironmentVariables' => ['', ...],
],
'FileSystemConfig' => [
'DefaultGid' => ,
'DefaultUid' => ,
'MountPath' => '',
],
],
'JupyterLabAppImageConfig' => [
'ContainerConfig' => [
'ContainerArguments' => ['', ...],
'ContainerEntrypoint' => ['', ...],
'ContainerEnvironmentVariables' => ['', ...],
],
'FileSystemConfig' => [
'DefaultGid' => ,
'DefaultUid' => ,
'MountPath' => '',
],
],
'KernelGatewayImageConfig' => [
'FileSystemConfig' => [
'DefaultGid' => ,
'DefaultUid' => ,
'MountPath' => '',
],
'KernelSpecs' => [ // REQUIRED
[
'DisplayName' => '',
'Name' => '', // REQUIRED
],
// ...
],
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- AppImageConfigName
-
- Required: Yes
- Type: string
The name of the AppImageConfig. Must be unique to your account.
- CodeEditorAppImageConfig
-
- Type: CodeEditorAppImageConfig structure
The
CodeEditorAppImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel is shown to users before the image starts. After the image runs, all kernels are visible in Code Editor. - JupyterLabAppImageConfig
-
- Type: JupyterLabAppImageConfig structure
The
JupyterLabAppImageConfig. You can only specify one image kernel in theAppImageConfigAPI. This kernel is shown to users before the image starts. After the image runs, all kernels are visible in JupyterLab. - KernelGatewayImageConfig
-
- Type: KernelGatewayImageConfig structure
The KernelGatewayImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel will be shown to users before the image starts. Once the image runs, all kernels are visible in JupyterLab.
- Tags
-
- Type: Array of Tag structures
A list of tags to apply to the AppImageConfig.
Result Syntax
[
'AppImageConfigArn' => '',
]
Result Details
Members
- AppImageConfigArn
-
- Type: string
The ARN of the AppImageConfig.
Errors
- ResourceInUse:
Resource being accessed is in use.
CreateArtifact
$result = $client->createArtifact([/* ... */]); $promise = $client->createArtifactAsync([/* ... */]);
Creates an artifact. An artifact is a lineage tracking entity that represents a URI addressable object or data. Some examples are the S3 URI of a dataset and the ECR registry path of an image. For more information, see Amazon SageMaker ML Lineage Tracking.
Parameter Syntax
$result = $client->createArtifact([
'ArtifactName' => '',
'ArtifactType' => '', // REQUIRED
'MetadataProperties' => [
'CommitId' => '',
'GeneratedBy' => '',
'ProjectId' => '',
'Repository' => '',
],
'Properties' => ['', ...],
'Source' => [ // REQUIRED
'SourceTypes' => [
[
'SourceIdType' => 'MD5Hash|S3ETag|S3Version|Custom', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
'SourceUri' => '', // REQUIRED
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ArtifactName
-
- Type: string
The name of the artifact. Must be unique to your account in an Amazon Web Services Region.
- ArtifactType
-
- Required: Yes
- Type: string
The artifact type.
- MetadataProperties
-
- Type: MetadataProperties structure
Metadata properties of the tracking entity, trial, or trial component.
- Properties
-
- Type: Associative array of custom strings keys (StringParameterValue) to strings
A list of properties to add to the artifact.
- Source
-
- Required: Yes
- Type: ArtifactSource structure
The ID, ID type, and URI of the source.
- Tags
-
- Type: Array of Tag structures
A list of tags to apply to the artifact.
Result Syntax
[
'ArtifactArn' => '',
]
Result Details
Members
- ArtifactArn
-
- Type: string
The Amazon Resource Name (ARN) of the artifact.
Errors
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateAutoMLJob
$result = $client->createAutoMLJob([/* ... */]); $promise = $client->createAutoMLJobAsync([/* ... */]);
Creates an Autopilot job also referred to as Autopilot experiment or AutoML job.
An AutoML job in SageMaker AI is a fully automated process that allows you to build machine learning models with minimal effort and machine learning expertise. When initiating an AutoML job, you provide your data and optionally specify parameters tailored to your use case. SageMaker AI then automates the entire model development lifecycle, including data preprocessing, model training, tuning, and evaluation. AutoML jobs are designed to simplify and accelerate the model building process by automating various tasks and exploring different combinations of machine learning algorithms, data preprocessing techniques, and hyperparameter values. The output of an AutoML job comprises one or more trained models ready for deployment and inference. Additionally, SageMaker AI AutoML jobs generate a candidate model leaderboard, allowing you to select the best-performing model for deployment.
For more information about AutoML jobs, see https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development.html in the SageMaker AI developer guide.
We recommend using the new versions CreateAutoMLJobV2 and DescribeAutoMLJobV2, which offer backward compatibility.
CreateAutoMLJobV2 can manage tabular problem types identical to those of its previous version CreateAutoMLJob, as well as time-series forecasting, non-tabular problem types such as image or text classification, and text generation (LLMs fine-tuning).
Find guidelines about how to migrate a CreateAutoMLJob to CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.
You can find the best-performing model after you run an AutoML job by calling DescribeAutoMLJobV2 (recommended) or DescribeAutoMLJob.
Parameter Syntax
$result = $client->createAutoMLJob([
'AutoMLJobConfig' => [
'CandidateGenerationConfig' => [
'AlgorithmsConfig' => [
[
'AutoMLAlgorithms' => ['', ...], // REQUIRED
],
// ...
],
'FeatureSpecificationS3Uri' => '',
],
'CompletionCriteria' => [
'MaxAutoMLJobRuntimeInSeconds' => ,
'MaxCandidates' => ,
'MaxRuntimePerTrainingJobInSeconds' => ,
],
'DataSplitConfig' => [
'ValidationFraction' => ,
],
'Mode' => 'AUTO|ENSEMBLING|HYPERPARAMETER_TUNING',
'SecurityConfig' => [
'EnableInterContainerTrafficEncryption' => true || false,
'VolumeKmsKeyId' => '',
'VpcConfig' => [
'SecurityGroupIds' => ['', ...], // REQUIRED
'Subnets' => ['', ...], // REQUIRED
],
],
],
'AutoMLJobName' => '', // REQUIRED
'AutoMLJobObjective' => [
'MetricName' => 'Accuracy|MSE|F1|F1macro|AUC|RMSE|BalancedAccuracy|R2|Recall|RecallMacro|Precision|PrecisionMacro|MAE|MAPE|MASE|WAPE|AverageWeightedQuantileLoss', // REQUIRED
],
'GenerateCandidateDefinitionsOnly' => true || false,
'InputDataConfig' => [ // REQUIRED
[
'ChannelType' => 'training|validation',
'CompressionType' => 'None|Gzip',
'ContentType' => '',
'DataSource' => [
'S3DataSource' => [ // REQUIRED
'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile', // REQUIRED
'S3Uri' => '', // REQUIRED
],
],
'SampleWeightAttributeName' => '',
'TargetAttributeName' => '', // REQUIRED
],
// ...
],
'ModelDeployConfig' => [
'AutoGenerateEndpointName' => true || false,
'EndpointName' => '',
],
'OutputDataConfig' => [ // REQUIRED
'KmsKeyId' => '',
'S3OutputPath' => '', // REQUIRED
],
'ProblemType' => 'BinaryClassification|MulticlassClassification|Regression',
'RoleArn' => '', // REQUIRED
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- AutoMLJobConfig
-
- Type: AutoMLJobConfig structure
A collection of settings used to configure an AutoML job.
- AutoMLJobName
-
- Required: Yes
- Type: string
Identifies an Autopilot job. The name must be unique to your account and is case insensitive.
- AutoMLJobObjective
-
- Type: AutoMLJobObjective structure
Specifies a metric to minimize or maximize as the objective of a job. If not specified, the default objective metric depends on the problem type. See AutoMLJobObjective for the default values.
- GenerateCandidateDefinitionsOnly
-
- Type: boolean
Generates possible candidates without training the models. A candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.
- InputDataConfig
-
- Required: Yes
- Type: Array of AutoMLChannel structures
An array of channel objects that describes the input data and its location. Each channel is a named input source. Similar to
InputDataConfigsupported by HyperParameterTrainingJobDefinition. Format(s) supported: CSV, Parquet. A minimum of 500 rows is required for the training dataset. There is not a minimum number of rows required for the validation dataset. - ModelDeployConfig
-
- Type: ModelDeployConfig structure
Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.
- OutputDataConfig
-
- Required: Yes
- Type: AutoMLOutputDataConfig structure
Provides information about encryption and the Amazon S3 output path needed to store artifacts from an AutoML job. Format(s) supported: CSV.
- ProblemType
-
- Type: string
Defines the type of supervised learning problem available for the candidates. For more information, see SageMaker Autopilot problem types.
- RoleArn
-
- Required: Yes
- Type: string
The ARN of the role that is used to access the data.
- Tags
-
- 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 ServicesResources. Tag keys must be unique per resource.
Result Syntax
[
'AutoMLJobArn' => '',
]
Result Details
Members
- AutoMLJobArn
-
- Required: Yes
- Type: string
The unique ARN assigned to the AutoML job when it is created.
Errors
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateAutoMLJobV2
$result = $client->createAutoMLJobV2([/* ... */]); $promise = $client->createAutoMLJobV2Async([/* ... */]);
Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2.
An AutoML job in SageMaker AI is a fully automated process that allows you to build machine learning models with minimal effort and machine learning expertise. When initiating an AutoML job, you provide your data and optionally specify parameters tailored to your use case. SageMaker AI then automates the entire model development lifecycle, including data preprocessing, model training, tuning, and evaluation. AutoML jobs are designed to simplify and accelerate the model building process by automating various tasks and exploring different combinations of machine learning algorithms, data preprocessing techniques, and hyperparameter values. The output of an AutoML job comprises one or more trained models ready for deployment and inference. Additionally, SageMaker AI AutoML jobs generate a candidate model leaderboard, allowing you to select the best-performing model for deployment.
For more information about AutoML jobs, see https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development.html in the SageMaker AI developer guide.
AutoML jobs V2 support various problem types such as regression, binary, and multiclass classification with tabular data, text and image classification, time-series forecasting, and fine-tuning of large language models (LLMs) for text generation.
CreateAutoMLJobV2 and DescribeAutoMLJobV2 are new versions of CreateAutoMLJob and DescribeAutoMLJob which offer backward compatibility.
CreateAutoMLJobV2 can manage tabular problem types identical to those of its previous version CreateAutoMLJob, as well as time-series forecasting, non-tabular problem types such as image or text classification, and text generation (LLMs fine-tuning).
Find guidelines about how to migrate a CreateAutoMLJob to CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.
For the list of available problem types supported by CreateAutoMLJobV2, see AutoMLProblemTypeConfig.
You can find the best-performing model after you run an AutoML job V2 by calling DescribeAutoMLJobV2.
Parameter Syntax
$result = $client->createAutoMLJobV2([
'AutoMLComputeConfig' => [
'EmrServerlessComputeConfig' => [
'ExecutionRoleARN' => '', // REQUIRED
],
],
'AutoMLJobInputDataConfig' => [ // REQUIRED
[
'ChannelType' => 'training|validation',
'CompressionType' => 'None|Gzip',
'ContentType' => '',
'DataSource' => [
'S3DataSource' => [ // REQUIRED
'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile', // REQUIRED
'S3Uri' => '', // REQUIRED
],
],
],
// ...
],
'AutoMLJobName' => '', // REQUIRED
'AutoMLJobObjective' => [
'MetricName' => 'Accuracy|MSE|F1|F1macro|AUC|RMSE|BalancedAccuracy|R2|Recall|RecallMacro|Precision|PrecisionMacro|MAE|MAPE|MASE|WAPE|AverageWeightedQuantileLoss', // REQUIRED
],
'AutoMLProblemTypeConfig' => [ // REQUIRED
'ImageClassificationJobConfig' => [
'CompletionCriteria' => [
'MaxAutoMLJobRuntimeInSeconds' => ,
'MaxCandidates' => ,
'MaxRuntimePerTrainingJobInSeconds' => ,
],
],
'TabularJobConfig' => [
'CandidateGenerationConfig' => [
'AlgorithmsConfig' => [
[
'AutoMLAlgorithms' => ['', ...], // REQUIRED
],
// ...
],
],
'CompletionCriteria' => [
'MaxAutoMLJobRuntimeInSeconds' => ,
'MaxCandidates' => ,
'MaxRuntimePerTrainingJobInSeconds' => ,
],
'FeatureSpecificationS3Uri' => '',
'GenerateCandidateDefinitionsOnly' => true || false,
'Mode' => 'AUTO|ENSEMBLING|HYPERPARAMETER_TUNING',
'ProblemType' => 'BinaryClassification|MulticlassClassification|Regression',
'SampleWeightAttributeName' => '',
'TargetAttributeName' => '', // REQUIRED
],
'TextClassificationJobConfig' => [
'CompletionCriteria' => [
'MaxAutoMLJobRuntimeInSeconds' => ,
'MaxCandidates' => ,
'MaxRuntimePerTrainingJobInSeconds' => ,
],
'ContentColumn' => '', // REQUIRED
'TargetLabelColumn' => '', // REQUIRED
],
'TextGenerationJobConfig' => [
'BaseModelName' => '',
'CompletionCriteria' => [
'MaxAutoMLJobRuntimeInSeconds' => ,
'MaxCandidates' => ,
'MaxRuntimePerTrainingJobInSeconds' => ,
],
'ModelAccessConfig' => [
'AcceptEula' => true || false, // REQUIRED
],
'TextGenerationHyperParameters' => ['', ...],
],
'TimeSeriesForecastingJobConfig' => [
'CandidateGenerationConfig' => [
'AlgorithmsConfig' => [
[
'AutoMLAlgorithms' => ['', ...], // REQUIRED
],
// ...
],
],
'CompletionCriteria' => [
'MaxAutoMLJobRuntimeInSeconds' => ,
'MaxCandidates' => ,
'MaxRuntimePerTrainingJobInSeconds' => ,
],
'FeatureSpecificationS3Uri' => '',
'ForecastFrequency' => '', // REQUIRED
'ForecastHorizon' => , // REQUIRED
'ForecastQuantiles' => ['', ...],
'HolidayConfig' => [
[
'CountryCode' => '',
],
// ...
],
'TimeSeriesConfig' => [ // REQUIRED
'GroupingAttributeNames' => ['', ...],
'ItemIdentifierAttributeName' => '', // REQUIRED
'TargetAttributeName' => '', // REQUIRED
'TimestampAttributeName' => '', // REQUIRED
],
'Transformations' => [
'Aggregation' => ['', ...],
'Filling' => [
'' => ['', ...],
// ...
],
],
],
],
'DataSplitConfig' => [
'ValidationFraction' => ,
],
'ModelDeployConfig' => [
'AutoGenerateEndpointName' => true || false,
'EndpointName' => '',
],
'OutputDataConfig' => [ // REQUIRED
'KmsKeyId' => '',
'S3OutputPath' => '', // REQUIRED
],
'RoleArn' => '', // REQUIRED
'SecurityConfig' => [
'EnableInterContainerTrafficEncryption' => true || false,
'VolumeKmsKeyId' => '',
'VpcConfig' => [
'SecurityGroupIds' => ['', ...], // REQUIRED
'Subnets' => ['', ...], // REQUIRED
],
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- AutoMLComputeConfig
-
- Type: AutoMLComputeConfig structure
Specifies the compute configuration for the AutoML job V2.
- AutoMLJobInputDataConfig
-
- Required: Yes
- Type: Array of AutoMLJobChannel structures
An array of channel objects describing the input data and their location. Each channel is a named input source. Similar to the InputDataConfig attribute in the
CreateAutoMLJobinput parameters. The supported formats depend on the problem type:-
For tabular problem types:
S3Prefix,ManifestFile. -
For image classification:
S3Prefix,ManifestFile,AugmentedManifestFile. -
For text classification:
S3Prefix. -
For time-series forecasting:
S3Prefix. -
For text generation (LLMs fine-tuning):
S3Prefix.
- AutoMLJobName
-
- Required: Yes
- Type: string
Identifies an Autopilot job. The name must be unique to your account and is case insensitive.
- AutoMLJobObjective
-
- Type: AutoMLJobObjective structure
Specifies a metric to minimize or maximize as the objective of a job. If not specified, the default objective metric depends on the problem type. For the list of default values per problem type, see AutoMLJobObjective.
-
For tabular problem types: You must either provide both the
AutoMLJobObjectiveand indicate the type of supervised learning problem inAutoMLProblemTypeConfig(TabularJobConfig.ProblemType), or none at all. -
For text generation problem types (LLMs fine-tuning): Fine-tuning language models in Autopilot does not require setting the
AutoMLJobObjectivefield. Autopilot fine-tunes LLMs without requiring multiple candidates to be trained and evaluated. Instead, using your dataset, Autopilot directly fine-tunes your target model to enhance a default objective metric, the cross-entropy loss. After fine-tuning a language model, you can evaluate the quality of its generated text using different metrics. For a list of the available metrics, see Metrics for fine-tuning LLMs in Autopilot.
- AutoMLProblemTypeConfig
-
- Required: Yes
- Type: AutoMLProblemTypeConfig structure
Defines the configuration settings of one of the supported problem types.
- DataSplitConfig
-
- Type: AutoMLDataSplitConfig structure
This structure specifies how to split the data into train and validation datasets.
The validation and training datasets must contain the same headers. For jobs created by calling
CreateAutoMLJob, the validation dataset must be less than 2 GB in size.This attribute must not be set for the time-series forecasting problem type, as Autopilot automatically splits the input dataset into training and validation sets.
- ModelDeployConfig
-
- Type: ModelDeployConfig structure
Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.
- OutputDataConfig
-
- Required: Yes
- Type: AutoMLOutputDataConfig structure
Provides information about encryption and the Amazon S3 output path needed to store artifacts from an AutoML job.
- RoleArn
-
- Required: Yes
- Type: string
The ARN of the role that is used to access the data.
- SecurityConfig
-
- Type: AutoMLSecurityConfig structure
The security configuration for traffic encryption or Amazon VPC settings.
- Tags
-
- 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, such as by purpose, owner, or environment. For more information, see Tagging Amazon Web ServicesResources. Tag keys must be unique per resource.
Result Syntax
[
'AutoMLJobArn' => '',
]
Result Details
Members
- AutoMLJobArn
-
- Required: Yes
- Type: string
The unique ARN assigned to the AutoMLJob when it is created.
Errors
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateCluster
$result = $client->createCluster([/* ... */]); $promise = $client->createClusterAsync([/* ... */]);
Creates an Amazon SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing persistent clusters for developing large machine learning models, such as large language models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the Amazon SageMaker Developer Guide.
Parameter Syntax
$result = $client->createCluster([
'AutoScaling' => [
'AutoScalerType' => 'Karpenter',
'Mode' => 'Enable|Disable', // REQUIRED
],
'ClusterName' => '', // REQUIRED
'ClusterRole' => '',
'InstanceGroups' => [
[
'AutoPatchConfig' => [
'DeploymentConfig' => [
'AutoRollbackConfiguration' => [
[
'AlarmName' => '', // REQUIRED
],
// ...
],
'RollingUpdatePolicy' => [
'MaximumBatchSize' => [ // REQUIRED
'Type' => 'INSTANCE_COUNT|CAPACITY_PERCENTAGE', // REQUIRED
'Value' => , // REQUIRED
],
'RollbackMaximumBatchSize' => [
'Type' => 'INSTANCE_COUNT|CAPACITY_PERCENTAGE', // REQUIRED
'Value' => , // REQUIRED
],
],
'WaitIntervalInSeconds' => ,
],
'PatchSchedule' => [
'NextPatchDate' => ,
],
'PatchingStrategy' => 'WhenIdle|WhenAllIdle', // REQUIRED
],
'CapacityRequirements' => [
'OnDemand' => [
],
'Spot' => [
],
],
'ExecutionRole' => '', // REQUIRED
'ImageId' => '',
'ImageReleaseVersion' => '',
'InstanceCount' => , // REQUIRED
'InstanceGroupName' => '', // REQUIRED
'InstanceRequirements' => [
'InstanceTypes' => ['', ...], // REQUIRED
],
'InstanceStorageConfigs' => [
[
'EbsVolumeConfig' => [
'RootVolume' => true || false,
'VolumeKmsKeyId' => '',
'VolumeSizeInGB' => ,
],
'FsxLustreConfig' => [
'DnsName' => '', // REQUIRED
'MountName' => '', // REQUIRED
'MountPath' => '',
],
'FsxOpenZfsConfig' => [
'DnsName' => '', // REQUIRED
'MountPath' => '',
],
],
// ...
],
'InstanceType' => 'ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5.4xlarge|ml.p6e-gb200.36xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.c5n.large|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.gr6.4xlarge|ml.gr6.8xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.trn2.3xlarge|ml.trn2.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.i3en.large|ml.i3en.xlarge|ml.i3en.2xlarge|ml.i3en.3xlarge|ml.i3en.6xlarge|ml.i3en.12xlarge|ml.i3en.24xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.r5d.16xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.p6-b300.48xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.c6g.medium|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c7g.medium|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.c6a.large|ml.c6a.xlarge|ml.c6a.2xlarge|ml.c6a.4xlarge|ml.c6a.8xlarge|ml.c6a.12xlarge|ml.c6a.16xlarge|ml.c6a.24xlarge|ml.c6a.32xlarge|ml.c6a.48xlarge|ml.m6a.large|ml.m6a.xlarge|ml.m6a.2xlarge|ml.m6a.4xlarge|ml.m6a.8xlarge|ml.m6a.12xlarge|ml.m6a.16xlarge|ml.m6a.24xlarge|ml.m6a.32xlarge|ml.m6a.48xlarge|ml.m6g.medium|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m7g.medium|ml.m7g.large|ml.m7g.xlarge|ml.m7g.2xlarge|ml.m7g.4xlarge|ml.m7g.8xlarge|ml.m7g.12xlarge|ml.m7g.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.c8a.16xlarge|ml.m8a.16xlarge',
'KubernetesConfig' => [
'Labels' => ['', ...],
'Taints' => [
[
'Effect' => 'NoSchedule|PreferNoSchedule|NoExecute', // REQUIRED
'Key' => '', // REQUIRED
'Value' => '',
],
// ...
],
],
'LifeCycleConfig' => [
'OnCreate' => '',
'OnInitComplete' => '',
'SourceS3Uri' => '',
],
'MinInstanceCount' => ,
'NetworkInterface' => [
'InterfaceType' => 'efa|efa-only',
],
'OnStartDeepHealthChecks' => ['', ...],
'OverrideVpcConfig' => [
'SecurityGroupIds' => ['', ...], // REQUIRED
'Subnets' => ['', ...], // REQUIRED
],
'ScheduledUpdateConfig' => [
'DeploymentConfig' => [
'AutoRollbackConfiguration' => [
[
'AlarmName' => '', // REQUIRED
],
// ...
],
'RollingUpdatePolicy' => [
'MaximumBatchSize' => [ // REQUIRED
'Type' => 'INSTANCE_COUNT|CAPACITY_PERCENTAGE', // REQUIRED
'Value' => , // REQUIRED
],
'RollbackMaximumBatchSize' => [
'Type' => 'INSTANCE_COUNT|CAPACITY_PERCENTAGE', // REQUIRED
'Value' => , // REQUIRED
],
],
'WaitIntervalInSeconds' => ,
],
'ScheduleExpression' => '', // REQUIRED
],
'SlurmConfig' => [
'NodeType' => 'Controller|Login|Compute', // REQUIRED
'PartitionNames' => ['', ...],
],
'ThreadsPerCore' => ,
'TrainingPlanArn' => '',
],
// ...
],
'NodeProvisioningMode' => 'Continuous',
'NodeRecovery' => 'Automatic|None',
'Orchestrator' => [
'Eks' => [
'ClusterArn' => '', // REQUIRED
],
'Slurm' => [
'AccountingDatabase' => [
'Endpoint' => '', // REQUIRED
'Name' => '',
'Port' => ,
'SecretArn' => '', // REQUIRED
],
'SlurmConfigStrategy' => 'Overwrite|Managed|Merge',
],
],
'RestrictedInstanceGroups' => [
[
'EnvironmentConfig' => [
'FSxLustreConfig' => [
'PerUnitStorageThroughput' => , // REQUIRED
'SizeInGiB' => , // REQUIRED
],
],
'ExecutionRole' => '', // REQUIRED
'InstanceCount' => , // REQUIRED
'InstanceGroupName' => '', // REQUIRED
'InstanceStorageConfigs' => [
[
'EbsVolumeConfig' => [
'RootVolume' => true || false,
'VolumeKmsKeyId' => '',
'VolumeSizeInGB' => ,
],
'FsxLustreConfig' => [
'DnsName' => '', // REQUIRED
'MountName' => '', // REQUIRED
'MountPath' => '',
],
'FsxOpenZfsConfig' => [
'DnsName' => '', // REQUIRED
'MountPath' => '',
],
],
// ...
],
'InstanceType' => 'ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5.4xlarge|ml.p6e-gb200.36xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.c5n.large|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.gr6.4xlarge|ml.gr6.8xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.trn2.3xlarge|ml.trn2.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.i3en.large|ml.i3en.xlarge|ml.i3en.2xlarge|ml.i3en.3xlarge|ml.i3en.6xlarge|ml.i3en.12xlarge|ml.i3en.24xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.r5d.16xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.p6-b300.48xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.c6g.medium|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c7g.medium|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.c6a.large|ml.c6a.xlarge|ml.c6a.2xlarge|ml.c6a.4xlarge|ml.c6a.8xlarge|ml.c6a.12xlarge|ml.c6a.16xlarge|ml.c6a.24xlarge|ml.c6a.32xlarge|ml.c6a.48xlarge|ml.m6a.large|ml.m6a.xlarge|ml.m6a.2xlarge|ml.m6a.4xlarge|ml.m6a.8xlarge|ml.m6a.12xlarge|ml.m6a.16xlarge|ml.m6a.24xlarge|ml.m6a.32xlarge|ml.m6a.48xlarge|ml.m6g.medium|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m7g.medium|ml.m7g.large|ml.m7g.xlarge|ml.m7g.2xlarge|ml.m7g.4xlarge|ml.m7g.8xlarge|ml.m7g.12xlarge|ml.m7g.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.c8a.16xlarge|ml.m8a.16xlarge', // REQUIRED
'OnStartDeepHealthChecks' => ['', ...],
'OverrideVpcConfig' => [
'SecurityGroupIds' => ['', ...], // REQUIRED
'Subnets' => ['', ...], // REQUIRED
],
'ScheduledUpdateConfig' => [
'DeploymentConfig' => [
'AutoRollbackConfiguration' => [
[
'AlarmName' => '', // REQUIRED
],
// ...
],
'RollingUpdatePolicy' => [
'MaximumBatchSize' => [ // REQUIRED
'Type' => 'INSTANCE_COUNT|CAPACITY_PERCENTAGE', // REQUIRED
'Value' => , // REQUIRED
],
'RollbackMaximumBatchSize' => [
'Type' => 'INSTANCE_COUNT|CAPACITY_PERCENTAGE', // REQUIRED
'Value' => , // REQUIRED
],
],
'WaitIntervalInSeconds' => ,
],
'ScheduleExpression' => '', // REQUIRED
],
'ThreadsPerCore' => ,
'TrainingPlanArn' => '',
],
// ...
],
'RestrictedInstanceGroupsConfig' => [
'SharedEnvironmentConfig' => [ // REQUIRED
'FSxLustreConfig' => [ // REQUIRED
'PerUnitStorageThroughput' => , // REQUIRED
'SizeInGiB' => , // REQUIRED
],
'FSxLustreDeletionPolicy' => 'DeleteIfNotUsed|Keep', // REQUIRED
],
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
'TieredStorageConfig' => [
'InstanceMemoryAllocationPercentage' => ,
'Mode' => 'Enable|Disable', // REQUIRED
],
'VpcConfig' => [
'SecurityGroupIds' => ['', ...], // REQUIRED
'Subnets' => ['', ...], // REQUIRED
],
]);
Parameter Details
Members
- AutoScaling
-
- Type: ClusterAutoScalingConfig structure
The autoscaling configuration for the cluster. Enables automatic scaling of cluster nodes based on workload demand using a Karpenter-based system.
- ClusterName
-
- Required: Yes
- Type: string
The name for the new SageMaker HyperPod cluster.
- ClusterRole
-
- Type: string
The Amazon Resource Name (ARN) of the IAM role that HyperPod assumes to perform cluster autoscaling operations. This role must have permissions for
sagemaker:BatchAddClusterNodesandsagemaker:BatchDeleteClusterNodes. This is only required when autoscaling is enabled and when HyperPod is performing autoscaling operations. - InstanceGroups
-
- Type: Array of ClusterInstanceGroupSpecification structures
The instance groups to be created in the SageMaker HyperPod cluster.
- NodeProvisioningMode
-
- Type: string
The mode for provisioning nodes in the cluster. You can specify the following modes:
-
Continuous: Scaling behavior that enables 1) concurrent operation execution within instance groups, 2) continuous retry mechanisms for failed operations, 3) enhanced customer visibility into cluster events through detailed event streams, 4) partial provisioning capabilities. Your clusters and instance groups remain
InServicewhile scaling. This mode is only supported for EKS orchestrated clusters.
- NodeRecovery
-
- Type: string
The node recovery mode for the SageMaker HyperPod cluster. When set to
Automatic, SageMaker HyperPod will automatically reboot or replace faulty nodes when issues are detected. When set toNone, cluster administrators will need to manually manage any faulty cluster instances. - Orchestrator
-
- Type: ClusterOrchestrator structure
The type of orchestrator to use for the SageMaker HyperPod cluster. Currently, supported values are
"Eks"and"Slurm", which is to use an Amazon Elastic Kubernetes Service or Slurm cluster as the orchestrator.If you specify the
Orchestratorfield, you must provide exactly one orchestrator configuration: eitherEksorSlurm. Specifying both or providing an empty configuration returns a validation error. - RestrictedInstanceGroups
-
- Type: Array of ClusterRestrictedInstanceGroupSpecification structures
The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.
- RestrictedInstanceGroupsConfig
-
- Type: ClusterRestrictedInstanceGroupsConfig structure
The configuration for the restricted instance groups (RIG) in the SageMaker HyperPod cluster.
- Tags
-
- Type: Array of Tag structures
Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can add tags to your cluster in the same way you add them in other Amazon Web Services services that support tagging. To learn more about tagging Amazon Web Services resources in general, see Tagging Amazon Web Services Resources User Guide.
- TieredStorageConfig
-
- Type: ClusterTieredStorageConfig structure
The configuration for managed tier checkpointing on the HyperPod cluster. When enabled, this feature uses a multi-tier storage approach for storing model checkpoints, providing faster checkpoint operations and improved fault tolerance across cluster nodes.
- VpcConfig
-
- Type: VpcConfig structure
Specifies the Amazon Virtual Private Cloud (VPC) that is associated with the Amazon SageMaker HyperPod cluster. You can control access to and from your resources by configuring your VPC. For more information, see Give SageMaker access to resources in your Amazon VPC.
When your Amazon VPC and subnets support IPv6, network communications differ based on the cluster orchestration platform:
-
Slurm-orchestrated clusters automatically configure nodes with dual IPv6 and IPv4 addresses, allowing immediate IPv6 network communications.
-
In Amazon EKS-orchestrated clusters, nodes receive dual-stack addressing, but pods can only use IPv6 when the Amazon EKS cluster is explicitly IPv6-enabled. For information about deploying an IPv6 Amazon EKS cluster, see Amazon EKS IPv6 Cluster Deployment.
Additional resources for IPv6 configuration:
-
For information about adding IPv6 support to your VPC, see to IPv6 Support for VPC.
-
For information about creating a new IPv6-compatible VPC, see Amazon VPC Creation Guide.
-
To configure SageMaker HyperPod with a custom Amazon VPC, see Custom Amazon VPC Setup for SageMaker HyperPod.
Result Syntax
[
'ClusterArn' => '',
]
Result Details
Members
- ClusterArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the cluster.
Errors
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateClusterSchedulerConfig
$result = $client->createClusterSchedulerConfig([/* ... */]); $promise = $client->createClusterSchedulerConfigAsync([/* ... */]);
Create cluster policy configuration. This policy is used for task prioritization and fair-share allocation of idle compute. This helps prioritize critical workloads and distributes idle compute across entities.
Parameter Syntax
$result = $client->createClusterSchedulerConfig([
'ClusterArn' => '', // REQUIRED
'Description' => '',
'Name' => '', // REQUIRED
'SchedulerConfig' => [ // REQUIRED
'FairShare' => 'Enabled|Disabled',
'IdleResourceSharing' => 'Enabled|Disabled',
'PriorityClasses' => [
[
'Name' => '', // REQUIRED
'Weight' => , // REQUIRED
],
// ...
],
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ClusterArn
-
- Required: Yes
- Type: string
ARN of the cluster.
- Description
-
- Type: string
Description of the cluster policy.
- Name
-
- Required: Yes
- Type: string
The name for the cluster policy. The name must be unique within the SageMaker AI HyperPod cluster specified by
ClusterArn. You can use the same name in other clusters within a Region or across Regions. - SchedulerConfig
-
- Required: Yes
- Type: SchedulerConfig structure
Configuration about the monitoring schedule.
- Tags
-
- Type: Array of Tag structures
Tags of the cluster policy.
Result Syntax
[
'ClusterSchedulerConfigArn' => '',
'ClusterSchedulerConfigId' => '',
]
Result Details
Members
- ClusterSchedulerConfigArn
-
- Required: Yes
- Type: string
ARN of the cluster policy.
- ClusterSchedulerConfigId
-
- Required: Yes
- Type: string
ID of the cluster policy.
Errors
- ConflictException:
There was a conflict when you attempted to modify a SageMaker entity such as an
ExperimentorArtifact.- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateCodeRepository
$result = $client->createCodeRepository([/* ... */]); $promise = $client->createCodeRepositoryAsync([/* ... */]);
Creates a Git repository as a resource in your SageMaker AI account. You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your SageMaker AI account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with.
The repository can be hosted either in Amazon Web Services CodeCommit or in any other Git repository.
Parameter Syntax
$result = $client->createCodeRepository([
'CodeRepositoryName' => '', // REQUIRED
'GitConfig' => [ // REQUIRED
'Branch' => '',
'RepositoryUrl' => '', // REQUIRED
'SecretArn' => '',
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- CodeRepositoryName
-
- Required: Yes
- Type: string
The name of the Git repository. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
- GitConfig
-
- Required: Yes
- Type: GitConfig structure
Specifies details about the repository, including the URL where the repository is located, the default branch, and credentials to use to access the repository.
- Tags
-
- 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
[
'CodeRepositoryArn' => '',
]
Result Details
Members
- CodeRepositoryArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the new repository.
Errors
There are no errors described for this operation.
CreateCompilationJob
$result = $client->createCompilationJob([/* ... */]); $promise = $client->createCompilationJobAsync([/* ... */]);
Starts a model compilation job. After the model has been compiled, Amazon SageMaker AI saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.
If you choose to host your model using Amazon SageMaker AI hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with Amazon Web Services IoT Greengrass. In that case, deploy them as an ML resource.
In the request body, you provide the following:
-
A name for the compilation job
-
Information about the input model artifacts
-
The output location for the compiled model and the device (target) that the model runs on
-
The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker AI assumes to perform the model compilation job.
You can also provide a Tag to track the model compilation job's resource use and costs. The response body contains the CompilationJobArn for the compiled job.
To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.
Parameter Syntax
$result = $client->createCompilationJob([
'CompilationJobName' => '', // REQUIRED
'InputConfig' => [
'DataInputConfig' => '',
'Framework' => 'TENSORFLOW|KERAS|MXNET|ONNX|PYTORCH|XGBOOST|TFLITE|DARKNET|SKLEARN', // REQUIRED
'FrameworkVersion' => '',
'S3Uri' => '', // REQUIRED
],
'ModelPackageVersionArn' => '',
'OutputConfig' => [ // REQUIRED
'CompilerOptions' => '',
'KmsKeyId' => '',
'S3OutputLocation' => '', // REQUIRED
'TargetDevice' => 'lambda|ml_m4|ml_m5|ml_m6g|ml_c4|ml_c5|ml_c6g|ml_p2|ml_p3|ml_g4dn|ml_inf1|ml_inf2|ml_trn1|ml_eia2|jetson_tx1|jetson_tx2|jetson_nano|jetson_xavier|rasp3b|rasp4b|imx8qm|deeplens|rk3399|rk3288|aisage|sbe_c|qcs605|qcs603|sitara_am57x|amba_cv2|amba_cv22|amba_cv25|x86_win32|x86_win64|coreml|jacinto_tda4vm|imx8mplus',
'TargetPlatform' => [
'Accelerator' => 'INTEL_GRAPHICS|MALI|NVIDIA|NNA',
'Arch' => 'X86_64|X86|ARM64|ARM_EABI|ARM_EABIHF', // REQUIRED
'Os' => 'ANDROID|LINUX', // REQUIRED
],
],
'RoleArn' => '', // REQUIRED
'StoppingCondition' => [ // REQUIRED
'MaxPendingTimeInSeconds' => ,
'MaxRuntimeInSeconds' => ,
'MaxWaitTimeInSeconds' => ,
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
'VpcConfig' => [
'SecurityGroupIds' => ['', ...], // REQUIRED
'Subnets' => ['', ...], // REQUIRED
],
]);
Parameter Details
Members
- CompilationJobName
-
- Required: Yes
- Type: string
A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.
- InputConfig
-
- Type: InputConfig structure
Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.
- ModelPackageVersionArn
-
- Type: string
The Amazon Resource Name (ARN) of a versioned model package. Provide either a
ModelPackageVersionArnor anInputConfigobject in the request syntax. The presence of both objects in theCreateCompilationJobrequest will return an exception. - OutputConfig
-
- Required: Yes
- Type: OutputConfig structure
Provides information about the output location for the compiled model and the target device the model runs on.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.
During model compilation, Amazon SageMaker AI needs your permission to:
-
Read input data from an S3 bucket
-
Write model artifacts to an S3 bucket
-
Write logs to Amazon CloudWatch Logs
-
Publish metrics to Amazon CloudWatch
You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker AI, the caller of this API must have the
iam:PassRolepermission. For more information, see Amazon SageMaker AI Roles. - StoppingCondition
-
- Required: Yes
- Type: StoppingCondition structure
Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker AI ends the compilation job. Use this API to cap model training costs.
- Tags
-
- 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.
- VpcConfig
-
- Type: NeoVpcConfig structure
A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.
Result Syntax
[
'CompilationJobArn' => '',
]
Result Details
Members
- CompilationJobArn
-
- Required: Yes
- Type: string
If the action is successful, the service sends back an HTTP 200 response. Amazon SageMaker AI returns the following data in JSON format:
-
CompilationJobArn: The Amazon Resource Name (ARN) of the compiled job.
Errors
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateComputeQuota
$result = $client->createComputeQuota([/* ... */]); $promise = $client->createComputeQuotaAsync([/* ... */]);
Create compute allocation definition. This defines how compute is allocated, shared, and borrowed for specified entities. Specifically, how to lend and borrow idle compute and assign a fair-share weight to the specified entities.
Parameter Syntax
$result = $client->createComputeQuota([
'ActivationState' => 'Enabled|Disabled',
'ClusterArn' => '', // REQUIRED
'ComputeQuotaConfig' => [ // REQUIRED
'ComputeQuotaResources' => [
[
'AcceleratorPartition' => [
'Count' => , // REQUIRED
'Type' => 'mig-1g.5gb|mig-1g.10gb|mig-1g.18gb|mig-1g.20gb|mig-1g.23gb|mig-1g.35gb|mig-1g.45gb|mig-1g.47gb|mig-2g.10gb|mig-2g.20gb|mig-2g.35gb|mig-2g.45gb|mig-2g.47gb|mig-3g.20gb|mig-3g.40gb|mig-3g.71gb|mig-3g.90gb|mig-3g.93gb|mig-4g.20gb|mig-4g.40gb|mig-4g.71gb|mig-4g.90gb|mig-4g.93gb|mig-7g.40gb|mig-7g.80gb|mig-7g.141gb|mig-7g.180gb|mig-7g.186gb', // REQUIRED
],
'Accelerators' => ,
'Count' => ,
'InstanceType' => 'ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5.4xlarge|ml.p6e-gb200.36xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.c5n.large|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.gr6.4xlarge|ml.gr6.8xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.trn2.3xlarge|ml.trn2.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.i3en.large|ml.i3en.xlarge|ml.i3en.2xlarge|ml.i3en.3xlarge|ml.i3en.6xlarge|ml.i3en.12xlarge|ml.i3en.24xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.r5d.16xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.p6-b300.48xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.c6g.medium|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c7g.medium|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.c6a.large|ml.c6a.xlarge|ml.c6a.2xlarge|ml.c6a.4xlarge|ml.c6a.8xlarge|ml.c6a.12xlarge|ml.c6a.16xlarge|ml.c6a.24xlarge|ml.c6a.32xlarge|ml.c6a.48xlarge|ml.m6a.large|ml.m6a.xlarge|ml.m6a.2xlarge|ml.m6a.4xlarge|ml.m6a.8xlarge|ml.m6a.12xlarge|ml.m6a.16xlarge|ml.m6a.24xlarge|ml.m6a.32xlarge|ml.m6a.48xlarge|ml.m6g.medium|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m7g.medium|ml.m7g.large|ml.m7g.xlarge|ml.m7g.2xlarge|ml.m7g.4xlarge|ml.m7g.8xlarge|ml.m7g.12xlarge|ml.m7g.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.c8a.16xlarge|ml.m8a.16xlarge', // REQUIRED
'MemoryInGiB' => ,
'VCpu' => ,
],
// ...
],
'PreemptTeamTasks' => 'Never|LowerPriority',
'ResourceSharingConfig' => [
'AbsoluteBorrowLimits' => [
[
'AcceleratorPartition' => [
'Count' => , // REQUIRED
'Type' => 'mig-1g.5gb|mig-1g.10gb|mig-1g.18gb|mig-1g.20gb|mig-1g.23gb|mig-1g.35gb|mig-1g.45gb|mig-1g.47gb|mig-2g.10gb|mig-2g.20gb|mig-2g.35gb|mig-2g.45gb|mig-2g.47gb|mig-3g.20gb|mig-3g.40gb|mig-3g.71gb|mig-3g.90gb|mig-3g.93gb|mig-4g.20gb|mig-4g.40gb|mig-4g.71gb|mig-4g.90gb|mig-4g.93gb|mig-7g.40gb|mig-7g.80gb|mig-7g.141gb|mig-7g.180gb|mig-7g.186gb', // REQUIRED
],
'Accelerators' => ,
'Count' => ,
'InstanceType' => 'ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5.4xlarge|ml.p6e-gb200.36xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.c5n.large|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.gr6.4xlarge|ml.gr6.8xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.trn2.3xlarge|ml.trn2.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.i3en.large|ml.i3en.xlarge|ml.i3en.2xlarge|ml.i3en.3xlarge|ml.i3en.6xlarge|ml.i3en.12xlarge|ml.i3en.24xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.r5d.16xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.p6-b300.48xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.c6g.medium|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c7g.medium|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.c6a.large|ml.c6a.xlarge|ml.c6a.2xlarge|ml.c6a.4xlarge|ml.c6a.8xlarge|ml.c6a.12xlarge|ml.c6a.16xlarge|ml.c6a.24xlarge|ml.c6a.32xlarge|ml.c6a.48xlarge|ml.m6a.large|ml.m6a.xlarge|ml.m6a.2xlarge|ml.m6a.4xlarge|ml.m6a.8xlarge|ml.m6a.12xlarge|ml.m6a.16xlarge|ml.m6a.24xlarge|ml.m6a.32xlarge|ml.m6a.48xlarge|ml.m6g.medium|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m7g.medium|ml.m7g.large|ml.m7g.xlarge|ml.m7g.2xlarge|ml.m7g.4xlarge|ml.m7g.8xlarge|ml.m7g.12xlarge|ml.m7g.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.c8a.16xlarge|ml.m8a.16xlarge', // REQUIRED
'MemoryInGiB' => ,
'VCpu' => ,
],
// ...
],
'BorrowLimit' => ,
'Strategy' => 'Lend|DontLend|LendAndBorrow', // REQUIRED
],
],
'ComputeQuotaTarget' => [ // REQUIRED
'FairShareWeight' => ,
'TeamName' => '', // REQUIRED
],
'Description' => '',
'Name' => '', // REQUIRED
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ActivationState
-
- Type: string
The state of the compute allocation being described. Use to enable or disable compute allocation.
Default is
Enabled. - ClusterArn
-
- Required: Yes
- Type: string
ARN of the cluster.
- ComputeQuotaConfig
-
- Required: Yes
- Type: ComputeQuotaConfig structure
Configuration of the compute allocation definition. This includes the resource sharing option, and the setting to preempt low priority tasks.
- ComputeQuotaTarget
-
- Required: Yes
- Type: ComputeQuotaTarget structure
The target entity to allocate compute resources to.
- Description
-
- Type: string
Description of the compute allocation definition.
- Name
-
- Required: Yes
- Type: string
The name of the compute allocation definition. The name must be unique within the SageMaker AI HyperPod cluster specified by
ClusterArn. You can use the same name in other clusters within a Region or across Regions. - Tags
-
- Type: Array of Tag structures
Tags of the compute allocation definition.
Result Syntax
[
'ComputeQuotaArn' => '',
'ComputeQuotaId' => '',
]
Result Details
Members
- ComputeQuotaArn
-
- Required: Yes
- Type: string
ARN of the compute allocation definition.
- ComputeQuotaId
-
- Required: Yes
- Type: string
ID of the compute allocation definition.
Errors
- ConflictException:
There was a conflict when you attempted to modify a SageMaker entity such as an
ExperimentorArtifact.- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateContext
$result = $client->createContext([/* ... */]); $promise = $client->createContextAsync([/* ... */]);
Creates a context. A context is a lineage tracking entity that represents a logical grouping of other tracking or experiment entities. Some examples are an endpoint and a model package. For more information, see Amazon SageMaker ML Lineage Tracking.
Parameter Syntax
$result = $client->createContext([
'ContextName' => '', // REQUIRED
'ContextType' => '', // REQUIRED
'Description' => '',
'Properties' => ['', ...],
'Source' => [ // REQUIRED
'SourceId' => '',
'SourceType' => '',
'SourceUri' => '', // REQUIRED
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ContextName
-
- Required: Yes
- Type: string
The name of the context. Must be unique to your account in an Amazon Web Services Region.
- ContextType
-
- Required: Yes
- Type: string
The context type.
- Description
-
- Type: string
The description of the context.
- Properties
-
- Type: Associative array of custom strings keys (StringParameterValue) to strings
A list of properties to add to the context.
- Source
-
- Required: Yes
- Type: ContextSource structure
The source type, ID, and URI.
- Tags
-
- Type: Array of Tag structures
A list of tags to apply to the context.
Result Syntax
[
'ContextArn' => '',
]
Result Details
Members
- ContextArn
-
- Type: string
The Amazon Resource Name (ARN) of the context.
Errors
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateDataQualityJobDefinition
$result = $client->createDataQualityJobDefinition([/* ... */]); $promise = $client->createDataQualityJobDefinitionAsync([/* ... */]);
Creates a definition for a job that monitors data quality and drift. For information about model monitor, see Amazon SageMaker AI Model Monitor.
Parameter Syntax
$result = $client->createDataQualityJobDefinition([
'DataQualityAppSpecification' => [ // REQUIRED
'ContainerArguments' => ['', ...],
'ContainerEntrypoint' => ['', ...],
'Environment' => ['', ...],
'ImageUri' => '', // REQUIRED
'PostAnalyticsProcessorSourceUri' => '',
'RecordPreprocessorSourceUri' => '',
],
'DataQualityBaselineConfig' => [
'BaseliningJobName' => '',
'ConstraintsResource' => [
'S3Uri' => '',
],
'StatisticsResource' => [
'S3Uri' => '',
],
],
'DataQualityJobInput' => [ // REQUIRED
'BatchTransformInput' => [
'DataCapturedDestinationS3Uri' => '', // REQUIRED
'DatasetFormat' => [ // REQUIRED
'Csv' => [
'Header' => true || false,
],
'Json' => [
'Line' => true || false,
],
'Parquet' => [
],
],
'EndTimeOffset' => '',
'ExcludeFeaturesAttribute' => '',
'FeaturesAttribute' => '',
'InferenceAttribute' => '',
'LocalPath' => '', // REQUIRED
'ProbabilityAttribute' => '',
'ProbabilityThresholdAttribute' => ,
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3InputMode' => 'Pipe|File',
'StartTimeOffset' => '',
],
'EndpointInput' => [
'EndTimeOffset' => '',
'EndpointName' => '', // REQUIRED
'ExcludeFeaturesAttribute' => '',
'FeaturesAttribute' => '',
'InferenceAttribute' => '',
'LocalPath' => '', // REQUIRED
'ProbabilityAttribute' => '',
'ProbabilityThresholdAttribute' => ,
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3InputMode' => 'Pipe|File',
'StartTimeOffset' => '',
],
],
'DataQualityJobOutputConfig' => [ // REQUIRED
'KmsKeyId' => '',
'MonitoringOutputs' => [ // REQUIRED
[
'S3Output' => [ // REQUIRED
'LocalPath' => '', // REQUIRED
'S3UploadMode' => 'Continuous|EndOfJob',
'S3Uri' => '', // REQUIRED
],
],
// ...
],
],
'JobDefinitionName' => '', // REQUIRED
'JobResources' => [ // REQUIRED
'ClusterConfig' => [ // REQUIRED
'InstanceCount' => , // REQUIRED
'InstanceType' => 'ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p5.4xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge', // REQUIRED
'VolumeKmsKeyId' => '',
'VolumeSizeInGB' => , // REQUIRED
],
],
'NetworkConfig' => [
'EnableInterContainerTrafficEncryption' => true || false,
'EnableNetworkIsolation' => true || false,
'VpcConfig' => [
'SecurityGroupIds' => ['', ...], // REQUIRED
'Subnets' => ['', ...], // REQUIRED
],
],
'RoleArn' => '', // REQUIRED
'StoppingCondition' => [
'MaxRuntimeInSeconds' => , // REQUIRED
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- DataQualityAppSpecification
-
- Required: Yes
- Type: DataQualityAppSpecification structure
Specifies the container that runs the monitoring job.
- DataQualityBaselineConfig
-
- Type: DataQualityBaselineConfig structure
Configures the constraints and baselines for the monitoring job.
- DataQualityJobInput
-
- Required: Yes
- Type: DataQualityJobInput structure
A list of inputs for the monitoring job. Currently endpoints are supported as monitoring inputs.
- DataQualityJobOutputConfig
-
- Required: Yes
- Type: MonitoringOutputConfig structure
The output configuration for monitoring jobs.
- JobDefinitionName
-
- Required: Yes
- Type: string
The name for the monitoring job definition.
- JobResources
-
- Required: Yes
- Type: MonitoringResources structure
Identifies the resources to deploy for a monitoring job.
- NetworkConfig
-
- Type: MonitoringNetworkConfig structure
Specifies networking configuration for the monitoring job.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.
- StoppingCondition
-
- Type: MonitoringStoppingCondition structure
A time limit for how long the monitoring job is allowed to run before stopping.
- Tags
-
- Type: Array of Tag structures
(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
Result Syntax
[
'JobDefinitionArn' => '',
]
Result Details
Members
- JobDefinitionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the job definition.
Errors
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateDeviceFleet
$result = $client->createDeviceFleet([/* ... */]); $promise = $client->createDeviceFleetAsync([/* ... */]);
Creates a device fleet.
Parameter Syntax
$result = $client->createDeviceFleet([
'Description' => '',
'DeviceFleetName' => '', // REQUIRED
'EnableIotRoleAlias' => true || false,
'OutputConfig' => [ // REQUIRED
'KmsKeyId' => '',
'PresetDeploymentConfig' => '',
'PresetDeploymentType' => 'GreengrassV2Component',
'S3OutputLocation' => '', // REQUIRED
],
'RoleArn' => '',
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- Description
-
- Type: string
A description of the fleet.
- DeviceFleetName
-
- Required: Yes
- Type: string
The name of the fleet that the device belongs to.
- EnableIotRoleAlias
-
- Type: boolean
Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. The name of the role alias generated will match this pattern: "SageMakerEdge-{DeviceFleetName}".
For example, if your device fleet is called "demo-fleet", the name of the role alias will be "SageMakerEdge-demo-fleet".
- OutputConfig
-
- Required: Yes
- Type: EdgeOutputConfig structure
The output configuration for storing sample data collected by the fleet.
- RoleArn
-
- Type: string
The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).
- Tags
-
- Type: Array of Tag structures
Creates tags for the specified fleet.
Result Syntax
[]
Result Details
Errors
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateDomain
$result = $client->createDomain([/* ... */]); $promise = $client->createDomainAsync([/* ... */]);
Creates a Domain. A domain consists of an associated Amazon Elastic File System volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files and other artifacts with each other.
EFS storage
When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.
SageMaker AI uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, you can specify a customer managed key. For more information, see Protect Data at Rest Using Encryption.
VPC configuration
All traffic between the domain and the Amazon EFS volume is through the specified VPC and subnets. For other traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to the domain. The following options are available:
-
PublicInternetOnly- Non-EFS traffic goes through a VPC managed by Amazon SageMaker AI, which allows internet access. This is the default value. -
VpcOnly- All traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway.When internet access is disabled, you won't be able to run a Amazon SageMaker AI Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker AI API and runtime or a NAT gateway and your security groups allow outbound connections.
NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a Amazon SageMaker AI Studio app successfully.
For more information, see Connect Amazon SageMaker AI Studio Notebooks to Resources in a VPC.
Parameter Syntax
$result = $client->createDomain([
'AppNetworkAccessType' => 'PublicInternetOnly|VpcOnly',
'AppSecurityGroupManagement' => 'Service|Customer',
'AuthMode' => 'SSO|IAM', // REQUIRED
'DefaultSpaceSettings' => [
'CustomFileSystemConfigs' => [
[
'EFSFileSystemConfig' => [
'FileSystemId' => '', // REQUIRED
'FileSystemPath' => '',
],
'FSxLustreFileSystemConfig' => [
'FileSystemId' => '', // REQUIRED
'FileSystemPath' => '',
],
'S3FileSystemConfig' => [
'MountPath' => '',
'S3Uri' => '', // REQUIRED
],
],
// ...
],
'CustomPosixUserConfig' => [
'Gid' => , // REQUIRED
'Uid' => , // REQUIRED
],
'ExecutionRole' => '',
'JupyterLabAppSettings' => [
'AppLifecycleManagement' => [
'IdleSettings' => [
'IdleTimeoutInMinutes' => ,
'LifecycleManagement' => 'ENABLED|DISABLED',
'MaxIdleTimeoutInMinutes' => ,
'MinIdleTimeoutInMinutes' => ,
],
],
'BuiltInLifecycleConfigArn' => '',
'CodeRepositories' => [
[
'RepositoryUrl' => '', // REQUIRED
],
// ...
],
'CustomImages' => [
[
'AppImageConfigName' => '', // REQUIRED
'ImageName' => '', // REQUIRED
'ImageVersionNumber' => ,
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
'EmrSettings' => [
'AssumableRoleArns' => ['', ...],
'ExecutionRoleArns' => ['', ...],
],
'LifecycleConfigArns' => ['', ...],
],
'JupyterServerAppSettings' => [
'CodeRepositories' => [
[
'RepositoryUrl' => '', // REQUIRED
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
'LifecycleConfigArns' => ['', ...],
],
'KernelGatewayAppSettings' => [
'CustomImages' => [
[
'AppImageConfigName' => '', // REQUIRED
'ImageName' => '', // REQUIRED
'ImageVersionNumber' => ,
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
'LifecycleConfigArns' => ['', ...],
],
'SecurityGroups' => ['', ...],
'SpaceStorageSettings' => [
'DefaultEbsStorageSettings' => [
'DefaultEbsVolumeSizeInGb' => , // REQUIRED
'MaximumEbsVolumeSizeInGb' => , // REQUIRED
],
],
],
'DefaultUserSettings' => [ // REQUIRED
'AutoMountHomeEFS' => 'Enabled|Disabled|DefaultAsDomain',
'CanvasAppSettings' => [
'DirectDeploySettings' => [
'Status' => 'ENABLED|DISABLED',
],
'EmrServerlessSettings' => [
'ExecutionRoleArn' => '',
'Status' => 'ENABLED|DISABLED',
],
'GenerativeAiSettings' => [
'AmazonBedrockRoleArn' => '',
],
'IdentityProviderOAuthSettings' => [
[
'DataSourceName' => 'SalesforceGenie|Snowflake',
'SecretArn' => '',
'Status' => 'ENABLED|DISABLED',
],
// ...
],
'KendraSettings' => [
'Status' => 'ENABLED|DISABLED',
],
'ModelRegisterSettings' => [
'CrossAccountModelRegisterRoleArn' => '',
'Status' => 'ENABLED|DISABLED',
],
'TimeSeriesForecastingSettings' => [
'AmazonForecastRoleArn' => '',
'Status' => 'ENABLED|DISABLED',
],
'WorkspaceSettings' => [
'S3ArtifactPath' => '',
'S3KmsKeyId' => '',
],
],
'CodeEditorAppSettings' => [
'AppLifecycleManagement' => [
'IdleSettings' => [
'IdleTimeoutInMinutes' => ,
'LifecycleManagement' => 'ENABLED|DISABLED',
'MaxIdleTimeoutInMinutes' => ,
'MinIdleTimeoutInMinutes' => ,
],
],
'BuiltInLifecycleConfigArn' => '',
'CustomImages' => [
[
'AppImageConfigName' => '', // REQUIRED
'ImageName' => '', // REQUIRED
'ImageVersionNumber' => ,
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
'LifecycleConfigArns' => ['', ...],
],
'CustomFileSystemConfigs' => [
[
'EFSFileSystemConfig' => [
'FileSystemId' => '', // REQUIRED
'FileSystemPath' => '',
],
'FSxLustreFileSystemConfig' => [
'FileSystemId' => '', // REQUIRED
'FileSystemPath' => '',
],
'S3FileSystemConfig' => [
'MountPath' => '',
'S3Uri' => '', // REQUIRED
],
],
// ...
],
'CustomPosixUserConfig' => [
'Gid' => , // REQUIRED
'Uid' => , // REQUIRED
],
'DefaultLandingUri' => '',
'ExecutionRole' => '',
'JupyterLabAppSettings' => [
'AppLifecycleManagement' => [
'IdleSettings' => [
'IdleTimeoutInMinutes' => ,
'LifecycleManagement' => 'ENABLED|DISABLED',
'MaxIdleTimeoutInMinutes' => ,
'MinIdleTimeoutInMinutes' => ,
],
],
'BuiltInLifecycleConfigArn' => '',
'CodeRepositories' => [
[
'RepositoryUrl' => '', // REQUIRED
],
// ...
],
'CustomImages' => [
[
'AppImageConfigName' => '', // REQUIRED
'ImageName' => '', // REQUIRED
'ImageVersionNumber' => ,
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
'EmrSettings' => [
'AssumableRoleArns' => ['', ...],
'ExecutionRoleArns' => ['', ...],
],
'LifecycleConfigArns' => ['', ...],
],
'JupyterServerAppSettings' => [
'CodeRepositories' => [
[
'RepositoryUrl' => '', // REQUIRED
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
'LifecycleConfigArns' => ['', ...],
],
'KernelGatewayAppSettings' => [
'CustomImages' => [
[
'AppImageConfigName' => '', // REQUIRED
'ImageName' => '', // REQUIRED
'ImageVersionNumber' => ,
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
'LifecycleConfigArns' => ['', ...],
],
'RSessionAppSettings' => [
'CustomImages' => [
[
'AppImageConfigName' => '', // REQUIRED
'ImageName' => '', // REQUIRED
'ImageVersionNumber' => ,
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
],
'RStudioServerProAppSettings' => [
'AccessStatus' => 'ENABLED|DISABLED',
'UserGroup' => 'R_STUDIO_ADMIN|R_STUDIO_USER',
],
'SecurityGroups' => ['', ...],
'SharingSettings' => [
'NotebookOutputOption' => 'Allowed|Disabled',
'S3KmsKeyId' => '',
'S3OutputPath' => '',
],
'SpaceStorageSettings' => [
'DefaultEbsStorageSettings' => [
'DefaultEbsVolumeSizeInGb' => , // REQUIRED
'MaximumEbsVolumeSizeInGb' => , // REQUIRED
],
],
'StudioWebPortal' => 'ENABLED|DISABLED',
'StudioWebPortalSettings' => [
'ExecutionRoleSessionNameMode' => 'STATIC|USER_IDENTITY',
'HiddenAppTypes' => ['', ...],
'HiddenInstanceTypes' => ['', ...],
'HiddenMlTools' => ['', ...],
'HiddenSageMakerImageVersionAliases' => [
[
'SageMakerImageName' => 'sagemaker_distribution',
'VersionAliases' => ['', ...],
],
// ...
],
],
'TensorBoardAppSettings' => [
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
],
],
'DomainName' => '', // REQUIRED
'DomainSettings' => [
'AmazonQSettings' => [
'QProfileArn' => '',
'Status' => 'ENABLED|DISABLED',
],
'DockerSettings' => [
'EnableDockerAccess' => 'ENABLED|DISABLED',
'RootlessDocker' => 'ENABLED|DISABLED',
'VpcOnlyTrustedAccounts' => ['', ...],
],
'ExecutionRoleIdentityConfig' => 'USER_PROFILE_NAME|DISABLED',
'IpAddressType' => 'ipv4|dualstack',
'RStudioServerProDomainSettings' => [
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
'DomainExecutionRoleArn' => '', // REQUIRED
'RStudioConnectUrl' => '',
'RStudioPackageManagerUrl' => '',
],
'SecurityGroupIds' => ['', ...],
'TrustedIdentityPropagationSettings' => [
'Status' => 'ENABLED|DISABLED', // REQUIRED
],
'UnifiedStudioSettings' => [
'DomainAccountId' => '',
'DomainId' => '',
'DomainRegion' => '',
'EnvironmentId' => '',
'ProjectId' => '',
'ProjectS3Path' => '',
'SingleSignOnApplicationArn' => '',
'StudioWebPortalAccess' => 'ENABLED|DISABLED',
],
],
'HomeEfsFileSystemCreation' => 'Enabled|Disabled',
'HomeEfsFileSystemKmsKeyId' => '',
'KmsKeyId' => '',
'SubnetIds' => ['', ...],
'TagPropagation' => 'ENABLED|DISABLED',
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
'VpcId' => '',
]);
Parameter Details
Members
- AppNetworkAccessType
-
- Type: string
Specifies the VPC used for non-EFS traffic. The default value is
PublicInternetOnly.-
PublicInternetOnly- Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access -
VpcOnly- All traffic is through the specified VPC and subnets
- AppSecurityGroupManagement
-
- Type: string
The entity that creates and manages the required security groups for inter-app communication in
VPCOnlymode. Required whenCreateDomain.AppNetworkAccessTypeisVPCOnlyandDomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArnis provided. If setting up the domain for use with RStudio, this value must be set toService. - AuthMode
-
- Required: Yes
- Type: string
The mode of authentication that members use to access the domain.
- DefaultSpaceSettings
-
- Type: DefaultSpaceSettings structure
The default settings for shared spaces that users create in the domain.
- DefaultUserSettings
-
- Required: Yes
- Type: UserSettings structure
The default settings to use to create a user profile when
UserSettingsisn't specified in the call to theCreateUserProfileAPI.SecurityGroupsis aggregated when specified in both calls. For all other settings inUserSettings, the values specified inCreateUserProfiletake precedence over those specified inCreateDomain. - DomainName
-
- Required: Yes
- Type: string
A name for the domain.
- DomainSettings
-
- Type: DomainSettings structure
A collection of
Domainsettings. - HomeEfsFileSystemCreation
-
- Type: string
Indicates whether to create a home EFS file system for the domain. Defaults to
Enabled. Set toDisabledto skip EFS creation and reduce domain creation time. You can enable EFS later by callingUpdateDomain. - HomeEfsFileSystemKmsKeyId
-
- Type: string
Use
KmsKeyId. - KmsKeyId
-
- Type: string
SageMaker AI uses Amazon Web Services KMS to encrypt EFS and EBS volumes attached to the domain with an Amazon Web Services managed key by default. For more control, specify a customer managed key.
- SubnetIds
-
- Type: Array of strings
The VPC subnets that the domain uses for communication.
The field is optional when the
AppNetworkAccessTypeparameter is set toPublicInternetOnlyfor domains created from Amazon SageMaker Unified Studio. - TagPropagation
-
- Type: string
Indicates whether custom tag propagation is supported for the domain. Defaults to
DISABLED. - Tags
-
- Type: Array of Tag structures
Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the
SearchAPI.Tags that you specify for the Domain are also added to all Apps that the Domain launches.
- VpcId
-
- Type: string
The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
The field is optional when the
AppNetworkAccessTypeparameter is set toPublicInternetOnlyfor domains created from Amazon SageMaker Unified Studio.
Result Syntax
[
'DomainArn' => '',
'DomainId' => '',
'Url' => '',
]
Result Details
Members
- DomainArn
-
- Type: string
The Amazon Resource Name (ARN) of the created domain.
- DomainId
-
- Type: string
The ID of the created domain.
- Url
-
- Type: string
The URL to the created domain.
Errors
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateEdgeDeploymentPlan
$result = $client->createEdgeDeploymentPlan([/* ... */]); $promise = $client->createEdgeDeploymentPlanAsync([/* ... */]);
Creates an edge deployment plan, consisting of multiple stages. Each stage may have a different deployment configuration and devices.
Parameter Syntax
$result = $client->createEdgeDeploymentPlan([
'DeviceFleetName' => '', // REQUIRED
'EdgeDeploymentPlanName' => '', // REQUIRED
'ModelConfigs' => [ // REQUIRED
[
'EdgePackagingJobName' => '', // REQUIRED
'ModelHandle' => '', // REQUIRED
],
// ...
],
'Stages' => [
[
'DeploymentConfig' => [
'FailureHandlingPolicy' => 'ROLLBACK_ON_FAILURE|DO_NOTHING', // REQUIRED
],
'DeviceSelectionConfig' => [ // REQUIRED
'DeviceNameContains' => '',
'DeviceNames' => ['', ...],
'DeviceSubsetType' => 'PERCENTAGE|SELECTION|NAMECONTAINS', // REQUIRED
'Percentage' => ,
],
'StageName' => '', // REQUIRED
],
// ...
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- DeviceFleetName
-
- Required: Yes
- Type: string
The device fleet used for this edge deployment plan.
- EdgeDeploymentPlanName
-
- Required: Yes
- Type: string
The name of the edge deployment plan.
- ModelConfigs
-
- Required: Yes
- Type: Array of EdgeDeploymentModelConfig structures
List of models associated with the edge deployment plan.
- Stages
-
- Type: Array of DeploymentStage structures
List of stages of the edge deployment plan. The number of stages is limited to 10 per deployment.
- Tags
-
- Type: Array of Tag structures
List of tags with which to tag the edge deployment plan.
Result Syntax
[
'EdgeDeploymentPlanArn' => '',
]
Result Details
Members
- EdgeDeploymentPlanArn
-
- Required: Yes
- Type: string
The ARN of the edge deployment plan.
Errors
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateEdgeDeploymentStage
$result = $client->createEdgeDeploymentStage([/* ... */]); $promise = $client->createEdgeDeploymentStageAsync([/* ... */]);
Creates a new stage in an existing edge deployment plan.
Parameter Syntax
$result = $client->createEdgeDeploymentStage([
'EdgeDeploymentPlanName' => '', // REQUIRED
'Stages' => [ // REQUIRED
[
'DeploymentConfig' => [
'FailureHandlingPolicy' => 'ROLLBACK_ON_FAILURE|DO_NOTHING', // REQUIRED
],
'DeviceSelectionConfig' => [ // REQUIRED
'DeviceNameContains' => '',
'DeviceNames' => ['', ...],
'DeviceSubsetType' => 'PERCENTAGE|SELECTION|NAMECONTAINS', // REQUIRED
'Percentage' => ,
],
'StageName' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- EdgeDeploymentPlanName
-
- Required: Yes
- Type: string
The name of the edge deployment plan.
- Stages
-
- Required: Yes
- Type: Array of DeploymentStage structures
List of stages to be added to the edge deployment plan.
Result Syntax
[]
Result Details
Errors
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateEdgePackagingJob
$result = $client->createEdgePackagingJob([/* ... */]); $promise = $client->createEdgePackagingJobAsync([/* ... */]);
Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model artifacts from the Amazon Simple Storage Service bucket that you specify. After the model has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket that you specify.
Parameter Syntax
$result = $client->createEdgePackagingJob([
'CompilationJobName' => '', // REQUIRED
'EdgePackagingJobName' => '', // REQUIRED
'ModelName' => '', // REQUIRED
'ModelVersion' => '', // REQUIRED
'OutputConfig' => [ // REQUIRED
'KmsKeyId' => '',
'PresetDeploymentConfig' => '',
'PresetDeploymentType' => 'GreengrassV2Component',
'S3OutputLocation' => '', // REQUIRED
],
'ResourceKey' => '',
'RoleArn' => '', // REQUIRED
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- CompilationJobName
-
- Required: Yes
- Type: string
The name of the SageMaker Neo compilation job that will be used to locate model artifacts for packaging.
- EdgePackagingJobName
-
- Required: Yes
- Type: string
The name of the edge packaging job.
- ModelName
-
- Required: Yes
- Type: string
The name of the model.
- ModelVersion
-
- Required: Yes
- Type: string
The version of the model.
- OutputConfig
-
- Required: Yes
- Type: EdgeOutputConfig structure
Provides information about the output location for the packaged model.
- ResourceKey
-
- Type: string
The Amazon Web Services KMS key to use when encrypting the EBS volume the edge packaging job runs on.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact SageMaker Neo.
- Tags
-
- Type: Array of Tag structures
Creates tags for the packaging job.
Result Syntax
[]
Result Details
Errors
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateEndpoint
$result = $client->createEndpoint([/* ... */]); $promise = $client->createEndpointAsync([/* ... */]);
Creates an endpoint using the endpoint configuration specified in the request. SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API.
Use this API to deploy models using SageMaker hosting services.
You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.
The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account.
When it receives the request, SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them.
When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.
When SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API.
If any of the models hosted at this endpoint get model data from an Amazon S3 location, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.
To add the IAM role policies for using this API operation, go to the IAM console, and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the role.
-
Option 1: For a full SageMaker access, search and attach the
AmazonSageMakerFullAccesspolicy. -
Option 2: For granting a limited access to an IAM role, paste the following Action elements manually into the JSON file of the IAM role:
"Action": ["sagemaker:CreateEndpoint", "sagemaker:CreateEndpointConfig"]"Resource": ["arn:aws:sagemaker:region:account-id:endpoint/endpointName""arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName"]For more information, see SageMaker API Permissions: Actions, Permissions, and Resources Reference.
Parameter Syntax
$result = $client->createEndpoint([
'DeploymentConfig' => [
'AutoRollbackConfiguration' => [
'Alarms' => [
[
'AlarmName' => '',
],
// ...
],
],
'BlueGreenUpdatePolicy' => [
'MaximumExecutionTimeoutInSeconds' => ,
'TerminationWaitInSeconds' => ,
'TrafficRoutingConfiguration' => [ // REQUIRED
'CanarySize' => [
'Type' => 'INSTANCE_COUNT|CAPACITY_PERCENT', // REQUIRED
'Value' => , // REQUIRED
],
'LinearStepSize' => [
'Type' => 'INSTANCE_COUNT|CAPACITY_PERCENT', // REQUIRED
'Value' => , // REQUIRED
],
'Type' => 'ALL_AT_ONCE|CANARY|LINEAR', // REQUIRED
'WaitIntervalInSeconds' => , // REQUIRED
],
],
'RollingUpdatePolicy' => [
'MaximumBatchSize' => [ // REQUIRED
'Type' => 'INSTANCE_COUNT|CAPACITY_PERCENT', // REQUIRED
'Value' => , // REQUIRED
],
'MaximumExecutionTimeoutInSeconds' => ,
'RollbackMaximumBatchSize' => [
'Type' => 'INSTANCE_COUNT|CAPACITY_PERCENT', // REQUIRED
'Value' => , // REQUIRED
],
'WaitIntervalInSeconds' => , // REQUIRED
],
],
'EndpointConfigName' => '', // REQUIRED
'EndpointName' => '', // REQUIRED
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- DeploymentConfig
-
- Type: DeploymentConfig structure
The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
- EndpointConfigName
-
- Required: Yes
- Type: string
The name of an endpoint configuration. For more information, see CreateEndpointConfig.
- EndpointName
-
- Required: Yes
- Type: string
The name of the endpoint.The name must be unique within an Amazon Web Services Region in your Amazon Web Services account. The name is case-insensitive in
CreateEndpoint, but the case is preserved and must be matched in InvokeEndpoint. - Tags
-
- 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
[
'EndpointArn' => '',
]
Result Details
Members
- EndpointArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the endpoint.
Errors
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateEndpointConfig
$result = $client->createEndpointConfig([/* ... */]); $promise = $client->createEndpointConfigAsync([/* ... */]);
Creates an endpoint configuration that SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the CreateModel API, to deploy and the resources that you want SageMaker to provision. Then you call the CreateEndpoint API.
Use this API if you want to use SageMaker hosting services to deploy models into production.
In the request, you define a ProductionVariant, for each model that you want to deploy. Each ProductionVariant parameter also describes the resources that you want SageMaker to provision. This includes the number and type of ML compute instances to deploy.
If you are hosting multiple models, you also assign a VariantWeight to specify how much traffic you want to allocate to each model. For example, suppose that you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B.
When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.
Parameter Syntax
$result = $client->createEndpointConfig([
'AsyncInferenceConfig' => [
'ClientConfig' => [
'MaxConcurrentInvocationsPerInstance' => ,
],
'OutputConfig' => [ // REQUIRED
'KmsKeyId' => '',
'NotificationConfig' => [
'ErrorTopic' => '',
'IncludeInferenceResponseIn' => ['', ...],
'SuccessTopic' => '',
],
'S3FailurePath' => '',
'S3OutputPath' => '',
],
],
'DataCaptureConfig' => [
'CaptureContentTypeHeader' => [
'CsvContentTypes' => ['', ...],
'JsonContentTypes' => ['', ...],
],
'CaptureOptions' => [ // REQUIRED
[
'CaptureMode' => 'Input|Output|InputAndOutput', // REQUIRED
],
// ...
],
'DestinationS3Uri' => '', // REQUIRED
'EnableCapture' => true || false,
'InitialSamplingPercentage' => , // REQUIRED
'KmsKeyId' => '',
],
'EnableNetworkIsolation' => true || false,
'EndpointConfigName' => '', // REQUIRED
'ExecutionRoleArn' => '',
'ExplainerConfig' => [
'ClarifyExplainerConfig' => [
'EnableExplanations' => '',
'InferenceConfig' => [
'ContentTemplate' => '',
'FeatureHeaders' => ['', ...],
'FeatureTypes' => ['', ...],
'FeaturesAttribute' => '',
'LabelAttribute' => '',
'LabelHeaders' => ['', ...],
'LabelIndex' => ,
'MaxPayloadInMB' => ,
'MaxRecordCount' => ,
'ProbabilityAttribute' => '',
'ProbabilityIndex' => ,
],
'ShapConfig' => [ // REQUIRED
'NumberOfSamples' => ,
'Seed' => ,
'ShapBaselineConfig' => [ // REQUIRED
'MimeType' => '',
'ShapBaseline' => '',
'ShapBaselineUri' => '',
],
'TextConfig' => [
'Granularity' => 'token|sentence|paragraph', // REQUIRED
'Language' => 'af|sq|ar|hy|eu|bn|bg|ca|zh|hr|cs|da|nl|en|et|fi|fr|de|el|gu|he|hi|hu|is|id|ga|it|kn|ky|lv|lt|lb|mk|ml|mr|ne|nb|fa|pl|pt|ro|ru|sa|sr|tn|si|sk|sl|es|sv|tl|ta|tt|te|tr|uk|ur|yo|lij|xx', // REQUIRED
],
'UseLogit' => true || false,
],
],
],
'KmsKeyId' => '',
'MetricsConfig' => [
'EnableDetailedObservability' => true || false,
'EnableEnhancedMetrics' => true || false,
'MetricPublishFrequencyInSeconds' => ,
],
'ProductionVariants' => [ // REQUIRED
[
'AcceleratorType' => 'ml.eia1.medium|ml.eia1.large|ml.eia1.xlarge|ml.eia2.medium|ml.eia2.large|ml.eia2.xlarge',
'CapacityReservationConfig' => [
'CapacityReservationPreference' => 'capacity-reservations-only',
'MlReservationArn' => '',
],
'ContainerStartupHealthCheckTimeoutInSeconds' => ,
'CoreDumpConfig' => [
'DestinationS3Uri' => '', // REQUIRED
'KmsKeyId' => '',
],
'EnableSSMAccess' => true || false,
'InferenceAmiVersion' => 'al2-ami-sagemaker-inference-gpu-2|al2-ami-sagemaker-inference-gpu-2-1|al2-ami-sagemaker-inference-gpu-3-1|al2-ami-sagemaker-inference-neuron-2|al2023-ami-sagemaker-inference-gpu-4-1',
'InitialInstanceCount' => ,
'InitialVariantWeight' => ,
'InstancePools' => [
[
'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.12xlarge|ml.m5d.24xlarge|ml.c4.large|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.large|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.12xlarge|ml.r5.24xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.12xlarge|ml.r5d.24xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.dl1.24xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.r8g.medium|ml.r8g.large|ml.r8g.xlarge|ml.r8g.2xlarge|ml.r8g.4xlarge|ml.r8g.8xlarge|ml.r8g.12xlarge|ml.r8g.16xlarge|ml.r8g.24xlarge|ml.r8g.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.p4d.24xlarge|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m6gd.large|ml.m6gd.xlarge|ml.m6gd.2xlarge|ml.m6gd.4xlarge|ml.m6gd.8xlarge|ml.m6gd.12xlarge|ml.m6gd.16xlarge|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c6gd.large|ml.c6gd.xlarge|ml.c6gd.2xlarge|ml.c6gd.4xlarge|ml.c6gd.8xlarge|ml.c6gd.12xlarge|ml.c6gd.16xlarge|ml.c6gn.large|ml.c6gn.xlarge|ml.c6gn.2xlarge|ml.c6gn.4xlarge|ml.c6gn.8xlarge|ml.c6gn.12xlarge|ml.c6gn.16xlarge|ml.r6g.large|ml.r6g.xlarge|ml.r6g.2xlarge|ml.r6g.4xlarge|ml.r6g.8xlarge|ml.r6g.12xlarge|ml.r6g.16xlarge|ml.r6gd.large|ml.r6gd.xlarge|ml.r6gd.2xlarge|ml.r6gd.4xlarge|ml.r6gd.8xlarge|ml.r6gd.12xlarge|ml.r6gd.16xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.r7gd.medium|ml.r7gd.large|ml.r7gd.xlarge|ml.r7gd.2xlarge|ml.r7gd.4xlarge|ml.r7gd.8xlarge|ml.r7gd.12xlarge|ml.r7gd.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.c6in.large|ml.c6in.xlarge|ml.c6in.2xlarge|ml.c6in.4xlarge|ml.c6in.8xlarge|ml.c6in.12xlarge|ml.c6in.16xlarge|ml.c6in.24xlarge|ml.c6in.32xlarge|ml.p6-b200.48xlarge|ml.p6-b300.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge', // REQUIRED
'ModelNameOverride' => '',
'Priority' => , // REQUIRED
],
// ...
],
'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.12xlarge|ml.m5d.24xlarge|ml.c4.large|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.large|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.12xlarge|ml.r5.24xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.12xlarge|ml.r5d.24xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.dl1.24xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.r8g.medium|ml.r8g.large|ml.r8g.xlarge|ml.r8g.2xlarge|ml.r8g.4xlarge|ml.r8g.8xlarge|ml.r8g.12xlarge|ml.r8g.16xlarge|ml.r8g.24xlarge|ml.r8g.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.p4d.24xlarge|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m6gd.large|ml.m6gd.xlarge|ml.m6gd.2xlarge|ml.m6gd.4xlarge|ml.m6gd.8xlarge|ml.m6gd.12xlarge|ml.m6gd.16xlarge|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c6gd.large|ml.c6gd.xlarge|ml.c6gd.2xlarge|ml.c6gd.4xlarge|ml.c6gd.8xlarge|ml.c6gd.12xlarge|ml.c6gd.16xlarge|ml.c6gn.large|ml.c6gn.xlarge|ml.c6gn.2xlarge|ml.c6gn.4xlarge|ml.c6gn.8xlarge|ml.c6gn.12xlarge|ml.c6gn.16xlarge|ml.r6g.large|ml.r6g.xlarge|ml.r6g.2xlarge|ml.r6g.4xlarge|ml.r6g.8xlarge|ml.r6g.12xlarge|ml.r6g.16xlarge|ml.r6gd.large|ml.r6gd.xlarge|ml.r6gd.2xlarge|ml.r6gd.4xlarge|ml.r6gd.8xlarge|ml.r6gd.12xlarge|ml.r6gd.16xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.r7gd.medium|ml.r7gd.large|ml.r7gd.xlarge|ml.r7gd.2xlarge|ml.r7gd.4xlarge|ml.r7gd.8xlarge|ml.r7gd.12xlarge|ml.r7gd.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.c6in.large|ml.c6in.xlarge|ml.c6in.2xlarge|ml.c6in.4xlarge|ml.c6in.8xlarge|ml.c6in.12xlarge|ml.c6in.16xlarge|ml.c6in.24xlarge|ml.c6in.32xlarge|ml.p6-b200.48xlarge|ml.p6-b300.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge',
'ManagedInstanceScaling' => [
'MaxInstanceCount' => ,
'MinInstanceCount' => ,
'ScaleInPolicy' => [
'CooldownInMinutes' => ,
'MaximumStepSize' => ,
'Strategy' => 'IDLE_RELEASE|CONSOLIDATION', // REQUIRED
],
'Status' => 'ENABLED|DISABLED',
],
'ModelDataDownloadTimeoutInSeconds' => ,
'ModelName' => '',
'RoutingConfig' => [
'PrefixAwareRoutingConfig' => [
'ConcurrencyThreshold' => ,
'PrefixLength' => ,
],
'RoutingStrategy' => 'LEAST_OUTSTANDING_REQUESTS|RANDOM|PREFIX_AWARE', // REQUIRED
],
'ServerlessConfig' => [
'MaxConcurrency' => , // REQUIRED
'MemorySizeInMB' => , // REQUIRED
'ProvisionedConcurrency' => ,
],
'VariantInstanceProvisionTimeoutInSeconds' => ,
'VariantName' => '', // REQUIRED
'VolumeSizeInGB' => ,
],
// ...
],
'ShadowProductionVariants' => [
[
'AcceleratorType' => 'ml.eia1.medium|ml.eia1.large|ml.eia1.xlarge|ml.eia2.medium|ml.eia2.large|ml.eia2.xlarge',
'CapacityReservationConfig' => [
'CapacityReservationPreference' => 'capacity-reservations-only',
'MlReservationArn' => '',
],
'ContainerStartupHealthCheckTimeoutInSeconds' => ,
'CoreDumpConfig' => [
'DestinationS3Uri' => '', // REQUIRED
'KmsKeyId' => '',
],
'EnableSSMAccess' => true || false,
'InferenceAmiVersion' => 'al2-ami-sagemaker-inference-gpu-2|al2-ami-sagemaker-inference-gpu-2-1|al2-ami-sagemaker-inference-gpu-3-1|al2-ami-sagemaker-inference-neuron-2|al2023-ami-sagemaker-inference-gpu-4-1',
'InitialInstanceCount' => ,
'InitialVariantWeight' => ,
'InstancePools' => [
[
'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.12xlarge|ml.m5d.24xlarge|ml.c4.large|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.large|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.12xlarge|ml.r5.24xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.12xlarge|ml.r5d.24xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.dl1.24xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.r8g.medium|ml.r8g.large|ml.r8g.xlarge|ml.r8g.2xlarge|ml.r8g.4xlarge|ml.r8g.8xlarge|ml.r8g.12xlarge|ml.r8g.16xlarge|ml.r8g.24xlarge|ml.r8g.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.p4d.24xlarge|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m6gd.large|ml.m6gd.xlarge|ml.m6gd.2xlarge|ml.m6gd.4xlarge|ml.m6gd.8xlarge|ml.m6gd.12xlarge|ml.m6gd.16xlarge|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c6gd.large|ml.c6gd.xlarge|ml.c6gd.2xlarge|ml.c6gd.4xlarge|ml.c6gd.8xlarge|ml.c6gd.12xlarge|ml.c6gd.16xlarge|ml.c6gn.large|ml.c6gn.xlarge|ml.c6gn.2xlarge|ml.c6gn.4xlarge|ml.c6gn.8xlarge|ml.c6gn.12xlarge|ml.c6gn.16xlarge|ml.r6g.large|ml.r6g.xlarge|ml.r6g.2xlarge|ml.r6g.4xlarge|ml.r6g.8xlarge|ml.r6g.12xlarge|ml.r6g.16xlarge|ml.r6gd.large|ml.r6gd.xlarge|ml.r6gd.2xlarge|ml.r6gd.4xlarge|ml.r6gd.8xlarge|ml.r6gd.12xlarge|ml.r6gd.16xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.r7gd.medium|ml.r7gd.large|ml.r7gd.xlarge|ml.r7gd.2xlarge|ml.r7gd.4xlarge|ml.r7gd.8xlarge|ml.r7gd.12xlarge|ml.r7gd.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.c6in.large|ml.c6in.xlarge|ml.c6in.2xlarge|ml.c6in.4xlarge|ml.c6in.8xlarge|ml.c6in.12xlarge|ml.c6in.16xlarge|ml.c6in.24xlarge|ml.c6in.32xlarge|ml.p6-b200.48xlarge|ml.p6-b300.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge', // REQUIRED
'ModelNameOverride' => '',
'Priority' => , // REQUIRED
],
// ...
],
'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.12xlarge|ml.m5d.24xlarge|ml.c4.large|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.large|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.12xlarge|ml.r5.24xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.12xlarge|ml.r5d.24xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.dl1.24xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.r8g.medium|ml.r8g.large|ml.r8g.xlarge|ml.r8g.2xlarge|ml.r8g.4xlarge|ml.r8g.8xlarge|ml.r8g.12xlarge|ml.r8g.16xlarge|ml.r8g.24xlarge|ml.r8g.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.p4d.24xlarge|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m6gd.large|ml.m6gd.xlarge|ml.m6gd.2xlarge|ml.m6gd.4xlarge|ml.m6gd.8xlarge|ml.m6gd.12xlarge|ml.m6gd.16xlarge|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c6gd.large|ml.c6gd.xlarge|ml.c6gd.2xlarge|ml.c6gd.4xlarge|ml.c6gd.8xlarge|ml.c6gd.12xlarge|ml.c6gd.16xlarge|ml.c6gn.large|ml.c6gn.xlarge|ml.c6gn.2xlarge|ml.c6gn.4xlarge|ml.c6gn.8xlarge|ml.c6gn.12xlarge|ml.c6gn.16xlarge|ml.r6g.large|ml.r6g.xlarge|ml.r6g.2xlarge|ml.r6g.4xlarge|ml.r6g.8xlarge|ml.r6g.12xlarge|ml.r6g.16xlarge|ml.r6gd.large|ml.r6gd.xlarge|ml.r6gd.2xlarge|ml.r6gd.4xlarge|ml.r6gd.8xlarge|ml.r6gd.12xlarge|ml.r6gd.16xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.r7gd.medium|ml.r7gd.large|ml.r7gd.xlarge|ml.r7gd.2xlarge|ml.r7gd.4xlarge|ml.r7gd.8xlarge|ml.r7gd.12xlarge|ml.r7gd.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.c6in.large|ml.c6in.xlarge|ml.c6in.2xlarge|ml.c6in.4xlarge|ml.c6in.8xlarge|ml.c6in.12xlarge|ml.c6in.16xlarge|ml.c6in.24xlarge|ml.c6in.32xlarge|ml.p6-b200.48xlarge|ml.p6-b300.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge',
'ManagedInstanceScaling' => [
'MaxInstanceCount' => ,
'MinInstanceCount' => ,
'ScaleInPolicy' => [
'CooldownInMinutes' => ,
'MaximumStepSize' => ,
'Strategy' => 'IDLE_RELEASE|CONSOLIDATION', // REQUIRED
],
'Status' => 'ENABLED|DISABLED',
],
'ModelDataDownloadTimeoutInSeconds' => ,
'ModelName' => '',
'RoutingConfig' => [
'PrefixAwareRoutingConfig' => [
'ConcurrencyThreshold' => ,
'PrefixLength' => ,
],
'RoutingStrategy' => 'LEAST_OUTSTANDING_REQUESTS|RANDOM|PREFIX_AWARE', // REQUIRED
],
'ServerlessConfig' => [
'MaxConcurrency' => , // REQUIRED
'MemorySizeInMB' => , // REQUIRED
'ProvisionedConcurrency' => ,
],
'VariantInstanceProvisionTimeoutInSeconds' => ,
'VariantName' => '', // REQUIRED
'VolumeSizeInGB' => ,
],
// ...
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
'VpcConfig' => [
'SecurityGroupIds' => ['', ...], // REQUIRED
'Subnets' => ['', ...], // REQUIRED
],
]);
Parameter Details
Members
- AsyncInferenceConfig
-
- Type: AsyncInferenceConfig structure
Specifies configuration for how an endpoint performs asynchronous inference. This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync.
- DataCaptureConfig
-
- Type: DataCaptureConfig structure
Configuration to control how SageMaker AI captures inference data.
- EnableNetworkIsolation
-
- Type: boolean
Sets whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound network calls can be made to or from the model containers.
- EndpointConfigName
-
- Required: Yes
- Type: string
The name of the endpoint configuration. You specify this name in a CreateEndpoint request.
- ExecutionRoleArn
-
- Type: string
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform actions on your behalf. For more information, see SageMaker AI Roles.
To be able to pass this role to Amazon SageMaker AI, the caller of this action must have the
iam:PassRolepermission. - ExplainerConfig
-
- Type: ExplainerConfig structure
A member of
CreateEndpointConfigthat enables explainers. - KmsKeyId
-
- Type: string
The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.
The KmsKeyId can be any of the following formats:
-
Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab -
Key ARN:
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab -
Alias name:
alias/ExampleAlias -
Alias name ARN:
arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
The KMS key policy must grant permission to the IAM role that you specify in your
CreateEndpoint,UpdateEndpointrequests. For more information, refer to the Amazon Web Services Key Management Service section Using Key Policies in Amazon Web Services KMSCertain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. If any of the models that you specify in the
ProductionVariantsparameter use nitro-based instances with local storage, theKmsKeyIdparameter does not encrypt instance local storage.For a list of instance types that support local instance storage, see Instance Store Volumes.
For more information about local instance storage encryption, see SSD Instance Store Volumes.
- MetricsConfig
-
- Type: MetricsConfig structure
The configuration parameters for utilization metrics.
- ProductionVariants
-
- Required: Yes
- Type: Array of ProductionVariant structures
An array of
ProductionVariantobjects, one for each model that you want to host at this endpoint. - ShadowProductionVariants
-
- Type: Array of ProductionVariant structures
An array of
ProductionVariantobjects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified onProductionVariants. If you use this field, you can only specify one variant forProductionVariantsand one variant forShadowProductionVariants. - Tags
-
- 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.
- VpcConfig
-
- Type: VpcConfig structure
Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.
Result Syntax
[
'EndpointConfigArn' => '',
]
Result Details
Members
- EndpointConfigArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the endpoint configuration.
Errors
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateExperiment
$result = $client->createExperiment([/* ... */]); $promise = $client->createExperimentAsync([/* ... */]);
Creates a SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model.
In the Studio UI, trials are referred to as run groups and trial components are referred to as runs.
The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant.
When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.
You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.
To add a description to an experiment, specify the optional Description parameter. To add a description later, or to change the description, call the UpdateExperiment API.
To get a list of all your experiments, call the ListExperiments API. To view an experiment's properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.
Parameter Syntax
$result = $client->createExperiment([
'Description' => '',
'DisplayName' => '',
'ExperimentName' => '', // REQUIRED
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- Description
-
- Type: string
The description of the experiment.
- DisplayName
-
- Type: string
The name of the experiment as displayed. The name doesn't need to be unique. If you don't specify
DisplayName, the value inExperimentNameis displayed. - ExperimentName
-
- Required: Yes
- Type: string
The name of the experiment. The name must be unique in your Amazon Web Services account and is not case-sensitive.
- Tags
-
- Type: Array of Tag structures
A list of tags to associate with the experiment. You can use Search API to search on the tags.
Result Syntax
[
'ExperimentArn' => '',
]
Result Details
Members
- ExperimentArn
-
- Type: string
The Amazon Resource Name (ARN) of the experiment.
Errors
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateFeatureGroup
$result = $client->createFeatureGroup([/* ... */]); $promise = $client->createFeatureGroupAsync([/* ... */]);
Create a new FeatureGroup. A FeatureGroup is a group of Features defined in the FeatureStore to describe a Record.
The FeatureGroup defines the schema and features contained in the FeatureGroup. A FeatureGroup definition is composed of a list of Features, a RecordIdentifierFeatureName, an EventTimeFeatureName and configurations for its OnlineStore and OfflineStore. Check Amazon Web Services service quotas to see the FeatureGroups quota for your Amazon Web Services account.
Note that it can take approximately 10-15 minutes to provision an OnlineStore FeatureGroup with the InMemory StorageType.
You must include at least one of OnlineStoreConfig and OfflineStoreConfig to create a FeatureGroup.
Parameter Syntax
$result = $client->createFeatureGroup([
'Description' => '',
'EventTimeFeatureName' => '', // REQUIRED
'FeatureDefinitions' => [ // REQUIRED
[
'CollectionConfig' => [
'VectorConfig' => [
'Dimension' => , // REQUIRED
],
],
'CollectionType' => 'List|Set|Vector',
'FeatureName' => '', // REQUIRED
'FeatureType' => 'Integral|Fractional|String', // REQUIRED
],
// ...
],
'FeatureGroupName' => '', // REQUIRED
'OfflineStoreConfig' => [
'DataCatalogConfig' => [
'Catalog' => '', // REQUIRED
'Database' => '', // REQUIRED
'TableName' => '', // REQUIRED
],
'DisableGlueTableCreation' => true || false,
'S3StorageConfig' => [ // REQUIRED
'KmsKeyId' => '',
'ResolvedOutputS3Uri' => '',
'S3Uri' => '', // REQUIRED
],
'TableFormat' => 'Default|Glue|Iceberg',
],
'OnlineStoreConfig' => [
'EnableOnlineStore' => true || false,
'SecurityConfig' => [
'KmsKeyId' => '',
],
'StorageType' => 'Standard|Standard_V2|InMemory',
'TtlDuration' => [
'Unit' => 'Seconds|Minutes|Hours|Days|Weeks',
'Value' => ,
],
],
'RecordIdentifierFeatureName' => '', // REQUIRED
'RoleArn' => '',
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
'ThroughputConfig' => [
'ProvisionedReadCapacityUnits' => ,
'ProvisionedWriteCapacityUnits' => ,
'ThroughputMode' => 'OnDemand|Provisioned', // REQUIRED
],
]);
Parameter Details
Members
- Description
-
- Type: string
A free-form description of a
FeatureGroup. - EventTimeFeatureName
-
- Required: Yes
- Type: string
The name of the feature that stores the
EventTimeof aRecordin aFeatureGroup.An
EventTimeis a point in time when a new event occurs that corresponds to the creation or update of aRecordin aFeatureGroup. AllRecordsin theFeatureGroupmust have a correspondingEventTime.An
EventTimecan be aStringorFractional.-
Fractional:EventTimefeature values must be a Unix timestamp in seconds. -
String:EventTimefeature values must be an ISO-8601 string in the format. The following formats are supportedyyyy-MM-dd'T'HH:mm:ssZandyyyy-MM-dd'T'HH:mm:ss.SSSZwhereyyyy,MM, andddrepresent the year, month, and day respectively andHH,mm,ss, and if applicable,SSSrepresent the hour, month, second and milliseconds respsectively.'T'andZare constants.
- FeatureDefinitions
-
- Required: Yes
- Type: Array of FeatureDefinition structures
A list of
Featurenames and types.NameandTypeis compulsory perFeature.Valid feature
FeatureTypes areIntegral,FractionalandString.FeatureNames cannot be any of the following:is_deleted,write_time,api_invocation_timeYou can create up to 2,500
FeatureDefinitions perFeatureGroup. - FeatureGroupName
-
- Required: Yes
- Type: string
The name of the
FeatureGroup. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.The name:
-
Must start with an alphanumeric character.
-
Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.
- OfflineStoreConfig
-
- Type: OfflineStoreConfig structure
Use this to configure an
OfflineFeatureStore. This parameter allows you to specify:-
The Amazon Simple Storage Service (Amazon S3) location of an
OfflineStore. -
A configuration for an Amazon Web Services Glue or Amazon Web Services Hive data catalog.
-
An KMS encryption key to encrypt the Amazon S3 location used for
OfflineStore. If KMS encryption key is not specified, by default we encrypt all data at rest using Amazon Web Services KMS key. By defining your bucket-level key for SSE, you can reduce Amazon Web Services KMS requests costs by up to 99 percent. -
Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.
To learn more about this parameter, see OfflineStoreConfig.
- OnlineStoreConfig
-
- Type: OnlineStoreConfig structure
You can turn the
OnlineStoreon or off by specifyingTruefor theEnableOnlineStoreflag inOnlineStoreConfig.You can also include an Amazon Web Services KMS key ID (
KMSKeyId) for at-rest encryption of theOnlineStore.The default value is
False. - RecordIdentifierFeatureName
-
- Required: Yes
- Type: string
The name of the
Featurewhose value uniquely identifies aRecorddefined in theFeatureStore. Only the latest record per identifier value will be stored in theOnlineStore.RecordIdentifierFeatureNamemust be one of feature definitions' names.You use the
RecordIdentifierFeatureNameto access data in aFeatureStore.This name:
-
Must start with an alphanumeric character.
-
Can only contains alphanumeric characters, hyphens, underscores. Spaces are not allowed.
- RoleArn
-
- Type: string
The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the
OfflineStoreif anOfflineStoreConfigis provided. - Tags
-
- Type: Array of Tag structures
Tags used to identify
Featuresin eachFeatureGroup. - ThroughputConfig
-
- Type: ThroughputConfig structure
Used to set feature group throughput configuration. There are two modes:
ON_DEMANDandPROVISIONED. With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.Note:
PROVISIONEDthroughput mode is supported only for feature groups that are offline-only, or use theStandardtier online store.
Result Syntax
[
'FeatureGroupArn' => '',
]
Result Details
Members
- FeatureGroupArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the
FeatureGroup. This is a unique identifier for the feature group.
Errors
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateFlowDefinition
$result = $client->createFlowDefinition([/* ... */]); $promise = $client->createFlowDefinitionAsync([/* ... */]);
Creates a flow definition.
Parameter Syntax
$result = $client->createFlowDefinition([
'FlowDefinitionName' => '', // REQUIRED
'HumanLoopActivationConfig' => [
'HumanLoopActivationConditionsConfig' => [ // REQUIRED
'HumanLoopActivationConditions' => '', // REQUIRED
],
],
'HumanLoopConfig' => [
'HumanTaskUiArn' => '', // REQUIRED
'PublicWorkforceTaskPrice' => [
'AmountInUsd' => [
'Cents' => ,
'Dollars' => ,
'TenthFractionsOfACent' => ,
],
],
'TaskAvailabilityLifetimeInSeconds' => ,
'TaskCount' => , // REQUIRED
'TaskDescription' => '', // REQUIRED
'TaskKeywords' => ['', ...],
'TaskTimeLimitInSeconds' => ,
'TaskTitle' => '', // REQUIRED
'WorkteamArn' => '', // REQUIRED
],
'HumanLoopRequestSource' => [
'AwsManagedHumanLoopRequestSource' => 'AWS/Rekognition/DetectModerationLabels/Image/V3|AWS/Textract/AnalyzeDocument/Forms/V1', // REQUIRED
],
'OutputConfig' => [ // REQUIRED
'KmsKeyId' => '',
'S3OutputPath' => '', // REQUIRED
],
'RoleArn' => '', // REQUIRED
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- FlowDefinitionName
-
- Required: Yes
- Type: string
The name of your flow definition.
- HumanLoopActivationConfig
-
- Type: HumanLoopActivationConfig structure
An object containing information about the events that trigger a human workflow.
- HumanLoopConfig
-
- Type: HumanLoopConfig structure
An object containing information about the tasks the human reviewers will perform.
- HumanLoopRequestSource
-
- Type: HumanLoopRequestSource structure
Container for configuring the source of human task requests. Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source.
- OutputConfig
-
- Required: Yes
- Type: FlowDefinitionOutputConfig structure
An object containing information about where the human review results will be uploaded.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the role needed to call other services on your behalf. For example,
arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298. - Tags
-
- Type: Array of Tag structures
An array of key-value pairs that contain metadata to help you categorize and organize a flow definition. Each tag consists of a key and a value, both of which you define.
Result Syntax
[
'FlowDefinitionArn' => '',
]
Result Details
Members
- FlowDefinitionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the flow definition you create.
Errors
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateHub
$result = $client->createHub([/* ... */]); $promise = $client->createHubAsync([/* ... */]);
Create a hub.
Parameter Syntax
$result = $client->createHub([
'HubDescription' => '', // REQUIRED
'HubDisplayName' => '',
'HubName' => '', // REQUIRED
'HubSearchKeywords' => ['', ...],
'S3StorageConfig' => [
'S3OutputPath' => '',
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- HubDescription
-
- Required: Yes
- Type: string
A description of the hub.
- HubDisplayName
-
- Type: string
The display name of the hub.
- HubName
-
- Required: Yes
- Type: string
The name of the hub to create.
- HubSearchKeywords
-
- Type: Array of strings
The searchable keywords for the hub.
- S3StorageConfig
-
- Type: HubS3StorageConfig structure
The Amazon S3 storage configuration for the hub.
- Tags
-
- Type: Array of Tag structures
Any tags to associate with the hub.
Result Syntax
[
'HubArn' => '',
]
Result Details
Members
- HubArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the hub.
Errors
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateHubContentPresignedUrls
$result = $client->createHubContentPresignedUrls([/* ... */]); $promise = $client->createHubContentPresignedUrlsAsync([/* ... */]);
Creates presigned URLs for accessing hub content artifacts. This operation generates time-limited, secure URLs that allow direct download of model artifacts and associated files from Amazon SageMaker hub content, including gated models that require end-user license agreement acceptance.
Parameter Syntax
$result = $client->createHubContentPresignedUrls([
'AccessConfig' => [
'AcceptEula' => true || false,
'ExpectedS3Url' => '',
],
'HubContentName' => '', // REQUIRED
'HubContentType' => 'Model|Notebook|ModelReference|DataSet|JsonDoc', // REQUIRED
'HubContentVersion' => '',
'HubName' => '', // REQUIRED
'MaxResults' => ,
'NextToken' => '',
]);
Parameter Details
Members
- AccessConfig
-
- Type: PresignedUrlAccessConfig structure
Configuration settings for accessing the hub content, including end-user license agreement acceptance for gated models and expected S3 URL validation.
- HubContentName
-
- Required: Yes
- Type: string
The name of the hub content for which to generate presigned URLs. This identifies the specific model or content within the hub.
- HubContentType
-
- Required: Yes
- Type: string
The type of hub content to access. Valid values include
Model,Notebook, andModelReference. - HubContentVersion
-
- Type: string
The version of the hub content. If not specified, the latest version is used.
- HubName
-
- Required: Yes
- Type: string
The name or Amazon Resource Name (ARN) of the hub that contains the content. For public content, use
SageMakerPublicHub. - MaxResults
-
- Type: int
The maximum number of presigned URLs to return in the response. Default value is 100. Large models may contain hundreds of files, requiring pagination to retrieve all URLs.
- NextToken
-
- Type: string
A token for pagination. Use this token to retrieve the next set of presigned URLs when the response is truncated.
Result Syntax
[
'AuthorizedUrlConfigs' => [
[
'LocalPath' => '',
'Url' => '',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- AuthorizedUrlConfigs
-
- Required: Yes
- Type: Array of AuthorizedUrl structures
An array of authorized URL configurations, each containing a presigned URL and its corresponding local file path for proper file organization during download.
- NextToken
-
- Type: string
A token for pagination. If present, indicates that more presigned URLs are available. Use this token in a subsequent request to retrieve additional URLs.
Errors
There are no errors described for this operation.
CreateHubContentReference
$result = $client->createHubContentReference([/* ... */]); $promise = $client->createHubContentReferenceAsync([/* ... */]);
Create a hub content reference in order to add a model in the JumpStart public hub to a private hub.
Parameter Syntax
$result = $client->createHubContentReference([
'HubContentName' => '',
'HubName' => '', // REQUIRED
'MinVersion' => '',
'SageMakerPublicHubContentArn' => '', // REQUIRED
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- HubContentName
-
- Type: string
The name of the hub content to reference.
- HubName
-
- Required: Yes
- Type: string
The name of the hub to add the hub content reference to.
- MinVersion
-
- Type: string
The minimum version of the hub content to reference.
- SageMakerPublicHubContentArn
-
- Required: Yes
- Type: string
The ARN of the public hub content to reference.
- Tags
-
- Type: Array of Tag structures
Any tags associated with the hub content to reference.
Result Syntax
[
'HubArn' => '',
'HubContentArn' => '',
]
Result Details
Members
- HubArn
-
- Required: Yes
- Type: string
The ARN of the hub that the hub content reference was added to.
- HubContentArn
-
- Required: Yes
- Type: string
The ARN of the hub content.
Errors
- ResourceNotFound:
Resource being access is not found.
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateHumanTaskUi
$result = $client->createHumanTaskUi([/* ... */]); $promise = $client->createHumanTaskUiAsync([/* ... */]);
Defines the settings you will use for the human review workflow user interface. Reviewers will see a three-panel interface with an instruction area, the item to review, and an input area.
Parameter Syntax
$result = $client->createHumanTaskUi([
'HumanTaskUiName' => '', // REQUIRED
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
'UiTemplate' => [ // REQUIRED
'Content' => '', // REQUIRED
],
]);
Parameter Details
Members
- HumanTaskUiName
-
- Required: Yes
- Type: string
The name of the user interface you are creating.
- Tags
-
- Type: Array of Tag structures
An array of key-value pairs that contain metadata to help you categorize and organize a human review workflow user interface. Each tag consists of a key and a value, both of which you define.
- UiTemplate
-
- Required: Yes
- Type: UiTemplate structure
The Liquid template for the worker user interface.
Result Syntax
[
'HumanTaskUiArn' => '',
]
Result Details
Members
- HumanTaskUiArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the human review workflow user interface you create.
Errors
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateHyperParameterTuningJob
$result = $client->createHyperParameterTuningJob([/* ... */]); $promise = $client->createHyperParameterTuningJobAsync([/* ... */]);
Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version of a model by running many training jobs on your dataset using the algorithm you choose and values for hyperparameters within ranges that you specify. It then chooses the hyperparameter values that result in a model that performs the best, as measured by an objective metric that you choose.
A hyperparameter tuning job automatically creates Amazon SageMaker experiments, trials, and trial components for each training job that it runs. You can view these entities in Amazon SageMaker Studio. For more information, see View Experiments, Trials, and Trial Components.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by any security-sensitive information included in the request hyperparameter variable or plain text fields..
Parameter Syntax
$result = $client->createHyperParameterTuningJob([
'Autotune' => [
'Mode' => 'Enabled', // REQUIRED
],
'HyperParameterTuningJobConfig' => [ // REQUIRED
'HyperParameterTuningJobObjective' => [
'MetricName' => '', // REQUIRED
'Type' => 'Maximize|Minimize', // REQUIRED
],
'ParameterRanges' => [
'AutoParameters' => [
[
'Name' => '', // REQUIRED
'ValueHint' => '', // REQUIRED
],
// ...
],
'CategoricalParameterRanges' => [
[
'Name' => '', // REQUIRED
'Values' => ['', ...], // REQUIRED
],
// ...
],
'ContinuousParameterRanges' => [
[
'MaxValue' => '', // REQUIRED
'MinValue' => '', // REQUIRED
'Name' => '', // REQUIRED
'ScalingType' => 'Auto|Linear|Logarithmic|ReverseLogarithmic',
],
// ...
],
'IntegerParameterRanges' => [
[
'MaxValue' => '', // REQUIRED
'MinValue' => '', // REQUIRED
'Name' => '', // REQUIRED
'ScalingType' => 'Auto|Linear|Logarithmic|ReverseLogarithmic',
],
// ...
],
],
'RandomSeed' => ,
'ResourceLimits' => [ // REQUIRED
'MaxNumberOfTrainingJobs' => ,
'MaxParallelTrainingJobs' => , // REQUIRED
'MaxRuntimeInSeconds' => ,
],
'Strategy' => 'Bayesian|Random|Hyperband|Grid', // REQUIRED
'StrategyConfig' => [
'HyperbandStrategyConfig' => [
'MaxResource' => ,
'MinResource' => ,
],
],
'TrainingJobEarlyStoppingType' => 'Off|Auto',
'TuningJobCompletionCriteria' => [
'BestObjectiveNotImproving' => [
'MaxNumberOfTrainingJobsNotImproving' => ,
],
'ConvergenceDetected' => [
'CompleteOnConvergence' => 'Disabled|Enabled',
],
'TargetObjectiveMetricValue' => ,
],
],
'HyperParameterTuningJobName' => '', // REQUIRED
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
'TrainingJobDefinition' => [
'AlgorithmSpecification' => [ // REQUIRED
'AlgorithmName' => '',
'MetricDefinitions' => [
[
'Name' => '', // REQUIRED
'Regex' => '', // REQUIRED
],
// ...
],
'TrainingImage' => '',
'TrainingInputMode' => 'Pipe|File|FastFile', // REQUIRED
],
'CheckpointConfig' => [
'LocalPath' => '',
'S3Uri' => '', // REQUIRED
],
'DefinitionName' => '',
'EnableInterContainerTrafficEncryption' => true || false,
'EnableManagedSpotTraining' => true || false,
'EnableNetworkIsolation' => true || false,
'Environment' => ['', ...],
'HyperParameterRanges' => [
'AutoParameters' => [
[
'Name' => '', // REQUIRED
'ValueHint' => '', // REQUIRED
],
// ...
],
'CategoricalParameterRanges' => [
[
'Name' => '', // REQUIRED
'Values' => ['', ...], // REQUIRED
],
// ...
],
'ContinuousParameterRanges' => [
[
'MaxValue' => '', // REQUIRED
'MinValue' => '', // REQUIRED
'Name' => '', // REQUIRED
'ScalingType' => 'Auto|Linear|Logarithmic|ReverseLogarithmic',
],
// ...
],
'IntegerParameterRanges' => [
[
'MaxValue' => '', // REQUIRED
'MinValue' => '', // REQUIRED
'Name' => '', // REQUIRED
'ScalingType' => 'Auto|Linear|Logarithmic|ReverseLogarithmic',
],
// ...
],
],
'HyperParameterTuningResourceConfig' => [
'AllocationStrategy' => 'Prioritized',
'InstanceConfigs' => [
[
'InstanceCount' => , // REQUIRED
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge', // REQUIRED
'VolumeSizeInGB' => , // REQUIRED
],
// ...
],
'InstanceCount' => ,
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'VolumeKmsKeyId' => '',
'VolumeSizeInGB' => ,
],
'InputDataConfig' => [
[
'ChannelName' => '', // REQUIRED
'CompressionType' => 'None|Gzip',
'ContentType' => '',
'DataSource' => [ // REQUIRED
'DatasetSource' => [
'DatasetArn' => '', // REQUIRED
],
'FileSystemDataSource' => [
'DirectoryPath' => '', // REQUIRED
'FileSystemAccessMode' => 'rw|ro', // REQUIRED
'FileSystemId' => '', // REQUIRED
'FileSystemType' => 'EFS|FSxLustre', // REQUIRED
],
'S3DataSource' => [
'AttributeNames' => ['', ...],
'HubAccessConfig' => [
'HubContentArn' => '', // REQUIRED
],
'InstanceGroupNames' => ['', ...],
'ModelAccessConfig' => [
'AcceptEula' => true || false, // REQUIRED
],
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile|Converse', // REQUIRED
'S3Uri' => '', // REQUIRED
],
],
'InputMode' => 'Pipe|File|FastFile',
'RecordWrapperType' => 'None|RecordIO',
'ShuffleConfig' => [
'Seed' => , // REQUIRED
],
],
// ...
],
'OutputDataConfig' => [ // REQUIRED
'CompressionType' => 'GZIP|NONE',
'KmsKeyId' => '',
'S3OutputPath' => '', // REQUIRED
],
'ResourceConfig' => [
'InstanceCount' => ,
'InstanceGroups' => [
[
'InstanceCount' => , // REQUIRED
'InstanceGroupName' => '', // REQUIRED
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge', // REQUIRED
],
// ...
],
'InstancePlacementConfig' => [
'EnableMultipleJobs' => true || false,
'PlacementSpecifications' => [
[
'InstanceCount' => , // REQUIRED
'UltraServerId' => '',
],
// ...
],
],
'InstancePreferences' => [
[
'InstanceCount' => ,
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge', // REQUIRED
'TrainingPlanArns' => ['', ...],
],
// ...
],
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'KeepAlivePeriodInSeconds' => ,
'SelectedInstanceCount' => ,
'SelectedInstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'TrainingPlanArn' => '',
'VolumeKmsKeyId' => '',
'VolumeSizeInGB' => ,
],
'RetryStrategy' => [
'MaximumRetryAttempts' => , // REQUIRED
],
'RoleArn' => '', // REQUIRED
'StaticHyperParameters' => ['', ...],
'StoppingCondition' => [ // REQUIRED
'MaxPendingTimeInSeconds' => ,
'MaxRuntimeInSeconds' => ,
'MaxWaitTimeInSeconds' => ,
],
'TuningObjective' => [
'MetricName' => '', // REQUIRED
'Type' => 'Maximize|Minimize', // REQUIRED
],
'VpcConfig' => [
'SecurityGroupIds' => ['', ...], // REQUIRED
'Subnets' => ['', ...], // REQUIRED
],
],
'TrainingJobDefinitions' => [
[
'AlgorithmSpecification' => [ // REQUIRED
'AlgorithmName' => '',
'MetricDefinitions' => [
[
'Name' => '', // REQUIRED
'Regex' => '', // REQUIRED
],
// ...
],
'TrainingImage' => '',
'TrainingInputMode' => 'Pipe|File|FastFile', // REQUIRED
],
'CheckpointConfig' => [
'LocalPath' => '',
'S3Uri' => '', // REQUIRED
],
'DefinitionName' => '',
'EnableInterContainerTrafficEncryption' => true || false,
'EnableManagedSpotTraining' => true || false,
'EnableNetworkIsolation' => true || false,
'Environment' => ['', ...],
'HyperParameterRanges' => [
'AutoParameters' => [
[
'Name' => '', // REQUIRED
'ValueHint' => '', // REQUIRED
],
// ...
],
'CategoricalParameterRanges' => [
[
'Name' => '', // REQUIRED
'Values' => ['', ...], // REQUIRED
],
// ...
],
'ContinuousParameterRanges' => [
[
'MaxValue' => '', // REQUIRED
'MinValue' => '', // REQUIRED
'Name' => '', // REQUIRED
'ScalingType' => 'Auto|Linear|Logarithmic|ReverseLogarithmic',
],
// ...
],
'IntegerParameterRanges' => [
[
'MaxValue' => '', // REQUIRED
'MinValue' => '', // REQUIRED
'Name' => '', // REQUIRED
'ScalingType' => 'Auto|Linear|Logarithmic|ReverseLogarithmic',
],
// ...
],
],
'HyperParameterTuningResourceConfig' => [
'AllocationStrategy' => 'Prioritized',
'InstanceConfigs' => [
[
'InstanceCount' => , // REQUIRED
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge', // REQUIRED
'VolumeSizeInGB' => , // REQUIRED
],
// ...
],
'InstanceCount' => ,
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'VolumeKmsKeyId' => '',
'VolumeSizeInGB' => ,
],
'InputDataConfig' => [
[
'ChannelName' => '', // REQUIRED
'CompressionType' => 'None|Gzip',
'ContentType' => '',
'DataSource' => [ // REQUIRED
'DatasetSource' => [
'DatasetArn' => '', // REQUIRED
],
'FileSystemDataSource' => [
'DirectoryPath' => '', // REQUIRED
'FileSystemAccessMode' => 'rw|ro', // REQUIRED
'FileSystemId' => '', // REQUIRED
'FileSystemType' => 'EFS|FSxLustre', // REQUIRED
],
'S3DataSource' => [
'AttributeNames' => ['', ...],
'HubAccessConfig' => [
'HubContentArn' => '', // REQUIRED
],
'InstanceGroupNames' => ['', ...],
'ModelAccessConfig' => [
'AcceptEula' => true || false, // REQUIRED
],
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile|Converse', // REQUIRED
'S3Uri' => '', // REQUIRED
],
],
'InputMode' => 'Pipe|File|FastFile',
'RecordWrapperType' => 'None|RecordIO',
'ShuffleConfig' => [
'Seed' => , // REQUIRED
],
],
// ...
],
'OutputDataConfig' => [ // REQUIRED
'CompressionType' => 'GZIP|NONE',
'KmsKeyId' => '',
'S3OutputPath' => '', // REQUIRED
],
'ResourceConfig' => [
'InstanceCount' => ,
'InstanceGroups' => [
[
'InstanceCount' => , // REQUIRED
'InstanceGroupName' => '', // REQUIRED
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge', // REQUIRED
],
// ...
],
'InstancePlacementConfig' => [
'EnableMultipleJobs' => true || false,
'PlacementSpecifications' => [
[
'InstanceCount' => , // REQUIRED
'UltraServerId' => '',
],
// ...
],
],
'InstancePreferences' => [
[
'InstanceCount' => ,
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge', // REQUIRED
'TrainingPlanArns' => ['', ...],
],
// ...
],
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'KeepAlivePeriodInSeconds' => ,
'SelectedInstanceCount' => ,
'SelectedInstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'TrainingPlanArn' => '',
'VolumeKmsKeyId' => '',
'VolumeSizeInGB' => ,
],
'RetryStrategy' => [
'MaximumRetryAttempts' => , // REQUIRED
],
'RoleArn' => '', // REQUIRED
'StaticHyperParameters' => ['', ...],
'StoppingCondition' => [ // REQUIRED
'MaxPendingTimeInSeconds' => ,
'MaxRuntimeInSeconds' => ,
'MaxWaitTimeInSeconds' => ,
],
'TuningObjective' => [
'MetricName' => '', // REQUIRED
'Type' => 'Maximize|Minimize', // REQUIRED
],
'VpcConfig' => [
'SecurityGroupIds' => ['', ...], // REQUIRED
'Subnets' => ['', ...], // REQUIRED
],
],
// ...
],
'WarmStartConfig' => [
'ParentHyperParameterTuningJobs' => [ // REQUIRED
[
'HyperParameterTuningJobName' => '',
],
// ...
],
'WarmStartType' => 'IdenticalDataAndAlgorithm|TransferLearning', // REQUIRED
],
]);
Parameter Details
Members
- Autotune
-
- Type: Autotune structure
Configures SageMaker Automatic model tuning (AMT) to automatically find optimal parameters for the following fields:
-
ParameterRanges: The names and ranges of parameters that a hyperparameter tuning job can optimize.
-
ResourceLimits: The maximum resources that can be used for a training job. These resources include the maximum number of training jobs, the maximum runtime of a tuning job, and the maximum number of training jobs to run at the same time.
-
TrainingJobEarlyStoppingType: A flag that specifies whether or not to use early stopping for training jobs launched by a hyperparameter tuning job.
-
RetryStrategy: The number of times to retry a training job.
-
Strategy: Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training jobs that it launches.
-
ConvergenceDetected: A flag to indicate that Automatic model tuning (AMT) has detected model convergence.
- HyperParameterTuningJobConfig
-
- Required: Yes
- Type: HyperParameterTuningJobConfig structure
The HyperParameterTuningJobConfig object that describes the tuning job, including the search strategy, the objective metric used to evaluate training jobs, ranges of parameters to search, and resource limits for the tuning job. For more information, see How Hyperparameter Tuning Works.
- HyperParameterTuningJobName
-
- Required: Yes
- Type: string
The name of the tuning job. This name is the prefix for the names of all training jobs that this tuning job launches. The name must be unique within the same Amazon Web Services account and Amazon Web Services Region. The name must have 1 to 32 characters. Valid characters are a-z, A-Z, 0-9, and : + = @ _ % - (hyphen). The name is not case sensitive.
- Tags
-
- 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.
Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches.
- TrainingJobDefinition
-
- Type: HyperParameterTrainingJobDefinition structure
The HyperParameterTrainingJobDefinition object that describes the training jobs that this tuning job launches, including static hyperparameters, input data configuration, output data configuration, resource configuration, and stopping condition.
- TrainingJobDefinitions
-
- Type: Array of HyperParameterTrainingJobDefinition structures
A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
- WarmStartConfig
-
- Type: HyperParameterTuningJobWarmStartConfig structure
Specifies the configuration for starting the hyperparameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.
All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric. If you specify
IDENTICAL_DATA_AND_ALGORITHMas theWarmStartTypevalue for the warm start configuration, the training job that performs the best in the new tuning job is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.
Result Syntax
[
'HyperParameterTuningJobArn' => '',
]
Result Details
Members
- HyperParameterTuningJobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the tuning job. SageMaker assigns an ARN to a hyperparameter tuning job when you create it.
Errors
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateImage
$result = $client->createImage([/* ... */]); $promise = $client->createImageAsync([/* ... */]);
Creates a custom SageMaker AI image. A SageMaker AI image is a set of image versions. Each image version represents a container image stored in Amazon ECR. For more information, see Bring your own SageMaker AI image.
Parameter Syntax
$result = $client->createImage([
'Description' => '',
'DisplayName' => '',
'ImageName' => '', // REQUIRED
'RoleArn' => '', // REQUIRED
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- Description
-
- Type: string
The description of the image.
- DisplayName
-
- Type: string
The display name of the image. If not provided,
ImageNameis displayed. - ImageName
-
- Required: Yes
- Type: string
The name of the image. Must be unique to your account.
- RoleArn
-
- Required: Yes
- Type: string
The ARN of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.
- Tags
-
- Type: Array of Tag structures
A list of tags to apply to the image.
Result Syntax
[
'ImageArn' => '',
]
Result Details
Members
- ImageArn
-
- Type: string
The ARN of the image.
Errors
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateImageVersion
$result = $client->createImageVersion([/* ... */]); $promise = $client->createImageVersionAsync([/* ... */]);
Creates a version of the SageMaker AI image specified by ImageName. The version represents the Amazon ECR container image specified by BaseImage.
Parameter Syntax
$result = $client->createImageVersion([
'Aliases' => ['', ...],
'BaseImage' => '', // REQUIRED
'ClientToken' => '', // REQUIRED
'Horovod' => true || false,
'ImageName' => '', // REQUIRED
'JobType' => 'TRAINING|INFERENCE|NOTEBOOK_KERNEL',
'MLFramework' => '',
'Processor' => 'CPU|GPU',
'ProgrammingLang' => '',
'ReleaseNotes' => '',
'VendorGuidance' => 'NOT_PROVIDED|STABLE|TO_BE_ARCHIVED|ARCHIVED',
]);
Parameter Details
Members
- Aliases
-
- Type: Array of strings
A list of aliases created with the image version.
- BaseImage
-
- Required: Yes
- Type: string
The registry path of the container image to use as the starting point for this version. The path is an Amazon ECR URI in the following format:
.dkr.ecr. .amazonaws.com/ - ClientToken
-
- Required: Yes
- Type: string
A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the SDK for Python (Boto3), add a unique value to the call.
- Horovod
-
- Type: boolean
Indicates Horovod compatibility.
- ImageName
-
- Required: Yes
- Type: string
The
ImageNameof theImageto create a version of. - JobType
-
- Type: string
Indicates SageMaker AI job type compatibility.
-
TRAINING: The image version is compatible with SageMaker AI training jobs. -
INFERENCE: The image version is compatible with SageMaker AI inference jobs. -
NOTEBOOK_KERNEL: The image version is compatible with SageMaker AI notebook kernels.
- MLFramework
-
- Type: string
The machine learning framework vended in the image version.
- Processor
-
- Type: string
Indicates CPU or GPU compatibility.
-
CPU: The image version is compatible with CPU. -
GPU: The image version is compatible with GPU.
- ProgrammingLang
-
- Type: string
The supported programming language and its version.
- ReleaseNotes
-
- Type: string
The maintainer description of the image version.
- VendorGuidance
-
- Type: string
The stability of the image version, specified by the maintainer.
-
NOT_PROVIDED: The maintainers did not provide a status for image version stability. -
STABLE: The image version is stable. -
TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months. -
ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.
Result Syntax
[
'ImageVersionArn' => '',
]
Result Details
Members
- ImageVersionArn
-
- Type: string
The ARN of the image version.
Errors
- ResourceNotFound:
Resource being access is not found.
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateInferenceComponent
$result = $client->createInferenceComponent([/* ... */]); $promise = $client->createInferenceComponentAsync([/* ... */]);
Creates an inference component, which is a SageMaker AI hosting object that you can use to deploy a model to an endpoint. In the inference component settings, you specify the model, the endpoint, and how the model utilizes the resources that the endpoint hosts. You can optimize resource utilization by tailoring how the required CPU cores, accelerators, and memory are allocated. You can deploy multiple inference components to an endpoint, where each inference component contains one model and the resource utilization needs for that individual model. After you deploy an inference component, you can directly invoke the associated model when you use the InvokeEndpoint API action.
Parameter Syntax
$result = $client->createInferenceComponent([
'EndpointName' => '', // REQUIRED
'InferenceComponentName' => '', // REQUIRED
'RuntimeConfig' => [
'CopyCount' => , // REQUIRED
],
'Specification' => [
'BaseInferenceComponentName' => '',
'ComputeResourceRequirements' => [
'MaxMemoryRequiredInMb' => ,
'MinMemoryRequiredInMb' => , // REQUIRED
'NumberOfAcceleratorDevicesRequired' => ,
'NumberOfCpuCoresRequired' => ,
],
'Container' => [
'ArtifactUrl' => '',
'ContainerMetricsConfig' => [
'MetricsEndpoints' => [
[
'MetricPublishFrequencyInSeconds' => ,
'MetricsEndpointPath' => '', // REQUIRED
],
// ...
],
],
'Environment' => ['', ...],
'Image' => '',
],
'DataCacheConfig' => [
'EnableCaching' => true || false, // REQUIRED
],
'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.12xlarge|ml.m5d.24xlarge|ml.c4.large|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.large|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.12xlarge|ml.r5.24xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.12xlarge|ml.r5d.24xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.dl1.24xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.r8g.medium|ml.r8g.large|ml.r8g.xlarge|ml.r8g.2xlarge|ml.r8g.4xlarge|ml.r8g.8xlarge|ml.r8g.12xlarge|ml.r8g.16xlarge|ml.r8g.24xlarge|ml.r8g.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.p4d.24xlarge|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m6gd.large|ml.m6gd.xlarge|ml.m6gd.2xlarge|ml.m6gd.4xlarge|ml.m6gd.8xlarge|ml.m6gd.12xlarge|ml.m6gd.16xlarge|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c6gd.large|ml.c6gd.xlarge|ml.c6gd.2xlarge|ml.c6gd.4xlarge|ml.c6gd.8xlarge|ml.c6gd.12xlarge|ml.c6gd.16xlarge|ml.c6gn.large|ml.c6gn.xlarge|ml.c6gn.2xlarge|ml.c6gn.4xlarge|ml.c6gn.8xlarge|ml.c6gn.12xlarge|ml.c6gn.16xlarge|ml.r6g.large|ml.r6g.xlarge|ml.r6g.2xlarge|ml.r6g.4xlarge|ml.r6g.8xlarge|ml.r6g.12xlarge|ml.r6g.16xlarge|ml.r6gd.large|ml.r6gd.xlarge|ml.r6gd.2xlarge|ml.r6gd.4xlarge|ml.r6gd.8xlarge|ml.r6gd.12xlarge|ml.r6gd.16xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.r7gd.medium|ml.r7gd.large|ml.r7gd.xlarge|ml.r7gd.2xlarge|ml.r7gd.4xlarge|ml.r7gd.8xlarge|ml.r7gd.12xlarge|ml.r7gd.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.c6in.large|ml.c6in.xlarge|ml.c6in.2xlarge|ml.c6in.4xlarge|ml.c6in.8xlarge|ml.c6in.12xlarge|ml.c6in.16xlarge|ml.c6in.24xlarge|ml.c6in.32xlarge|ml.p6-b200.48xlarge|ml.p6-b300.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge',
'ModelName' => '',
'SchedulingConfig' => [
'AvailabilityZoneBalance' => [
'EnforcementMode' => 'PERMISSIVE', // REQUIRED
'MaxImbalance' => ,
],
'PlacementStrategy' => 'SPREAD|BINPACK', // REQUIRED
],
'StartupParameters' => [
'ContainerStartupHealthCheckTimeoutInSeconds' => ,
'ModelDataDownloadTimeoutInSeconds' => ,
],
],
'Specifications' => [
[
'BaseInferenceComponentName' => '',
'ComputeResourceRequirements' => [
'MaxMemoryRequiredInMb' => ,
'MinMemoryRequiredInMb' => , // REQUIRED
'NumberOfAcceleratorDevicesRequired' => ,
'NumberOfCpuCoresRequired' => ,
],
'Container' => [
'ArtifactUrl' => '',
'ContainerMetricsConfig' => [
'MetricsEndpoints' => [
[
'MetricPublishFrequencyInSeconds' => ,
'MetricsEndpointPath' => '', // REQUIRED
],
// ...
],
],
'Environment' => ['', ...],
'Image' => '',
],
'DataCacheConfig' => [
'EnableCaching' => true || false, // REQUIRED
],
'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.12xlarge|ml.m5d.24xlarge|ml.c4.large|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.large|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.12xlarge|ml.r5.24xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.12xlarge|ml.r5d.24xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.dl1.24xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.r8g.medium|ml.r8g.large|ml.r8g.xlarge|ml.r8g.2xlarge|ml.r8g.4xlarge|ml.r8g.8xlarge|ml.r8g.12xlarge|ml.r8g.16xlarge|ml.r8g.24xlarge|ml.r8g.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.p4d.24xlarge|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m6gd.large|ml.m6gd.xlarge|ml.m6gd.2xlarge|ml.m6gd.4xlarge|ml.m6gd.8xlarge|ml.m6gd.12xlarge|ml.m6gd.16xlarge|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c6gd.large|ml.c6gd.xlarge|ml.c6gd.2xlarge|ml.c6gd.4xlarge|ml.c6gd.8xlarge|ml.c6gd.12xlarge|ml.c6gd.16xlarge|ml.c6gn.large|ml.c6gn.xlarge|ml.c6gn.2xlarge|ml.c6gn.4xlarge|ml.c6gn.8xlarge|ml.c6gn.12xlarge|ml.c6gn.16xlarge|ml.r6g.large|ml.r6g.xlarge|ml.r6g.2xlarge|ml.r6g.4xlarge|ml.r6g.8xlarge|ml.r6g.12xlarge|ml.r6g.16xlarge|ml.r6gd.large|ml.r6gd.xlarge|ml.r6gd.2xlarge|ml.r6gd.4xlarge|ml.r6gd.8xlarge|ml.r6gd.12xlarge|ml.r6gd.16xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.r7gd.medium|ml.r7gd.large|ml.r7gd.xlarge|ml.r7gd.2xlarge|ml.r7gd.4xlarge|ml.r7gd.8xlarge|ml.r7gd.12xlarge|ml.r7gd.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.c6in.large|ml.c6in.xlarge|ml.c6in.2xlarge|ml.c6in.4xlarge|ml.c6in.8xlarge|ml.c6in.12xlarge|ml.c6in.16xlarge|ml.c6in.24xlarge|ml.c6in.32xlarge|ml.p6-b200.48xlarge|ml.p6-b300.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge',
'ModelName' => '',
'SchedulingConfig' => [
'AvailabilityZoneBalance' => [
'EnforcementMode' => 'PERMISSIVE', // REQUIRED
'MaxImbalance' => ,
],
'PlacementStrategy' => 'SPREAD|BINPACK', // REQUIRED
],
'StartupParameters' => [
'ContainerStartupHealthCheckTimeoutInSeconds' => ,
'ModelDataDownloadTimeoutInSeconds' => ,
],
],
// ...
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
'VariantName' => '',
]);
Parameter Details
Members
- EndpointName
-
- Required: Yes
- Type: string
The name of an existing endpoint where you host the inference component.
- InferenceComponentName
-
- Required: Yes
- Type: string
A unique name to assign to the inference component.
- RuntimeConfig
-
- Type: InferenceComponentRuntimeConfig structure
Runtime settings for a model that is deployed with an inference component.
- Specification
-
- Type: InferenceComponentSpecification structure
Details about the resources to deploy with this inference component, including the model, container, and compute resources.
- Specifications
-
- Type: Array of InferenceComponentSpecification structures
A list of specification objects for the inference component, one per instance type. Use this parameter when you want to deploy a different model or resource configuration for the inference component on each instance type. You can use either this parameter or the singular
Specificationparameter, but not both. - Tags
-
- Type: Array of Tag structures
A list of key-value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.
- VariantName
-
- Type: string
The name of an existing production variant where you host the inference component.
Result Syntax
[
'InferenceComponentArn' => '',
]
Result Details
Members
- InferenceComponentArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the inference component.
Errors
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateInferenceExperiment
$result = $client->createInferenceExperiment([/* ... */]); $promise = $client->createInferenceExperimentAsync([/* ... */]);
Creates an inference experiment using the configurations specified in the request.
Use this API to setup and schedule an experiment to compare model variants on a Amazon SageMaker inference endpoint. For more information about inference experiments, see Shadow tests.
Amazon SageMaker begins your experiment at the scheduled time and routes traffic to your endpoint's model variants based on your specified configuration.
While the experiment is in progress or after it has concluded, you can view metrics that compare your model variants. For more information, see View, monitor, and edit shadow tests.
Parameter Syntax
$result = $client->createInferenceExperiment([
'DataStorageConfig' => [
'ContentType' => [
'CsvContentTypes' => ['', ...],
'JsonContentTypes' => ['', ...],
],
'Destination' => '', // REQUIRED
'KmsKey' => '',
],
'Description' => '',
'EndpointName' => '', // REQUIRED
'KmsKey' => '',
'ModelVariants' => [ // REQUIRED
[
'InfrastructureConfig' => [ // REQUIRED
'InfrastructureType' => 'RealTimeInference', // REQUIRED
'RealTimeInferenceConfig' => [ // REQUIRED
'InstanceCount' => , // REQUIRED
'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.12xlarge|ml.m5d.24xlarge|ml.c4.large|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.large|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.12xlarge|ml.r5.24xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.12xlarge|ml.r5d.24xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.dl1.24xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.r8g.medium|ml.r8g.large|ml.r8g.xlarge|ml.r8g.2xlarge|ml.r8g.4xlarge|ml.r8g.8xlarge|ml.r8g.12xlarge|ml.r8g.16xlarge|ml.r8g.24xlarge|ml.r8g.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.p4d.24xlarge|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m6gd.large|ml.m6gd.xlarge|ml.m6gd.2xlarge|ml.m6gd.4xlarge|ml.m6gd.8xlarge|ml.m6gd.12xlarge|ml.m6gd.16xlarge|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c6gd.large|ml.c6gd.xlarge|ml.c6gd.2xlarge|ml.c6gd.4xlarge|ml.c6gd.8xlarge|ml.c6gd.12xlarge|ml.c6gd.16xlarge|ml.c6gn.large|ml.c6gn.xlarge|ml.c6gn.2xlarge|ml.c6gn.4xlarge|ml.c6gn.8xlarge|ml.c6gn.12xlarge|ml.c6gn.16xlarge|ml.r6g.large|ml.r6g.xlarge|ml.r6g.2xlarge|ml.r6g.4xlarge|ml.r6g.8xlarge|ml.r6g.12xlarge|ml.r6g.16xlarge|ml.r6gd.large|ml.r6gd.xlarge|ml.r6gd.2xlarge|ml.r6gd.4xlarge|ml.r6gd.8xlarge|ml.r6gd.12xlarge|ml.r6gd.16xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.r7gd.medium|ml.r7gd.large|ml.r7gd.xlarge|ml.r7gd.2xlarge|ml.r7gd.4xlarge|ml.r7gd.8xlarge|ml.r7gd.12xlarge|ml.r7gd.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.c6in.large|ml.c6in.xlarge|ml.c6in.2xlarge|ml.c6in.4xlarge|ml.c6in.8xlarge|ml.c6in.12xlarge|ml.c6in.16xlarge|ml.c6in.24xlarge|ml.c6in.32xlarge|ml.p6-b200.48xlarge|ml.p6-b300.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge', // REQUIRED
],
],
'ModelName' => '', // REQUIRED
'VariantName' => '', // REQUIRED
],
// ...
],
'Name' => '', // REQUIRED
'RoleArn' => '', // REQUIRED
'Schedule' => [
'EndTime' => ,
'StartTime' => ,
],
'ShadowModeConfig' => [ // REQUIRED
'ShadowModelVariants' => [ // REQUIRED
[
'SamplingPercentage' => , // REQUIRED
'ShadowModelVariantName' => '', // REQUIRED
],
// ...
],
'SourceModelVariantName' => '', // REQUIRED
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
'Type' => 'ShadowMode', // REQUIRED
]);
Parameter Details
Members
- DataStorageConfig
-
- Type: InferenceExperimentDataStorageConfig structure
The Amazon S3 location and configuration for storing inference request and response data.
This is an optional parameter that you can use for data capture. For more information, see Capture data.
- Description
-
- Type: string
A description for the inference experiment.
- EndpointName
-
- Required: Yes
- Type: string
The name of the Amazon SageMaker endpoint on which you want to run the inference experiment.
- KmsKey
-
- Type: string
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. The
KmsKeycan be any of the following formats:-
KMS key ID
"1234abcd-12ab-34cd-56ef-1234567890ab" -
Amazon Resource Name (ARN) of a KMS key
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" -
KMS key Alias
"alias/ExampleAlias" -
Amazon Resource Name (ARN) of a KMS key Alias
"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
If you use a KMS key ID or an alias of your KMS key, the Amazon SageMaker execution role must include permissions to call
kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS managed keys forOutputDataConfig. If you use a bucket policy with ans3:PutObjectpermission that only allows objects with server-side encryption, set the condition key ofs3:x-amz-server-side-encryptionto"aws:kms". For more information, see KMS managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.The KMS key policy must grant permission to the IAM role that you specify in your
CreateEndpointandUpdateEndpointrequests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide. - ModelVariants
-
- Required: Yes
- Type: Array of ModelVariantConfig structures
An array of
ModelVariantConfigobjects. There is one for each variant in the inference experiment. EachModelVariantConfigobject in the array describes the infrastructure configuration for the corresponding variant. - Name
-
- Required: Yes
- Type: string
The name for the inference experiment.
- RoleArn
-
- Required: Yes
- Type: string
The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.
- Schedule
-
- Type: InferenceExperimentSchedule structure
The duration for which you want the inference experiment to run. If you don't specify this field, the experiment automatically starts immediately upon creation and concludes after 7 days.
- ShadowModeConfig
-
- Required: Yes
- Type: ShadowModeConfig structure
The configuration of
ShadowModeinference experiment type. Use this field to specify a production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant also specify the percentage of requests that Amazon SageMaker replicates. - Tags
-
- Type: Array of Tag structures
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 your Amazon Web Services Resources.
- Type
-
- Required: Yes
- Type: string
The type of the inference experiment that you want to run. The following types of experiments are possible:
-
ShadowMode: You can use this type to validate a shadow variant. For more information, see Shadow tests.
Result Syntax
[
'InferenceExperimentArn' => '',
]
Result Details
Members
- InferenceExperimentArn
-
- Required: Yes
- Type: string
The ARN for your inference experiment.
Errors
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateInferenceRecommendationsJob
$result = $client->createInferenceRecommendationsJob([/* ... */]); $promise = $client->createInferenceRecommendationsJobAsync([/* ... */]);
Starts a recommendation job. You can create either an instance recommendation or load test job.
Parameter Syntax
$result = $client->createInferenceRecommendationsJob([
'InputConfig' => [ // REQUIRED
'ContainerConfig' => [
'DataInputConfig' => '',
'Domain' => '',
'Framework' => '',
'FrameworkVersion' => '',
'NearestModelName' => '',
'PayloadConfig' => [
'SamplePayloadUrl' => '',
'SupportedContentTypes' => ['', ...],
],
'SupportedEndpointType' => 'RealTime|Serverless',
'SupportedInstanceTypes' => ['', ...],
'SupportedResponseMIMETypes' => ['', ...],
'Task' => '',
],
'EndpointConfigurations' => [
[
'EnvironmentParameterRanges' => [
'CategoricalParameterRanges' => [
[
'Name' => '', // REQUIRED
'Value' => ['', ...], // REQUIRED
],
// ...
],
],
'InferenceSpecificationName' => '',
'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.12xlarge|ml.m5d.24xlarge|ml.c4.large|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.large|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.12xlarge|ml.r5.24xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.12xlarge|ml.r5d.24xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.dl1.24xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.r8g.medium|ml.r8g.large|ml.r8g.xlarge|ml.r8g.2xlarge|ml.r8g.4xlarge|ml.r8g.8xlarge|ml.r8g.12xlarge|ml.r8g.16xlarge|ml.r8g.24xlarge|ml.r8g.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.p4d.24xlarge|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m6gd.large|ml.m6gd.xlarge|ml.m6gd.2xlarge|ml.m6gd.4xlarge|ml.m6gd.8xlarge|ml.m6gd.12xlarge|ml.m6gd.16xlarge|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c6gd.large|ml.c6gd.xlarge|ml.c6gd.2xlarge|ml.c6gd.4xlarge|ml.c6gd.8xlarge|ml.c6gd.12xlarge|ml.c6gd.16xlarge|ml.c6gn.large|ml.c6gn.xlarge|ml.c6gn.2xlarge|ml.c6gn.4xlarge|ml.c6gn.8xlarge|ml.c6gn.12xlarge|ml.c6gn.16xlarge|ml.r6g.large|ml.r6g.xlarge|ml.r6g.2xlarge|ml.r6g.4xlarge|ml.r6g.8xlarge|ml.r6g.12xlarge|ml.r6g.16xlarge|ml.r6gd.large|ml.r6gd.xlarge|ml.r6gd.2xlarge|ml.r6gd.4xlarge|ml.r6gd.8xlarge|ml.r6gd.12xlarge|ml.r6gd.16xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.r7gd.medium|ml.r7gd.large|ml.r7gd.xlarge|ml.r7gd.2xlarge|ml.r7gd.4xlarge|ml.r7gd.8xlarge|ml.r7gd.12xlarge|ml.r7gd.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.c6in.large|ml.c6in.xlarge|ml.c6in.2xlarge|ml.c6in.4xlarge|ml.c6in.8xlarge|ml.c6in.12xlarge|ml.c6in.16xlarge|ml.c6in.24xlarge|ml.c6in.32xlarge|ml.p6-b200.48xlarge|ml.p6-b300.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge',
'ServerlessConfig' => [
'MaxConcurrency' => , // REQUIRED
'MemorySizeInMB' => , // REQUIRED
'ProvisionedConcurrency' => ,
],
],
// ...
],
'Endpoints' => [
[
'EndpointName' => '',
],
// ...
],
'JobDurationInSeconds' => ,
'ModelName' => '',
'ModelPackageVersionArn' => '',
'ResourceLimit' => [
'MaxNumberOfTests' => ,
'MaxParallelOfTests' => ,
],
'TrafficPattern' => [
'Phases' => [
[
'DurationInSeconds' => ,
'InitialNumberOfUsers' => ,
'SpawnRate' => ,
],
// ...
],
'Stairs' => [
'DurationInSeconds' => ,
'NumberOfSteps' => ,
'UsersPerStep' => ,
],
'TrafficType' => 'PHASES|STAIRS',
],
'VolumeKmsKeyId' => '',
'VpcConfig' => [
'SecurityGroupIds' => ['', ...], // REQUIRED
'Subnets' => ['', ...], // REQUIRED
],
],
'JobDescription' => '',
'JobName' => '', // REQUIRED
'JobType' => 'Default|Advanced', // REQUIRED
'OutputConfig' => [
'CompiledOutputConfig' => [
'S3OutputUri' => '',
],
'KmsKeyId' => '',
],
'RoleArn' => '', // REQUIRED
'StoppingConditions' => [
'FlatInvocations' => 'Continue|Stop',
'MaxInvocations' => ,
'ModelLatencyThresholds' => [
[
'Percentile' => '',
'ValueInMilliseconds' => ,
],
// ...
],
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- InputConfig
-
- Required: Yes
- Type: RecommendationJobInputConfig structure
Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.
- JobDescription
-
- Type: string
Description of the recommendation job.
- JobName
-
- Required: Yes
- Type: string
A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. The job name is passed down to the resources created by the recommendation job. The names of resources (such as the model, endpoint configuration, endpoint, and compilation) that are prefixed with the job name are truncated at 40 characters.
- JobType
-
- Required: Yes
- Type: string
Defines the type of recommendation job. Specify
Defaultto initiate an instance recommendation andAdvancedto initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job. - OutputConfig
-
- Type: RecommendationJobOutputConfig structure
Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
- StoppingConditions
-
- Type: RecommendationJobStoppingConditions structure
A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.
- Tags
-
- Type: Array of Tag structures
The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
Result Syntax
[
'JobArn' => '',
]
Result Details
Members
- JobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the recommendation job.
Errors
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateJob
$result = $client->createJob([/* ... */]); $promise = $client->createJobAsync([/* ... */]);
Creates a model customization job in Amazon SageMaker. A job runs a workload based on the job category and configuration you provide. You specify the job category, a schema-versioned configuration document, and an IAM role that grants Amazon SageMaker permission to access resources on your behalf.
Use the AgentRFT category to fine-tune a model using multi-turn reinforcement learning with reward signals. Use the AgentRFTEvaluation category to evaluate a fine-tuned or base model by running multi-turn rollouts against a held-out prompt dataset and computing metrics such as pass@k and mean reward.
Before creating a job, call ListJobSchemaVersions and DescribeJobSchemaVersion to retrieve the configuration schema for your job category. The JobConfigDocument must conform to the schema specified by JobConfigSchemaVersion.
The following operations are related to CreateJob:
-
DescribeJob -
ListJobs -
StopJob -
DeleteJob -
ListJobSchemaVersions -
DescribeJobSchemaVersion
Parameter Syntax
$result = $client->createJob([
'JobCategory' => 'AgentRFT|AgentRFTEvaluation', // REQUIRED
'JobConfigDocument' => '', // REQUIRED
'JobConfigSchemaVersion' => '', // REQUIRED
'JobName' => '', // REQUIRED
'RoleArn' => '', // REQUIRED
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- JobCategory
-
- Required: Yes
- Type: string
The category of the job. The category determines the type of workload that the job runs.
- JobConfigDocument
-
- Required: Yes
- Type: string
The JSON configuration document for the job. The document must conform to the schema specified by
JobConfigSchemaVersion. UseDescribeJobSchemaVersionto retrieve the schema for validation. - JobConfigSchemaVersion
-
- Required: Yes
- Type: string
The version of the configuration schema to use for the job configuration document. Use
ListJobSchemaVersionsto get available schema versions for a job category. - JobName
-
- Required: Yes
- Type: string
The name of the job. The name must be unique within your account and Amazon Web Services Region.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the job. The role must have the necessary permissions to access the resources required by the job configuration.
- Tags
-
- Type: Array of Tag structures
An array of key-value pairs to apply to the job as tags. For more information, see Tagging Amazon Web Services Resources.
Result Syntax
[
'JobArn' => '',
]
Result Details
Members
- JobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the job.
Errors
- ResourceNotFound:
Resource being access is not found.
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateLabelingJob
$result = $client->createLabelingJob([/* ... */]); $promise = $client->createLabelingJobAsync([/* ... */]);
Creates a job that uses workers to label the data objects in your input dataset. You can use the labeled data to train machine learning models.
You can select your workforce from one of three providers:
-
A private workforce that you create. It can include employees, contractors, and outside experts. Use a private workforce when want the data to stay within your organization or when a specific set of skills is required.
-
One or more vendors that you select from the Amazon Web Services Marketplace. Vendors provide expertise in specific areas.
-
The Amazon Mechanical Turk workforce. This is the largest workforce, but it should only be used for public data or data that has been stripped of any personally identifiable information.
You can also use automated data labeling to reduce the number of data objects that need to be labeled by a human. Automated data labeling uses active learning to determine if a data object can be labeled by machine or if it needs to be sent to a human worker. For more information, see Using Automated Data Labeling.
The data objects to be labeled are contained in an Amazon S3 bucket. You create a manifest file that describes the location of each object. For more information, see Using Input and Output Data.
The output can be used as the manifest file for another labeling job or as training data for your machine learning models.
You can use this operation to create a static labeling job or a streaming labeling job. A static labeling job stops if all data objects in the input manifest file identified in ManifestS3Uri have been labeled. A streaming labeling job runs perpetually until it is manually stopped, or remains idle for 10 days. You can send new data objects to an active (InProgress) streaming labeling job in real time. To learn how to create a static labeling job, see Create a Labeling Job (API) in the Amazon SageMaker Developer Guide. To learn how to create a streaming labeling job, see Create a Streaming Labeling Job.
Parameter Syntax
$result = $client->createLabelingJob([
'HumanTaskConfig' => [ // REQUIRED
'AnnotationConsolidationConfig' => [
'AnnotationConsolidationLambdaArn' => '', // REQUIRED
],
'MaxConcurrentTaskCount' => ,
'NumberOfHumanWorkersPerDataObject' => , // REQUIRED
'PreHumanTaskLambdaArn' => '',
'PublicWorkforceTaskPrice' => [
'AmountInUsd' => [
'Cents' => ,
'Dollars' => ,
'TenthFractionsOfACent' => ,
],
],
'TaskAvailabilityLifetimeInSeconds' => ,
'TaskDescription' => '', // REQUIRED
'TaskKeywords' => ['', ...],
'TaskTimeLimitInSeconds' => , // REQUIRED
'TaskTitle' => '', // REQUIRED
'UiConfig' => [ // REQUIRED
'HumanTaskUiArn' => '',
'UiTemplateS3Uri' => '',
],
'WorkteamArn' => '', // REQUIRED
],
'InputConfig' => [ // REQUIRED
'DataAttributes' => [
'ContentClassifiers' => ['', ...],
],
'DataSource' => [ // REQUIRED
'S3DataSource' => [
'ManifestS3Uri' => '', // REQUIRED
],
'SnsDataSource' => [
'SnsTopicArn' => '', // REQUIRED
],
],
],
'LabelAttributeName' => '', // REQUIRED
'LabelCategoryConfigS3Uri' => '',
'LabelingJobAlgorithmsConfig' => [
'InitialActiveLearningModelArn' => '',
'LabelingJobAlgorithmSpecificationArn' => '', // REQUIRED
'LabelingJobResourceConfig' => [
'VolumeKmsKeyId' => '',
'VpcConfig' => [
'SecurityGroupIds' => ['', ...], // REQUIRED
'Subnets' => ['', ...], // REQUIRED
],
],
],
'LabelingJobName' => '', // REQUIRED
'OutputConfig' => [ // REQUIRED
'KmsKeyId' => '',
'S3OutputPath' => '', // REQUIRED
'SnsTopicArn' => '',
],
'RoleArn' => '', // REQUIRED
'StoppingConditions' => [
'MaxHumanLabeledObjectCount' => ,
'MaxPercentageOfInputDatasetLabeled' => ,
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- HumanTaskConfig
-
- Required: Yes
- Type: HumanTaskConfig structure
Configures the labeling task and how it is presented to workers; including, but not limited to price, keywords, and batch size (task count).
- InputConfig
-
- Required: Yes
- Type: LabelingJobInputConfig structure
Input data for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.
You must specify at least one of the following:
S3DataSourceorSnsDataSource.-
Use
SnsDataSourceto specify an SNS input topic for a streaming labeling job. If you do not specify and SNS input topic ARN, Ground Truth will create a one-time labeling job that stops after all data objects in the input manifest file have been labeled. -
Use
S3DataSourceto specify an input manifest file for both streaming and one-time labeling jobs. Adding anS3DataSourceis optional if you useSnsDataSourceto create a streaming labeling job.
If you use the Amazon Mechanical Turk workforce, your input data should not include confidential information, personal information or protected health information. Use
ContentClassifiersto specify that your data is free of personally identifiable information and adult content. - LabelAttributeName
-
- Required: Yes
- Type: string
The attribute name to use for the label in the output manifest file. This is the key for the key/value pair formed with the label that a worker assigns to the object. The
LabelAttributeNamemust meet the following requirements.-
The name can't end with "-metadata".
-
If you are using one of the built-in task types or one of the following, the attribute name must end with "-ref".
-
Image semantic segmentation (
SemanticSegmentation)and adjustment (AdjustmentSemanticSegmentation) labeling jobs for this task type. One exception is that verification (VerificationSemanticSegmentation) must not end with -"ref". -
Video frame object detection (
VideoObjectDetection), and adjustment and verification (AdjustmentVideoObjectDetection) labeling jobs for this task type. -
Video frame object tracking (
VideoObjectTracking), and adjustment and verification (AdjustmentVideoObjectTracking) labeling jobs for this task type. -
3D point cloud semantic segmentation (
3DPointCloudSemanticSegmentation), and adjustment and verification (Adjustment3DPointCloudSemanticSegmentation) labeling jobs for this task type. -
3D point cloud object tracking (
3DPointCloudObjectTracking), and adjustment and verification (Adjustment3DPointCloudObjectTracking) labeling jobs for this task type.
-
If you are creating an adjustment or verification labeling job, you must use a different
LabelAttributeNamethan the one used in the original labeling job. The original labeling job is the Ground Truth labeling job that produced the labels that you want verified or adjusted. To learn more about adjustment and verification labeling jobs, see Verify and Adjust Labels. - LabelCategoryConfigS3Uri
-
- Type: string
The S3 URI of the file, referred to as a label category configuration file, that defines the categories used to label the data objects.
For 3D point cloud and video frame task types, you can add label category attributes and frame attributes to your label category configuration file. To learn how, see Create a Labeling Category Configuration File for 3D Point Cloud Labeling Jobs.
For named entity recognition jobs, in addition to
"labels", you must provide worker instructions in the label category configuration file using the"instructions"parameter:"instructions": {"shortInstruction":". For details and an example, see Create a Named Entity Recognition Labeling Job (API) .Add header
Add Instructions
", "fullInstruction":"Add additional instructions.
"}For all other built-in task types and custom tasks, your label category configuration file must be a JSON file in the following format. Identify the labels you want to use by replacing
label_1,label_2,...,label_nwith your label categories.{"document-version": "2018-11-28","labels": [{"label": "label_1"},{"label": "label_2"},...{"label": "label_n"}]}Note the following about the label category configuration file:
-
For image classification and text classification (single and multi-label) you must specify at least two label categories. For all other task types, the minimum number of label categories required is one.
-
Each label category must be unique, you cannot specify duplicate label categories.
-
If you create a 3D point cloud or video frame adjustment or verification labeling job, you must include
auditLabelAttributeNamein the label category configuration. Use this parameter to enter theLabelAttributeNameof the labeling job you want to adjust or verify annotations of.
- LabelingJobAlgorithmsConfig
-
- Type: LabelingJobAlgorithmsConfig structure
Configures the information required to perform automated data labeling.
- LabelingJobName
-
- Required: Yes
- Type: string
The name of the labeling job. This name is used to identify the job in a list of labeling jobs. Labeling job names must be unique within an Amazon Web Services account and region.
LabelingJobNameis not case sensitive. For example, Example-job and example-job are considered the same labeling job name by Ground Truth. - OutputConfig
-
- Required: Yes
- Type: LabelingJobOutputConfig structure
The location of the output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt the output data, if any.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete data labeling.
- StoppingConditions
-
- Type: LabelingJobStoppingConditions structure
A set of conditions for stopping the labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.
- Tags
-
- Type: Array of Tag structures
An array of key/value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
Result Syntax
[
'LabelingJobArn' => '',
]
Result Details
Members
- LabelingJobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the labeling job. You use this ARN to identify the labeling job.
Errors
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateMlflowApp
$result = $client->createMlflowApp([/* ... */]); $promise = $client->createMlflowAppAsync([/* ... */]);
Creates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact store.
Parameter Syntax
$result = $client->createMlflowApp([
'AccountDefaultStatus' => 'ENABLED|DISABLED',
'ArtifactStoreUri' => '', // REQUIRED
'DefaultDomainIdList' => ['', ...],
'KmsKeyId' => '',
'ModelRegistrationMode' => 'AutoModelRegistrationEnabled|AutoModelRegistrationDisabled',
'Name' => '', // REQUIRED
'RoleArn' => '', // REQUIRED
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
'WeeklyMaintenanceWindowStart' => '',
]);
Parameter Details
Members
- AccountDefaultStatus
-
- Type: string
Indicates whether this MLflow app is the default for the entire account.
- ArtifactStoreUri
-
- Required: Yes
- Type: string
The S3 URI for a general purpose bucket to use as the MLflow App artifact store.
- DefaultDomainIdList
-
- Type: Array of strings
List of SageMaker domain IDs for which this MLflow App is used as the default.
- KmsKeyId
-
- Type: string
The ID of the Amazon Web Services KMS key used to encrypt the data at rest associated with the MLflow App. If you don't specify a value, the MLflow App is not encrypted with a customer-managed key.
- ModelRegistrationMode
-
- Type: string
Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to
AutoModelRegistrationEnabled. To disable automatic model registration, set this value toAutoModelRegistrationDisabled. If not specified,AutomaticModelRegistrationdefaults toAutoModelRegistrationDisabled. - Name
-
- Required: Yes
- Type: string
A string identifying the MLflow app name. This string is not part of the tracking server ARN.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow App uses to access the artifact store in Amazon S3. The role should have the
AmazonS3FullAccesspermission. - Tags
-
- Type: Array of Tag structures
Tags consisting of key-value pairs used to manage metadata for the MLflow App.
- WeeklyMaintenanceWindowStart
-
- Type: string
The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: TUE:03:30.
Result Syntax
[
'Arn' => '',
]
Result Details
Members
- Arn
-
- Type: string
The ARN of the MLflow App.
Errors
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateMlflowTrackingServer
$result = $client->createMlflowTrackingServer([/* ... */]); $promise = $client->createMlflowTrackingServerAsync([/* ... */]);
Creates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact store. For more information, see Create an MLflow Tracking Server.
Parameter Syntax
$result = $client->createMlflowTrackingServer([
'ArtifactStoreUri' => '', // REQUIRED
'AutomaticModelRegistration' => true || false,
'MlflowVersion' => '',
'RoleArn' => '', // REQUIRED
'S3BucketOwnerAccountId' => '',
'S3BucketOwnerVerification' => true || false,
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
'TrackingServerName' => '', // REQUIRED
'TrackingServerSize' => 'Small|Medium|Large',
'WeeklyMaintenanceWindowStart' => '',
]);
Parameter Details
Members
- ArtifactStoreUri
-
- Required: Yes
- Type: string
The S3 URI for a general purpose bucket to use as the MLflow Tracking Server artifact store.
- AutomaticModelRegistration
-
- Type: boolean
Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to
True. To disable automatic model registration, set this value toFalse. If not specified,AutomaticModelRegistrationdefaults toFalse. - MlflowVersion
-
- Type: string
The version of MLflow that the tracking server uses. To see which MLflow versions are available to use, see How it works.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow Tracking Server uses to access the artifact store in Amazon S3. The role should have
AmazonS3FullAccesspermissions. For more information on IAM permissions for tracking server creation, see Set up IAM permissions for MLflow. - S3BucketOwnerAccountId
-
- Type: string
Expected Amazon Web Services account ID that owns the Amazon S3 bucket for artifact storage. Defaults to caller's account ID if not provided.
- S3BucketOwnerVerification
-
- Type: boolean
Enable Amazon S3 Ownership checks when interacting with Amazon S3 buckets from a SageMaker Managed MLflow Tracking Server. Defaults to
Trueif not provided. - Tags
-
- Type: Array of Tag structures
Tags consisting of key-value pairs used to manage metadata for the tracking server.
- TrackingServerName
-
- Required: Yes
- Type: string
A unique string identifying the tracking server name. This string is part of the tracking server ARN.
- TrackingServerSize
-
- Type: string
The size of the tracking server you want to create. You can choose between
"Small","Medium", and"Large". The default MLflow Tracking Server configuration size is"Small". You can choose a size depending on the projected use of the tracking server such as the volume of data logged, number of users, and frequency of use.We recommend using a small tracking server for teams of up to 25 users, a medium tracking server for teams of up to 50 users, and a large tracking server for teams of up to 100 users.
- WeeklyMaintenanceWindowStart
-
- Type: string
The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: TUE:03:30.
Result Syntax
[
'TrackingServerArn' => '',
]
Result Details
Members
- TrackingServerArn
-
- Type: string
The ARN of the tracking server.
Errors
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateModel
$result = $client->createModel([/* ... */]); $promise = $client->createModelAsync([/* ... */]);
Creates a model in SageMaker. In the request, you name the model and describe a primary container. For the primary container, you specify the Docker image that contains inference code, artifacts (from prior training), and a custom environment map that the inference code uses when you deploy the model for predictions.
Use this API to create a model if you want to use SageMaker hosting services or run a batch transform job.
To host your model, you create an endpoint configuration with the CreateEndpointConfig API, and then create an endpoint with the CreateEndpoint API. SageMaker then deploys all of the containers that you defined for the model in the hosting environment.
To run a batch transform using your model, you start a job with the CreateTransformJob API. SageMaker uses your model and your dataset to get inferences which are then saved to a specified S3 location.
In the request, you also provide an IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute hosting instances or for batch transform jobs. In addition, you also use the IAM role to manage permissions the inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.
Parameter Syntax
$result = $client->createModel([
'Containers' => [
[
'AdditionalModelDataSources' => [
[
'ChannelName' => '', // REQUIRED
'S3DataSource' => [ // REQUIRED
'CompressionType' => 'None|Gzip', // REQUIRED
'ETag' => '',
'HubAccessConfig' => [
'HubContentArn' => '', // REQUIRED
],
'ManifestEtag' => '',
'ManifestS3Uri' => '',
'ModelAccessConfig' => [
'AcceptEula' => true || false, // REQUIRED
],
'S3DataType' => 'S3Prefix|S3Object', // REQUIRED
'S3Uri' => '', // REQUIRED
],
],
// ...
],
'ContainerHostname' => '',
'ContainerMetricsConfig' => [
'MetricsEndpoints' => [
[
'MetricPublishFrequencyInSeconds' => ,
'MetricsEndpointPath' => '', // REQUIRED
],
// ...
],
],
'Environment' => ['', ...],
'Image' => '',
'ImageConfig' => [
'RepositoryAccessMode' => 'Platform|Vpc', // REQUIRED
'RepositoryAuthConfig' => [
'RepositoryCredentialsProviderArn' => '', // REQUIRED
],
],
'InferenceSpecificationName' => '',
'Mode' => 'SingleModel|MultiModel',
'ModelDataSource' => [
'S3DataSource' => [
'CompressionType' => 'None|Gzip', // REQUIRED
'ETag' => '',
'HubAccessConfig' => [
'HubContentArn' => '', // REQUIRED
],
'ManifestEtag' => '',
'ManifestS3Uri' => '',
'ModelAccessConfig' => [
'AcceptEula' => true || false, // REQUIRED
],
'S3DataType' => 'S3Prefix|S3Object', // REQUIRED
'S3Uri' => '', // REQUIRED
],
],
'ModelDataUrl' => '',
'ModelPackageName' => '',
'MultiModelConfig' => [
'ModelCacheSetting' => 'Enabled|Disabled',
],
],
// ...
],
'EnableNetworkIsolation' => true || false,
'ExecutionRoleArn' => '',
'InferenceExecutionConfig' => [
'Mode' => 'Serial|Direct', // REQUIRED
],
'ModelName' => '', // REQUIRED
'PrimaryContainer' => [
'AdditionalModelDataSources' => [
[
'ChannelName' => '', // REQUIRED
'S3DataSource' => [ // REQUIRED
'CompressionType' => 'None|Gzip', // REQUIRED
'ETag' => '',
'HubAccessConfig' => [
'HubContentArn' => '', // REQUIRED
],
'ManifestEtag' => '',
'ManifestS3Uri' => '',
'ModelAccessConfig' => [
'AcceptEula' => true || false, // REQUIRED
],
'S3DataType' => 'S3Prefix|S3Object', // REQUIRED
'S3Uri' => '', // REQUIRED
],
],
// ...
],
'ContainerHostname' => '',
'ContainerMetricsConfig' => [
'MetricsEndpoints' => [
[
'MetricPublishFrequencyInSeconds' => ,
'MetricsEndpointPath' => '', // REQUIRED
],
// ...
],
],
'Environment' => ['', ...],
'Image' => '',
'ImageConfig' => [
'RepositoryAccessMode' => 'Platform|Vpc', // REQUIRED
'RepositoryAuthConfig' => [
'RepositoryCredentialsProviderArn' => '', // REQUIRED
],
],
'InferenceSpecificationName' => '',
'Mode' => 'SingleModel|MultiModel',
'ModelDataSource' => [
'S3DataSource' => [
'CompressionType' => 'None|Gzip', // REQUIRED
'ETag' => '',
'HubAccessConfig' => [
'HubContentArn' => '', // REQUIRED
],
'ManifestEtag' => '',
'ManifestS3Uri' => '',
'ModelAccessConfig' => [
'AcceptEula' => true || false, // REQUIRED
],
'S3DataType' => 'S3Prefix|S3Object', // REQUIRED
'S3Uri' => '', // REQUIRED
],
],
'ModelDataUrl' => '',
'ModelPackageName' => '',
'MultiModelConfig' => [
'ModelCacheSetting' => 'Enabled|Disabled',
],
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
'VpcConfig' => [
'SecurityGroupIds' => ['', ...], // REQUIRED
'Subnets' => ['', ...], // REQUIRED
],
]);
Parameter Details
Members
- Containers
-
- Type: Array of ContainerDefinition structures
Specifies the containers in the inference pipeline.
- EnableNetworkIsolation
-
- Type: boolean
Isolates the model container. No inbound or outbound network calls can be made to or from the model container.
- ExecutionRoleArn
-
- Type: string
The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs. Deploying on ML compute instances is part of model hosting. For more information, see SageMaker Roles.
To be able to pass this role to SageMaker, the caller of this API must have the
iam:PassRolepermission. - InferenceExecutionConfig
-
- Type: InferenceExecutionConfig structure
Specifies details of how containers in a multi-container endpoint are called.
- ModelName
-
- Required: Yes
- Type: string
The name of the new model.
- PrimaryContainer
-
- Type: ContainerDefinition structure
The location of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.
- Tags
-
- 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.
- VpcConfig
-
- Type: VpcConfig structure
A VpcConfig object that specifies the VPC that you want your model to connect to. Control access to and from your model container by configuring the VPC.
VpcConfigis used in hosting services and in batch transform. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud.
Result Syntax
[
'ModelArn' => '',
]
Result Details
Members
- ModelArn
-
- Required: Yes
- Type: string
The ARN of the model created in SageMaker.
Errors
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateModelBiasJobDefinition
$result = $client->createModelBiasJobDefinition([/* ... */]); $promise = $client->createModelBiasJobDefinitionAsync([/* ... */]);
Creates the definition for a model bias job.
Parameter Syntax
$result = $client->createModelBiasJobDefinition([
'JobDefinitionName' => '', // REQUIRED
'JobResources' => [ // REQUIRED
'ClusterConfig' => [ // REQUIRED
'InstanceCount' => , // REQUIRED
'InstanceType' => 'ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p5.4xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge', // REQUIRED
'VolumeKmsKeyId' => '',
'VolumeSizeInGB' => , // REQUIRED
],
],
'ModelBiasAppSpecification' => [ // REQUIRED
'ConfigUri' => '', // REQUIRED
'Environment' => ['', ...],
'ImageUri' => '', // REQUIRED
],
'ModelBiasBaselineConfig' => [
'BaseliningJobName' => '',
'ConstraintsResource' => [
'S3Uri' => '',
],
],
'ModelBiasJobInput' => [ // REQUIRED
'BatchTransformInput' => [
'DataCapturedDestinationS3Uri' => '', // REQUIRED
'DatasetFormat' => [ // REQUIRED
'Csv' => [
'Header' => true || false,
],
'Json' => [
'Line' => true || false,
],
'Parquet' => [
],
],
'EndTimeOffset' => '',
'ExcludeFeaturesAttribute' => '',
'FeaturesAttribute' => '',
'InferenceAttribute' => '',
'LocalPath' => '', // REQUIRED
'ProbabilityAttribute' => '',
'ProbabilityThresholdAttribute' => ,
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3InputMode' => 'Pipe|File',
'StartTimeOffset' => '',
],
'EndpointInput' => [
'EndTimeOffset' => '',
'EndpointName' => '', // REQUIRED
'ExcludeFeaturesAttribute' => '',
'FeaturesAttribute' => '',
'InferenceAttribute' => '',
'LocalPath' => '', // REQUIRED
'ProbabilityAttribute' => '',
'ProbabilityThresholdAttribute' => ,
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3InputMode' => 'Pipe|File',
'StartTimeOffset' => '',
],
'GroundTruthS3Input' => [ // REQUIRED
'S3Uri' => '',
],
],
'ModelBiasJobOutputConfig' => [ // REQUIRED
'KmsKeyId' => '',
'MonitoringOutputs' => [ // REQUIRED
[
'S3Output' => [ // REQUIRED
'LocalPath' => '', // REQUIRED
'S3UploadMode' => 'Continuous|EndOfJob',
'S3Uri' => '', // REQUIRED
],
],
// ...
],
],
'NetworkConfig' => [
'EnableInterContainerTrafficEncryption' => true || false,
'EnableNetworkIsolation' => true || false,
'VpcConfig' => [
'SecurityGroupIds' => ['', ...], // REQUIRED
'Subnets' => ['', ...], // REQUIRED
],
],
'RoleArn' => '', // REQUIRED
'StoppingCondition' => [
'MaxRuntimeInSeconds' => , // REQUIRED
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- JobDefinitionName
-
- Required: Yes
- Type: string
The name of the bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
- JobResources
-
- Required: Yes
- Type: MonitoringResources structure
Identifies the resources to deploy for a monitoring job.
- ModelBiasAppSpecification
-
- Required: Yes
- Type: ModelBiasAppSpecification structure
Configures the model bias job to run a specified Docker container image.
- ModelBiasBaselineConfig
-
- Type: ModelBiasBaselineConfig structure
The baseline configuration for a model bias job.
- ModelBiasJobInput
-
- Required: Yes
- Type: ModelBiasJobInput structure
Inputs for the model bias job.
- ModelBiasJobOutputConfig
-
- Required: Yes
- Type: MonitoringOutputConfig structure
The output configuration for monitoring jobs.
- NetworkConfig
-
- Type: MonitoringNetworkConfig structure
Networking options for a model bias job.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.
- StoppingCondition
-
- Type: MonitoringStoppingCondition structure
A time limit for how long the monitoring job is allowed to run before stopping.
- Tags
-
- Type: Array of Tag structures
(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
Result Syntax
[
'JobDefinitionArn' => '',
]
Result Details
Members
- JobDefinitionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the model bias job.
Errors
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateModelCard
$result = $client->createModelCard([/* ... */]); $promise = $client->createModelCardAsync([/* ... */]);
Creates an Amazon SageMaker Model Card.
For information about how to use model cards, see Amazon SageMaker Model Card.
Parameter Syntax
$result = $client->createModelCard([
'Content' => '', // REQUIRED
'ModelCardName' => '', // REQUIRED
'ModelCardStatus' => 'Draft|PendingReview|Approved|Archived', // REQUIRED
'SecurityConfig' => [
'KmsKeyId' => '',
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- Content
-
- Required: Yes
- Type: string
The content of the model card. Content must be in model card JSON schema and provided as a string.
- ModelCardName
-
- Required: Yes
- Type: string
The unique name of the model card.
- ModelCardStatus
-
- Required: Yes
- Type: string
The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
-
Draft: The model card is a work in progress. -
PendingReview: The model card is pending review. -
Approved: The model card is approved. -
Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.
- SecurityConfig
-
- Type: ModelCardSecurityConfig structure
An optional Key Management Service key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with highly sensitive data.
- Tags
-
- Type: Array of Tag structures
Key-value pairs used to manage metadata for model cards.
Result Syntax
[
'ModelCardArn' => '',
]
Result Details
Members
- ModelCardArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the successfully created model card.
Errors
- ConflictException:
There was a conflict when you attempted to modify a SageMaker entity such as an
ExperimentorArtifact.- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateModelCardExportJob
$result = $client->createModelCardExportJob([/* ... */]); $promise = $client->createModelCardExportJobAsync([/* ... */]);
Creates an Amazon SageMaker Model Card export job.
Parameter Syntax
$result = $client->createModelCardExportJob([
'ModelCardExportJobName' => '', // REQUIRED
'ModelCardName' => '', // REQUIRED
'ModelCardVersion' => ,
'OutputConfig' => [ // REQUIRED
'S3OutputPath' => '', // REQUIRED
],
]);
Parameter Details
Members
- ModelCardExportJobName
-
- Required: Yes
- Type: string
The name of the model card export job.
- ModelCardName
-
- Required: Yes
- Type: string
The name or Amazon Resource Name (ARN) of the model card to export.
- ModelCardVersion
-
- Type: int
The version of the model card to export. If a version is not provided, then the latest version of the model card is exported.
- OutputConfig
-
- Required: Yes
- Type: ModelCardExportOutputConfig structure
The model card output configuration that specifies the Amazon S3 path for exporting.
Result Syntax
[
'ModelCardExportJobArn' => '',
]
Result Details
Members
- ModelCardExportJobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the model card export job.
Errors
- ConflictException:
There was a conflict when you attempted to modify a SageMaker entity such as an
ExperimentorArtifact.- 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.
CreateModelExplainabilityJobDefinition
$result = $client->createModelExplainabilityJobDefinition([/* ... */]); $promise = $client->createModelExplainabilityJobDefinitionAsync([/* ... */]);
Creates the definition for a model explainability job.
Parameter Syntax
$result = $client->createModelExplainabilityJobDefinition([
'JobDefinitionName' => '', // REQUIRED
'JobResources' => [ // REQUIRED
'ClusterConfig' => [ // REQUIRED
'InstanceCount' => , // REQUIRED
'InstanceType' => 'ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p5.4xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge', // REQUIRED
'VolumeKmsKeyId' => '',
'VolumeSizeInGB' => , // REQUIRED
],
],
'ModelExplainabilityAppSpecification' => [ // REQUIRED
'ConfigUri' => '', // REQUIRED
'Environment' => ['', ...],
'ImageUri' => '', // REQUIRED
],
'ModelExplainabilityBaselineConfig' => [
'BaseliningJobName' => '',
'ConstraintsResource' => [
'S3Uri' => '',
],
],
'ModelExplainabilityJobInput' => [ // REQUIRED
'BatchTransformInput' => [
'DataCapturedDestinationS3Uri' => '', // REQUIRED
'DatasetFormat' => [ // REQUIRED
'Csv' => [
'Header' => true || false,
],
'Json' => [
'Line' => true || false,
],
'Parquet' => [
],
],
'EndTimeOffset' => '',
'ExcludeFeaturesAttribute' => '',
'FeaturesAttribute' => '',
'InferenceAttribute' => '',
'LocalPath' => '', // REQUIRED
'ProbabilityAttribute' => '',
'ProbabilityThresholdAttribute' => ,
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3InputMode' => 'Pipe|File',
'StartTimeOffset' => '',
],
'EndpointInput' => [
'EndTimeOffset' => '',
'EndpointName' => '', // REQUIRED
'ExcludeFeaturesAttribute' => '',
'FeaturesAttribute' => '',
'InferenceAttribute' => '',
'LocalPath' => '', // REQUIRED
'ProbabilityAttribute' => '',
'ProbabilityThresholdAttribute' => ,
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3InputMode' => 'Pipe|File',
'StartTimeOffset' => '',
],
],
'ModelExplainabilityJobOutputConfig' => [ // REQUIRED
'KmsKeyId' => '',
'MonitoringOutputs' => [ // REQUIRED
[
'S3Output' => [ // REQUIRED
'LocalPath' => '', // REQUIRED
'S3UploadMode' => 'Continuous|EndOfJob',
'S3Uri' => '', // REQUIRED
],
],
// ...
],
],
'NetworkConfig' => [
'EnableInterContainerTrafficEncryption' => true || false,
'EnableNetworkIsolation' => true || false,
'VpcConfig' => [
'SecurityGroupIds' => ['', ...], // REQUIRED
'Subnets' => ['', ...], // REQUIRED
],
],
'RoleArn' => '', // REQUIRED
'StoppingCondition' => [
'MaxRuntimeInSeconds' => , // REQUIRED
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- JobDefinitionName
-
- Required: Yes
- Type: string
The name of the model explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
- JobResources
-
- Required: Yes
- Type: MonitoringResources structure
Identifies the resources to deploy for a monitoring job.
- ModelExplainabilityAppSpecification
-
- Required: Yes
- Type: ModelExplainabilityAppSpecification structure
Configures the model explainability job to run a specified Docker container image.
- ModelExplainabilityBaselineConfig
-
- Type: ModelExplainabilityBaselineConfig structure
The baseline configuration for a model explainability job.
- ModelExplainabilityJobInput
-
- Required: Yes
- Type: ModelExplainabilityJobInput structure
Inputs for the model explainability job.
- ModelExplainabilityJobOutputConfig
-
- Required: Yes
- Type: MonitoringOutputConfig structure
The output configuration for monitoring jobs.
- NetworkConfig
-
- Type: MonitoringNetworkConfig structure
Networking options for a model explainability job.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.
- StoppingCondition
-
- Type: MonitoringStoppingCondition structure
A time limit for how long the monitoring job is allowed to run before stopping.
- Tags
-
- Type: Array of Tag structures
(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
Result Syntax
[
'JobDefinitionArn' => '',
]
Result Details
Members
- JobDefinitionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the model explainability job.
Errors
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateModelPackage
$result = $client->createModelPackage([/* ... */]); $promise = $client->createModelPackageAsync([/* ... */]);
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. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.
To create a model package by specifying a Docker container that contains your inference code and the Amazon S3 location of your model artifacts, provide values for InferenceSpecification. To create a model from an algorithm resource that you created or subscribed to in Amazon Web Services Marketplace, provide a value for SourceAlgorithmSpecification.
There are two types of model packages:
-
Versioned - a model that is part of a model group in the model registry.
-
Unversioned - a model package that is not part of a model group.
Parameter Syntax
$result = $client->createModelPackage([
'AdditionalInferenceSpecifications' => [
[
'Containers' => [ // REQUIRED
[
'AdditionalModelDataSources' => [
[
'ChannelName' => '', // REQUIRED
'S3DataSource' => [ // REQUIRED
'CompressionType' => 'None|Gzip', // REQUIRED
'ETag' => '',
'HubAccessConfig' => [
'HubContentArn' => '', // REQUIRED
],
'ManifestEtag' => '',
'ManifestS3Uri' => '',
'ModelAccessConfig' => [
'AcceptEula' => true || false, // REQUIRED
],
'S3DataType' => 'S3Prefix|S3Object', // REQUIRED
'S3Uri' => '', // REQUIRED
],
],
// ...
],
'AdditionalS3DataSource' => [
'CompressionType' => 'None|Gzip',
'ETag' => '',
'S3DataType' => 'S3Object|S3Prefix', // REQUIRED
'S3Uri' => '', // REQUIRED
],
'BaseModel' => [
'HubContentName' => '',
'HubContentVersion' => '',
'RecipeName' => '',
],
'ContainerHostname' => '',
'Environment' => ['', ...],
'Framework' => '',
'FrameworkVersion' => '',
'Image' => '',
'ImageDigest' => '',
'IsCheckpoint' => true || false,
'ModelDataETag' => '',
'ModelDataSource' => [
'S3DataSource' => [
'CompressionType' => 'None|Gzip', // REQUIRED
'ETag' => '',
'HubAccessConfig' => [
'HubContentArn' => '', // REQUIRED
],
'ManifestEtag' => '',
'ManifestS3Uri' => '',
'ModelAccessConfig' => [
'AcceptEula' => true || false, // REQUIRED
],
'S3DataType' => 'S3Prefix|S3Object', // REQUIRED
'S3Uri' => '', // REQUIRED
],
],
'ModelDataUrl' => '',
'ModelInput' => [
'DataInputConfig' => '', // REQUIRED
],
'NearestModelName' => '',
'ProductId' => '',
],
// ...
],
'Description' => '',
'Name' => '', // REQUIRED
'SupportedContentTypes' => ['', ...],
'SupportedRealtimeInferenceInstanceTypes' => ['', ...],
'SupportedResponseMIMETypes' => ['', ...],
'SupportedTransformInstanceTypes' => ['', ...],
],
// ...
],
'CertifyForMarketplace' => true || false,
'ClientToken' => '',
'CustomerMetadataProperties' => ['', ...],
'Domain' => '',
'DriftCheckBaselines' => [
'Bias' => [
'ConfigFile' => [
'ContentDigest' => '',
'ContentType' => '',
'S3Uri' => '', // REQUIRED
],
'PostTrainingConstraints' => [
'ContentDigest' => '',
'ContentType' => '', // REQUIRED
'S3Uri' => '', // REQUIRED
],
'PreTrainingConstraints' => [
'ContentDigest' => '',
'ContentType' => '', // REQUIRED
'S3Uri' => '', // REQUIRED
],
],
'Explainability' => [
'ConfigFile' => [
'ContentDigest' => '',
'ContentType' => '',
'S3Uri' => '', // REQUIRED
],
'Constraints' => [
'ContentDigest' => '',
'ContentType' => '', // REQUIRED
'S3Uri' => '', // REQUIRED
],
],
'ModelDataQuality' => [
'Constraints' => [
'ContentDigest' => '',
'ContentType' => '', // REQUIRED
'S3Uri' => '', // REQUIRED
],
'Statistics' => [
'ContentDigest' => '',
'ContentType' => '', // REQUIRED
'S3Uri' => '', // REQUIRED
],
],
'ModelQuality' => [
'Constraints' => [
'ContentDigest' => '',
'ContentType' => '', // REQUIRED
'S3Uri' => '', // REQUIRED
],
'Statistics' => [
'ContentDigest' => '',
'ContentType' => '', // REQUIRED
'S3Uri' => '', // REQUIRED
],
],
],
'InferenceSpecification' => [
'Containers' => [ // REQUIRED
[
'AdditionalModelDataSources' => [
[
'ChannelName' => '', // REQUIRED
'S3DataSource' => [ // REQUIRED
'CompressionType' => 'None|Gzip', // REQUIRED
'ETag' => '',
'HubAccessConfig' => [
'HubContentArn' => '', // REQUIRED
],
'ManifestEtag' => '',
'ManifestS3Uri' => '',
'ModelAccessConfig' => [
'AcceptEula' => true || false, // REQUIRED
],
'S3DataType' => 'S3Prefix|S3Object', // REQUIRED
'S3Uri' => '', // REQUIRED
],
],
// ...
],
'AdditionalS3DataSource' => [
'CompressionType' => 'None|Gzip',
'ETag' => '',
'S3DataType' => 'S3Object|S3Prefix', // REQUIRED
'S3Uri' => '', // REQUIRED
],
'BaseModel' => [
'HubContentName' => '',
'HubContentVersion' => '',
'RecipeName' => '',
],
'ContainerHostname' => '',
'Environment' => ['', ...],
'Framework' => '',
'FrameworkVersion' => '',
'Image' => '',
'ImageDigest' => '',
'IsCheckpoint' => true || false,
'ModelDataETag' => '',
'ModelDataSource' => [
'S3DataSource' => [
'CompressionType' => 'None|Gzip', // REQUIRED
'ETag' => '',
'HubAccessConfig' => [
'HubContentArn' => '', // REQUIRED
],
'ManifestEtag' => '',
'ManifestS3Uri' => '',
'ModelAccessConfig' => [
'AcceptEula' => true || false, // REQUIRED
],
'S3DataType' => 'S3Prefix|S3Object', // REQUIRED
'S3Uri' => '', // REQUIRED
],
],
'ModelDataUrl' => '',
'ModelInput' => [
'DataInputConfig' => '', // REQUIRED
],
'NearestModelName' => '',
'ProductId' => '',
],
// ...
],
'SupportedContentTypes' => ['', ...],
'SupportedRealtimeInferenceInstanceTypes' => ['', ...],
'SupportedResponseMIMETypes' => ['', ...],
'SupportedTransformInstanceTypes' => ['', ...],
],
'ManagedStorageType' => 'Restricted',
'MetadataProperties' => [
'CommitId' => '',
'GeneratedBy' => '',
'ProjectId' => '',
'Repository' => '',
],
'ModelApprovalStatus' => 'Approved|Rejected|PendingManualApproval',
'ModelCard' => [
'ModelCardContent' => '',
'ModelCardStatus' => 'Draft|PendingReview|Approved|Archived',
],
'ModelLifeCycle' => [
'Stage' => '', // REQUIRED
'StageDescription' => '',
'StageStatus' => '', // REQUIRED
],
'ModelMetrics' => [
'Bias' => [
'PostTrainingReport' => [
'ContentDigest' => '',
'ContentType' => '', // REQUIRED
'S3Uri' => '', // REQUIRED
],
'PreTrainingReport' => [
'ContentDigest' => '',
'ContentType' => '', // REQUIRED
'S3Uri' => '', // REQUIRED
],
'Report' => [
'ContentDigest' => '',
'ContentType' => '', // REQUIRED
'S3Uri' => '', // REQUIRED
],
],
'Explainability' => [
'Report' => [
'ContentDigest' => '',
'ContentType' => '', // REQUIRED
'S3Uri' => '', // REQUIRED
],
],
'ModelDataQuality' => [
'Constraints' => [
'ContentDigest' => '',
'ContentType' => '', // REQUIRED
'S3Uri' => '', // REQUIRED
],
'Statistics' => [
'ContentDigest' => '',
'ContentType' => '', // REQUIRED
'S3Uri' => '', // REQUIRED
],
],
'ModelQuality' => [
'Constraints' => [
'ContentDigest' => '',
'ContentType' => '', // REQUIRED
'S3Uri' => '', // REQUIRED
],
'Statistics' => [
'ContentDigest' => '',
'ContentType' => '', // REQUIRED
'S3Uri' => '', // REQUIRED
],
],
],
'ModelPackageDescription' => '',
'ModelPackageGroupName' => '',
'ModelPackageName' => '',
'ModelPackageRegistrationType' => 'Logged|Registered',
'SamplePayloadUrl' => '',
'SecurityConfig' => [
'KmsKeyId' => '', // REQUIRED
],
'SkipModelValidation' => 'All|None',
'SourceAlgorithmSpecification' => [
'SourceAlgorithms' => [ // REQUIRED
[
'AlgorithmName' => '', // REQUIRED
'ModelDataETag' => '',
'ModelDataSource' => [
'S3DataSource' => [
'CompressionType' => 'None|Gzip', // REQUIRED
'ETag' => '',
'HubAccessConfig' => [
'HubContentArn' => '', // REQUIRED
],
'ManifestEtag' => '',
'ManifestS3Uri' => '',
'ModelAccessConfig' => [
'AcceptEula' => true || false, // REQUIRED
],
'S3DataType' => 'S3Prefix|S3Object', // REQUIRED
'S3Uri' => '', // REQUIRED
],
],
'ModelDataUrl' => '',
],
// ...
],
],
'SourceUri' => '',
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
'Task' => '',
'ValidationSpecification' => [
'ValidationProfiles' => [ // REQUIRED
[
'ProfileName' => '', // REQUIRED
'TransformJobDefinition' => [ // REQUIRED
'BatchStrategy' => 'MultiRecord|SingleRecord',
'Environment' => ['', ...],
'MaxConcurrentTransforms' => ,
'MaxPayloadInMB' => ,
'TransformInput' => [ // REQUIRED
'CompressionType' => 'None|Gzip',
'ContentType' => '',
'DataSource' => [ // REQUIRED
'S3DataSource' => [ // REQUIRED
'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile|Converse', // REQUIRED
'S3Uri' => '', // REQUIRED
],
],
'SplitType' => 'None|Line|RecordIO|TFRecord',
],
'TransformOutput' => [ // REQUIRED
'Accept' => '',
'AssembleWith' => 'None|Line',
'KmsKeyId' => '',
'S3OutputPath' => '', // REQUIRED
],
'TransformResources' => [ // REQUIRED
'InstanceCount' => , // REQUIRED
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge', // REQUIRED
'TransformAmiVersion' => '',
'VolumeKmsKeyId' => '',
],
],
],
// ...
],
'ValidationRole' => '', // REQUIRED
],
]);
Parameter Details
Members
- AdditionalInferenceSpecifications
-
- Type: Array of AdditionalInferenceSpecificationDefinition structures
An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.
- CertifyForMarketplace
-
- Type: boolean
Whether to certify the model package for listing on Amazon Web Services Marketplace.
This parameter is optional for unversioned models, and does not apply to versioned models.
- ClientToken
-
- Type: string
A unique token that guarantees that the call to this API is idempotent.
- CustomerMetadataProperties
-
- Type: Associative array of custom strings keys (CustomerMetadataKey) to strings
The metadata properties associated with the model package versions.
- Domain
-
- Type: string
The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.
- DriftCheckBaselines
-
- Type: DriftCheckBaselines structure
Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.
- InferenceSpecification
-
- Type: InferenceSpecification structure
Specifies details about inference jobs that you can run with models based on this model package, including the following information:
-
The Amazon ECR paths of containers that contain the inference code and model artifacts.
-
The instance types that the model package supports for transform jobs and real-time endpoints used for inference.
-
The input and output content formats that the model package supports for inference.
- ManagedStorageType
-
- Type: string
The storage type of the model package.
- MetadataProperties
-
- Type: MetadataProperties structure
Metadata properties of the tracking entity, trial, or trial component.
- ModelApprovalStatus
-
- Type: string
Whether the model is approved for deployment.
This parameter is optional for versioned models, and does not apply to unversioned models.
For versioned models, the value of this parameter must be set to
Approvedto deploy the model. - ModelCard
-
- Type: ModelPackageModelCard structure
The model card associated with the model package. Since
ModelPackageModelCardis tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema ofModelCard. TheModelPackageModelCardschema does not includemodel_package_details, andmodel_overviewis composed of themodel_creatorandmodel_artifactproperties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version. - ModelLifeCycle
-
- Type: ModelLifeCycle structure
A structure describing the current state of the model in its life cycle.
- ModelMetrics
-
- Type: ModelMetrics structure
A structure that contains model metrics reports.
- ModelPackageDescription
-
- Type: string
A description of the model package.
- ModelPackageGroupName
-
- Type: string
The name or Amazon Resource Name (ARN) of the model package group that this model version belongs to.
This parameter is required for versioned models, and does not apply to unversioned models.
- ModelPackageName
-
- Type: string
The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
This parameter is required for unversioned models. It is not applicable to versioned models.
- ModelPackageRegistrationType
-
- Type: string
The package registration type of the model package input.
- SamplePayloadUrl
-
- Type: string
The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). This archive can hold multiple files that are all equally used in the load test. Each file in the archive must satisfy the size constraints of the InvokeEndpoint call.
- SecurityConfig
-
- Type: ModelPackageSecurityConfig structure
The KMS Key ID (
KMSKeyId) used for encryption of model package information. - SkipModelValidation
-
- Type: string
Indicates if you want to skip model validation.
- SourceAlgorithmSpecification
-
- Type: SourceAlgorithmSpecification structure
Details about the algorithm that was used to create the model package.
- SourceUri
-
- Type: string
The URI of the source for the model package. If you want to clone a model package, set it to the model package Amazon Resource Name (ARN). If you want to register a model, set it to the model ARN.
- Tags
-
- Type: Array of Tag structures
A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
If you supply
ModelPackageGroupName, your model package belongs to the model group you specify and uses the tags associated with the model group. In this case, you cannot supply atagargument. - Task
-
- Type: string
The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification. The following tasks are supported by Inference Recommender:
"IMAGE_CLASSIFICATION"|"OBJECT_DETECTION"|"TEXT_GENERATION"|"IMAGE_SEGMENTATION"|"FILL_MASK"|"CLASSIFICATION"|"REGRESSION"|"OTHER".Specify "OTHER" if none of the tasks listed fit your use case.
- ValidationSpecification
-
- Type: ModelPackageValidationSpecification structure
Specifies configurations for one or more transform jobs that SageMaker runs to test the model package.
Result Syntax
[
'ModelPackageArn' => '',
]
Result Details
Members
- ModelPackageArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the new model package.
Errors
- ConflictException:
There was a conflict when you attempted to modify a SageMaker entity such as an
ExperimentorArtifact.- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateModelPackageGroup
$result = $client->createModelPackageGroup([/* ... */]); $promise = $client->createModelPackageGroupAsync([/* ... */]);
Creates a model group. A model group contains a group of model versions.
Parameter Syntax
$result = $client->createModelPackageGroup([
'ManagedConfiguration' => [
'ManagedStorageType' => 'Restricted',
],
'ModelPackageGroupDescription' => '',
'ModelPackageGroupName' => '', // REQUIRED
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ManagedConfiguration
-
- Type: ManagedConfiguration structure
The managed configuration of the model package group.
- ModelPackageGroupDescription
-
- Type: string
A description for the model group.
- ModelPackageGroupName
-
- Required: Yes
- Type: string
The name of the model group.
- Tags
-
- Type: Array of Tag structures
A list of key value pairs associated with the model group. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
Result Syntax
[
'ModelPackageGroupArn' => '',
]
Result Details
Members
- ModelPackageGroupArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the model group.
Errors
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateModelQualityJobDefinition
$result = $client->createModelQualityJobDefinition([/* ... */]); $promise = $client->createModelQualityJobDefinitionAsync([/* ... */]);
Creates a definition for a job that monitors model quality and drift. For information about model monitor, see Amazon SageMaker AI Model Monitor.
Parameter Syntax
$result = $client->createModelQualityJobDefinition([
'JobDefinitionName' => '', // REQUIRED
'JobResources' => [ // REQUIRED
'ClusterConfig' => [ // REQUIRED
'InstanceCount' => , // REQUIRED
'InstanceType' => 'ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p5.4xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge', // REQUIRED
'VolumeKmsKeyId' => '',
'VolumeSizeInGB' => , // REQUIRED
],
],
'ModelQualityAppSpecification' => [ // REQUIRED
'ContainerArguments' => ['', ...],
'ContainerEntrypoint' => ['', ...],
'Environment' => ['', ...],
'ImageUri' => '', // REQUIRED
'PostAnalyticsProcessorSourceUri' => '',
'ProblemType' => 'BinaryClassification|MulticlassClassification|Regression',
'RecordPreprocessorSourceUri' => '',
],
'ModelQualityBaselineConfig' => [
'BaseliningJobName' => '',
'ConstraintsResource' => [
'S3Uri' => '',
],
],
'ModelQualityJobInput' => [ // REQUIRED
'BatchTransformInput' => [
'DataCapturedDestinationS3Uri' => '', // REQUIRED
'DatasetFormat' => [ // REQUIRED
'Csv' => [
'Header' => true || false,
],
'Json' => [
'Line' => true || false,
],
'Parquet' => [
],
],
'EndTimeOffset' => '',
'ExcludeFeaturesAttribute' => '',
'FeaturesAttribute' => '',
'InferenceAttribute' => '',
'LocalPath' => '', // REQUIRED
'ProbabilityAttribute' => '',
'ProbabilityThresholdAttribute' => ,
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3InputMode' => 'Pipe|File',
'StartTimeOffset' => '',
],
'EndpointInput' => [
'EndTimeOffset' => '',
'EndpointName' => '', // REQUIRED
'ExcludeFeaturesAttribute' => '',
'FeaturesAttribute' => '',
'InferenceAttribute' => '',
'LocalPath' => '', // REQUIRED
'ProbabilityAttribute' => '',
'ProbabilityThresholdAttribute' => ,
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3InputMode' => 'Pipe|File',
'StartTimeOffset' => '',
],
'GroundTruthS3Input' => [ // REQUIRED
'S3Uri' => '',
],
],
'ModelQualityJobOutputConfig' => [ // REQUIRED
'KmsKeyId' => '',
'MonitoringOutputs' => [ // REQUIRED
[
'S3Output' => [ // REQUIRED
'LocalPath' => '', // REQUIRED
'S3UploadMode' => 'Continuous|EndOfJob',
'S3Uri' => '', // REQUIRED
],
],
// ...
],
],
'NetworkConfig' => [
'EnableInterContainerTrafficEncryption' => true || false,
'EnableNetworkIsolation' => true || false,
'VpcConfig' => [
'SecurityGroupIds' => ['', ...], // REQUIRED
'Subnets' => ['', ...], // REQUIRED
],
],
'RoleArn' => '', // REQUIRED
'StoppingCondition' => [
'MaxRuntimeInSeconds' => , // REQUIRED
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- JobDefinitionName
-
- Required: Yes
- Type: string
The name of the monitoring job definition.
- JobResources
-
- Required: Yes
- Type: MonitoringResources structure
Identifies the resources to deploy for a monitoring job.
- ModelQualityAppSpecification
-
- Required: Yes
- Type: ModelQualityAppSpecification structure
The container that runs the monitoring job.
- ModelQualityBaselineConfig
-
- Type: ModelQualityBaselineConfig structure
Specifies the constraints and baselines for the monitoring job.
- ModelQualityJobInput
-
- Required: Yes
- Type: ModelQualityJobInput structure
A list of the inputs that are monitored. Currently endpoints are supported.
- ModelQualityJobOutputConfig
-
- Required: Yes
- Type: MonitoringOutputConfig structure
The output configuration for monitoring jobs.
- NetworkConfig
-
- Type: MonitoringNetworkConfig structure
Specifies the network configuration for the monitoring job.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.
- StoppingCondition
-
- Type: MonitoringStoppingCondition structure
A time limit for how long the monitoring job is allowed to run before stopping.
- Tags
-
- Type: Array of Tag structures
(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
Result Syntax
[
'JobDefinitionArn' => '',
]
Result Details
Members
- JobDefinitionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the model quality monitoring job.
Errors
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateMonitoringSchedule
$result = $client->createMonitoringSchedule([/* ... */]); $promise = $client->createMonitoringScheduleAsync([/* ... */]);
Creates a schedule that regularly starts Amazon SageMaker AI Processing Jobs to monitor the data captured for an Amazon SageMaker AI Endpoint.
Parameter Syntax
$result = $client->createMonitoringSchedule([
'MonitoringScheduleConfig' => [ // REQUIRED
'MonitoringJobDefinition' => [
'BaselineConfig' => [
'BaseliningJobName' => '',
'ConstraintsResource' => [
'S3Uri' => '',
],
'StatisticsResource' => [
'S3Uri' => '',
],
],
'Environment' => ['', ...],
'MonitoringAppSpecification' => [ // REQUIRED
'ContainerArguments' => ['', ...],
'ContainerEntrypoint' => ['', ...],
'ImageUri' => '', // REQUIRED
'PostAnalyticsProcessorSourceUri' => '',
'RecordPreprocessorSourceUri' => '',
],
'MonitoringInputs' => [ // REQUIRED
[
'BatchTransformInput' => [
'DataCapturedDestinationS3Uri' => '', // REQUIRED
'DatasetFormat' => [ // REQUIRED
'Csv' => [
'Header' => true || false,
],
'Json' => [
'Line' => true || false,
],
'Parquet' => [
],
],
'EndTimeOffset' => '',
'ExcludeFeaturesAttribute' => '',
'FeaturesAttribute' => '',
'InferenceAttribute' => '',
'LocalPath' => '', // REQUIRED
'ProbabilityAttribute' => '',
'ProbabilityThresholdAttribute' => ,
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3InputMode' => 'Pipe|File',
'StartTimeOffset' => '',
],
'EndpointInput' => [
'EndTimeOffset' => '',
'EndpointName' => '', // REQUIRED
'ExcludeFeaturesAttribute' => '',
'FeaturesAttribute' => '',
'InferenceAttribute' => '',
'LocalPath' => '', // REQUIRED
'ProbabilityAttribute' => '',
'ProbabilityThresholdAttribute' => ,
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3InputMode' => 'Pipe|File',
'StartTimeOffset' => '',
],
],
// ...
],
'MonitoringOutputConfig' => [ // REQUIRED
'KmsKeyId' => '',
'MonitoringOutputs' => [ // REQUIRED
[
'S3Output' => [ // REQUIRED
'LocalPath' => '', // REQUIRED
'S3UploadMode' => 'Continuous|EndOfJob',
'S3Uri' => '', // REQUIRED
],
],
// ...
],
],
'MonitoringResources' => [ // REQUIRED
'ClusterConfig' => [ // REQUIRED
'InstanceCount' => , // REQUIRED
'InstanceType' => 'ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p5.4xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge', // REQUIRED
'VolumeKmsKeyId' => '',
'VolumeSizeInGB' => , // REQUIRED
],
],
'NetworkConfig' => [
'EnableInterContainerTrafficEncryption' => true || false,
'EnableNetworkIsolation' => true || false,
'VpcConfig' => [
'SecurityGroupIds' => ['', ...], // REQUIRED
'Subnets' => ['', ...], // REQUIRED
],
],
'RoleArn' => '', // REQUIRED
'StoppingCondition' => [
'MaxRuntimeInSeconds' => , // REQUIRED
],
],
'MonitoringJobDefinitionName' => '',
'MonitoringType' => 'DataQuality|ModelQuality|ModelBias|ModelExplainability',
'ScheduleConfig' => [
'DataAnalysisEndTime' => '',
'DataAnalysisStartTime' => '',
'ScheduleExpression' => '', // REQUIRED
],
],
'MonitoringScheduleName' => '', // REQUIRED
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- MonitoringScheduleConfig
-
- Required: Yes
- Type: MonitoringScheduleConfig structure
The configuration object that specifies the monitoring schedule and defines the monitoring job.
- MonitoringScheduleName
-
- Required: Yes
- Type: string
The name of the monitoring schedule. The name must be unique within an Amazon Web Services Region within an Amazon Web Services account.
- Tags
-
- Type: Array of Tag structures
(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
Result Syntax
[
'MonitoringScheduleArn' => '',
]
Result Details
Members
- MonitoringScheduleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the monitoring schedule.
Errors
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateNotebookInstance
$result = $client->createNotebookInstance([/* ... */]); $promise = $client->createNotebookInstanceAsync([/* ... */]);
Creates an SageMaker AI notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook.
In a CreateNotebookInstance request, specify the type of ML compute instance that you want to run. SageMaker AI launches the instance, installs common libraries that you can use to explore datasets for model training, and attaches an ML storage volume to the notebook instance.
SageMaker AI also provides a set of example notebooks. Each notebook demonstrates how to use SageMaker AI with a specific algorithm or with a machine learning framework.
After receiving the request, SageMaker AI does the following:
-
Creates a network interface in the SageMaker AI VPC.
-
(Option) If you specified
SubnetId, SageMaker AI creates a network interface in your own VPC, which is inferred from the subnet ID that you provide in the input. When creating this network interface, SageMaker AI attaches the security group that you specified in the request to the network interface that it creates in your VPC. -
Launches an EC2 instance of the type specified in the request in the SageMaker AI VPC. If you specified
SubnetIdof your VPC, SageMaker AI specifies both network interfaces when launching this instance. This enables inbound traffic from your own VPC to the notebook instance, assuming that the security groups allow it.
After creating the notebook instance, SageMaker AI returns its Amazon Resource Name (ARN). You can't change the name of a notebook instance after you create it.
After SageMaker AI creates the notebook instance, you can connect to the Jupyter server and work in Jupyter notebooks. For example, you can write code to explore a dataset that you can use for model training, train a model, host models by creating SageMaker AI endpoints, and validate hosted models.
For more information, see How It Works.
Parameter Syntax
$result = $client->createNotebookInstance([
'AcceleratorTypes' => ['', ...],
'AdditionalCodeRepositories' => ['', ...],
'DefaultCodeRepository' => '',
'DirectInternetAccess' => 'Enabled|Disabled',
'InstanceMetadataServiceConfiguration' => [
'MinimumInstanceMetadataServiceVersion' => '', // REQUIRED
],
'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.p5.4xlarge|ml.p5en.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge', // REQUIRED
'IpAddressType' => 'ipv4|dualstack',
'KmsKeyId' => '',
'LifecycleConfigName' => '',
'NotebookInstanceName' => '', // REQUIRED
'PlatformIdentifier' => '',
'RoleArn' => '', // REQUIRED
'RootAccess' => 'Enabled|Disabled',
'SecurityGroupIds' => ['', ...],
'SubnetId' => '',
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
'VolumeSizeInGB' => ,
]);
Parameter Details
Members
- AcceleratorTypes
-
- Type: Array of strings
This parameter is no longer supported. Elastic Inference (EI) is no longer available.
This parameter was used to specify a list of EI instance types to associate with this notebook instance.
- AdditionalCodeRepositories
-
- Type: Array of strings
An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.
- DefaultCodeRepository
-
- Type: string
A Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.
- DirectInternetAccess
-
- Type: string
Sets whether SageMaker AI provides internet access to the notebook instance. If you set this to
Disabledthis notebook instance is able to access resources only in your VPC, and is not be able to connect to SageMaker AI training and endpoint services unless you configure a NAT Gateway in your VPC.For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value of this parameter to
Disabledonly if you set a value for theSubnetIdparameter. - InstanceMetadataServiceConfiguration
-
- Type: InstanceMetadataServiceConfiguration structure
Information on the IMDS configuration of the notebook instance
- InstanceType
-
- Required: Yes
- Type: string
The type of ML compute instance to launch for the notebook instance.
- IpAddressType
-
- Type: string
The IP address type for the notebook instance. Specify
ipv4for IPv4-only connectivity ordualstackfor both IPv4 and IPv6 connectivity. When you specifydualstack, the subnet must support IPv6 CIDR blocks. If not specified, defaults toipv4. - KmsKeyId
-
- Type: string
The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker AI uses to encrypt data on the storage volume attached to your notebook instance. The KMS key you provide must be enabled. For information, see Enabling and Disabling Keys in the Amazon Web Services Key Management Service Developer Guide.
- LifecycleConfigName
-
- Type: string
The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.
- NotebookInstanceName
-
- Required: Yes
- Type: string
The name of the new notebook instance.
- PlatformIdentifier
-
- Type: string
The platform identifier of the notebook instance runtime environment. The default value is
notebook-al2023-v1. - RoleArn
-
- Required: Yes
- Type: string
When you send any requests to Amazon Web Services resources from the notebook instance, SageMaker AI assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker AI can perform these tasks. The policy must allow the SageMaker AI service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see SageMaker AI Roles.
To be able to pass this role to SageMaker AI, the caller of this API must have the
iam:PassRolepermission. - RootAccess
-
- Type: string
Whether root access is enabled or disabled for users of the notebook instance. The default value is
Enabled.Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.
- SecurityGroupIds
-
- Type: Array of strings
The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
- SubnetId
-
- Type: string
The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
- Tags
-
- 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.
- VolumeSizeInGB
-
- Type: int
The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.
Result Syntax
[
'NotebookInstanceArn' => '',
]
Result Details
Members
- NotebookInstanceArn
-
- Type: string
The Amazon Resource Name (ARN) of the notebook instance.
Errors
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateNotebookInstanceLifecycleConfig
$result = $client->createNotebookInstanceLifecycleConfig([/* ... */]); $promise = $client->createNotebookInstanceLifecycleConfigAsync([/* ... */]);
Creates a lifecycle configuration that you can associate with a notebook instance. A lifecycle configuration is a collection of shell scripts that run when you create or start a notebook instance.
Each lifecycle configuration script has a limit of 16384 characters.
The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin.
View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].
Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.
For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.
Lifecycle configuration scripts execute with root access and the notebook instance's IAM execution role privileges. Grant this permission only to trusted principals. See Customize a Notebook Instance Using a Lifecycle Configuration Script for security best practices.
Parameter Syntax
$result = $client->createNotebookInstanceLifecycleConfig([
'NotebookInstanceLifecycleConfigName' => '', // REQUIRED
'OnCreate' => [
[
'Content' => '',
],
// ...
],
'OnStart' => [
[
'Content' => '',
],
// ...
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- NotebookInstanceLifecycleConfigName
-
- Required: Yes
- Type: string
The name of the lifecycle configuration.
- OnCreate
-
- Type: Array of NotebookInstanceLifecycleHook structures
A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.
- OnStart
-
- Type: Array of NotebookInstanceLifecycleHook structures
A shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.
- Tags
-
- 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
[
'NotebookInstanceLifecycleConfigArn' => '',
]
Result Details
Members
- NotebookInstanceLifecycleConfigArn
-
- Type: string
The Amazon Resource Name (ARN) of the lifecycle configuration.
Errors
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateOptimizationJob
$result = $client->createOptimizationJob([/* ... */]); $promise = $client->createOptimizationJobAsync([/* ... */]);
Creates a job that optimizes a model for inference performance. To create the job, you provide the location of a source model, and you provide the settings for the optimization techniques that you want the job to apply. When the job completes successfully, SageMaker uploads the new optimized model to the output destination that you specify.
For more information about how to use this action, and about the supported optimization techniques, see Optimize model inference with Amazon SageMaker.
Parameter Syntax
$result = $client->createOptimizationJob([
'DeploymentInstanceType' => 'ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p6-b200.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge', // REQUIRED
'MaxInstanceCount' => ,
'ModelSource' => [ // REQUIRED
'S3' => [
'ModelAccessConfig' => [
'AcceptEula' => true || false, // REQUIRED
],
'S3Uri' => '',
],
'SageMakerModel' => [
'ModelName' => '',
],
],
'OptimizationConfigs' => [ // REQUIRED
[
'ModelCompilationConfig' => [
'Image' => '',
'OverrideEnvironment' => ['', ...],
],
'ModelQuantizationConfig' => [
'Image' => '',
'OverrideEnvironment' => ['', ...],
],
'ModelShardingConfig' => [
'Image' => '',
'OverrideEnvironment' => ['', ...],
],
'ModelSpeculativeDecodingConfig' => [
'Technique' => 'EAGLE', // REQUIRED
'TrainingDataSource' => [
'S3DataType' => 'S3Prefix|ManifestFile', // REQUIRED
'S3Uri' => '', // REQUIRED
],
],
],
// ...
],
'OptimizationEnvironment' => ['', ...],
'OptimizationJobName' => '', // REQUIRED
'OutputConfig' => [ // REQUIRED
'KmsKeyId' => '',
'S3OutputLocation' => '', // REQUIRED
'SageMakerModel' => [
'ModelName' => '',
],
],
'RoleArn' => '', // REQUIRED
'StoppingCondition' => [ // REQUIRED
'MaxPendingTimeInSeconds' => ,
'MaxRuntimeInSeconds' => ,
'MaxWaitTimeInSeconds' => ,
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
'TrainingPlanArns' => ['', ...],
'VpcConfig' => [
'SecurityGroupIds' => ['', ...], // REQUIRED
'Subnets' => ['', ...], // REQUIRED
],
]);
Parameter Details
Members
- DeploymentInstanceType
-
- Required: Yes
- Type: string
The type of instance that hosts the optimized model that you create with the optimization job.
- MaxInstanceCount
-
- Type: int
The maximum number of instances to use for the optimization job.
- ModelSource
-
- Required: Yes
- Type: OptimizationJobModelSource structure
The location of the source model to optimize with an optimization job.
- OptimizationConfigs
-
- Required: Yes
- Type: Array of OptimizationConfig structures
Settings for each of the optimization techniques that the job applies.
- OptimizationEnvironment
-
- Type: Associative array of custom strings keys (NonEmptyString256) to strings
The environment variables to set in the model container.
- OptimizationJobName
-
- Required: Yes
- Type: string
A custom name for the new optimization job.
- OutputConfig
-
- Required: Yes
- Type: OptimizationJobOutputConfig structure
Details for where to store the optimized model that you create with the optimization job.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.
During model optimization, Amazon SageMaker AI needs your permission to:
-
Read input data from an S3 bucket
-
Write model artifacts to an S3 bucket
-
Write logs to Amazon CloudWatch Logs
-
Publish metrics to Amazon CloudWatch
You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker AI, the caller of this API must have the
iam:PassRolepermission. For more information, see Amazon SageMaker AI Roles. - StoppingCondition
-
- Required: Yes
- Type: StoppingCondition structure
Specifies a limit to how long a job can run. When the job reaches the time limit, SageMaker ends the job. Use this API to cap costs.
To stop a training job, SageMaker sends the algorithm the
SIGTERMsignal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.The training algorithms provided by SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with
CreateModel.The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.
- Tags
-
- Type: Array of Tag structures
A list of key-value pairs associated with the optimization job. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
- TrainingPlanArns
-
- Type: Array of strings
The Amazon Resource Name (ARN) of the training plan to use for this optimization job.
When you use reserved capacity from a training plan, the optimization job runs on that reserved capacity instead of on-demand capacity. If you omit this field, the job uses on-demand capacity. You can specify at most one training plan.
For more information about how to reserve GPU capacity for your optimization jobs using Amazon SageMaker Training Plans, see Reserve capacity with training plans.
- VpcConfig
-
- Type: OptimizationVpcConfig structure
A VPC in Amazon VPC that your optimized model has access to.
Result Syntax
[
'OptimizationJobArn' => '',
]
Result Details
Members
- OptimizationJobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the optimization job.
Errors
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreatePartnerApp
$result = $client->createPartnerApp([/* ... */]); $promise = $client->createPartnerAppAsync([/* ... */]);
Creates an Amazon SageMaker Partner AI App.
Parameter Syntax
$result = $client->createPartnerApp([
'ApplicationConfig' => [
'AdminUsers' => ['', ...],
'Arguments' => ['', ...],
'AssignedGroupPatterns' => ['', ...],
'RoleGroupAssignments' => [
[
'GroupPatterns' => ['', ...], // REQUIRED
'RoleName' => '', // REQUIRED
],
// ...
],
],
'AuthType' => 'IAM|IDC', // REQUIRED
'ClientToken' => '',
'EnableAutoMinorVersionUpgrade' => true || false,
'EnableIamSessionBasedIdentity' => true || false,
'ExecutionRoleArn' => '', // REQUIRED
'IdcConfig' => [
'InstanceArn' => '', // REQUIRED
],
'KmsKeyId' => '',
'MaintenanceConfig' => [
'MaintenanceWindowStart' => '',
],
'Name' => '', // REQUIRED
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
'Tier' => '', // REQUIRED
'Type' => 'lakera-guard|comet|deepchecks-llm-evaluation|fiddler', // REQUIRED
]);
Parameter Details
Members
- ApplicationConfig
-
- Type: PartnerAppConfig structure
Configuration settings for the SageMaker Partner AI App.
- AuthType
-
- Required: Yes
- Type: string
The authorization type that users use to access the SageMaker Partner AI App. Valid values:
-
IAM: Users access the SageMaker Partner AI App with their Amazon Web Services IAM identity. -
IDC: Users access the SageMaker Partner AI App with their Amazon Web Services IAM Identity Center identity. Specify the Identity Center instance to use inIdcConfig.
- ClientToken
-
- Type: string
A unique token that guarantees that the call to this API is idempotent.
- EnableAutoMinorVersionUpgrade
-
- Type: boolean
When set to
TRUE, the SageMaker Partner AI App is automatically upgraded to the latest minor version during the next scheduled maintenance window, if one is available. Default isFALSE. - EnableIamSessionBasedIdentity
-
- Type: boolean
When set to
TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user. - ExecutionRoleArn
-
- Required: Yes
- Type: string
The ARN of the IAM role that the partner application uses.
- IdcConfig
-
- Type: IdcConfigInput structure
Specifies the Amazon Web Services IAM Identity Center configuration for the SageMaker Partner AI App. Specify this parameter when
AuthTypeisIDC. Apps that useIAMauthorization don't use this parameter. - KmsKeyId
-
- Type: string
SageMaker Partner AI Apps uses Amazon Web Services KMS to encrypt data at rest using an Amazon Web Services managed key by default. For more control, specify a customer managed key.
- MaintenanceConfig
-
- Type: PartnerAppMaintenanceConfig structure
Maintenance configuration settings for the SageMaker Partner AI App.
- Name
-
- Required: Yes
- Type: string
The name to give the SageMaker Partner AI App.
- Tags
-
- Type: Array of Tag structures
Each tag consists of a key and an optional value. Tag keys must be unique per resource.
- Tier
-
- Required: Yes
- Type: string
Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App.
- Type
-
- Required: Yes
- Type: string
The type of SageMaker Partner AI App to create. Must be one of the following:
lakera-guard,comet,deepchecks-llm-evaluation, orfiddler.
Result Syntax
[
'Arn' => '',
]
Result Details
Members
- Arn
-
- Type: string
The ARN of the SageMaker Partner AI App.
Errors
- ConflictException:
There was a conflict when you attempted to modify a SageMaker entity such as an
ExperimentorArtifact.- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreatePartnerAppPresignedUrl
$result = $client->createPartnerAppPresignedUrl([/* ... */]); $promise = $client->createPartnerAppPresignedUrlAsync([/* ... */]);
Creates a presigned URL to access an Amazon SageMaker Partner AI App.
Parameter Syntax
$result = $client->createPartnerAppPresignedUrl([
'Arn' => '', // REQUIRED
'ExpiresInSeconds' => ,
'SessionExpirationDurationInSeconds' => ,
]);
Parameter Details
Members
- Arn
-
- Required: Yes
- Type: string
The ARN of the SageMaker Partner AI App to create the presigned URL for.
- ExpiresInSeconds
-
- Type: int
The time that will pass before the presigned URL expires.
- SessionExpirationDurationInSeconds
-
- Type: int
Indicates how long the Amazon SageMaker Partner AI App session can be accessed for after logging in.
Result Syntax
[
'Url' => '',
]
Result Details
Members
- Url
-
- Type: string
The presigned URL that you can use to access the SageMaker Partner AI App.
Errors
- ResourceNotFound:
Resource being access is not found.
CreatePipeline
$result = $client->createPipeline([/* ... */]); $promise = $client->createPipelineAsync([/* ... */]);
Creates a pipeline using a JSON pipeline definition.
Parameter Syntax
$result = $client->createPipeline([
'ClientRequestToken' => '', // REQUIRED
'ParallelismConfiguration' => [
'MaxParallelExecutionSteps' => , // REQUIRED
],
'PipelineDefinition' => '',
'PipelineDefinitionS3Location' => [
'Bucket' => '', // REQUIRED
'ObjectKey' => '', // REQUIRED
'VersionId' => '',
],
'PipelineDescription' => '',
'PipelineDisplayName' => '',
'PipelineName' => '', // REQUIRED
'RoleArn' => '', // REQUIRED
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ClientRequestToken
-
- Required: Yes
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.
- ParallelismConfiguration
-
- Type: ParallelismConfiguration structure
This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default.
- PipelineDefinition
-
- Type: string
The JSON pipeline definition of the pipeline.
- PipelineDefinitionS3Location
-
- Type: PipelineDefinitionS3Location structure
The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.
- PipelineDescription
-
- Type: string
A description of the pipeline.
- PipelineDisplayName
-
- Type: string
The display name of the pipeline.
- PipelineName
-
- Required: Yes
- Type: string
The name of the pipeline.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.
- Tags
-
- Type: Array of Tag structures
A list of tags to apply to the created pipeline.
Result Syntax
[
'PipelineArn' => '',
]
Result Details
Members
- PipelineArn
-
- Type: string
The Amazon Resource Name (ARN) of the created pipeline.
Errors
- ConflictException:
There was a conflict when you attempted to modify a SageMaker entity such as an
ExperimentorArtifact.- 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.
CreatePresignedDomainUrl
$result = $client->createPresignedDomainUrl([/* ... */]); $promise = $client->createPresignedDomainUrlAsync([/* ... */]);
Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the user will be automatically signed in to the domain, and granted access to all of the Apps and files associated with the Domain's Amazon Elastic File System volume. This operation can only be called when the authentication mode equals IAM.
The IAM role or user passed to this API defines the permissions to access the app. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the app.
You can restrict access to this API and to the URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more information, see Connect to Amazon SageMaker AI Studio Through an Interface VPC Endpoint .
-
The URL that you get from a call to
CreatePresignedDomainUrlhas a default timeout of 5 minutes. You can configure this value usingExpiresInSeconds. If you try to use the URL after the timeout limit expires, you are directed to the Amazon Web Services console sign-in page. -
The JupyterLab session default expiration time is 12 hours. You can configure this value using SessionExpirationDurationInSeconds.
Parameter Syntax
$result = $client->createPresignedDomainUrl([
'DomainId' => '', // REQUIRED
'ExpiresInSeconds' => ,
'LandingUri' => '',
'SessionExpirationDurationInSeconds' => ,
'SpaceName' => '',
'UserProfileName' => '', // REQUIRED
]);
Parameter Details
Members
- DomainId
-
- Required: Yes
- Type: string
The domain ID.
- ExpiresInSeconds
-
- Type: int
The number of seconds until the pre-signed URL expires. This value defaults to 300.
- LandingUri
-
- Type: string
The landing page that the user is directed to when accessing the presigned URL. Using this value, users can access Studio or Studio Classic, even if it is not the default experience for the domain. The supported values are:
-
studio::relative/path: Directs users to the relative path in Studio. -
app:JupyterServer:relative/path: Directs users to the relative path in the Studio Classic application. -
app:JupyterLab:relative/path: Directs users to the relative path in the JupyterLab application. -
app:RStudioServerPro:relative/path: Directs users to the relative path in the RStudio application. -
app:CodeEditor:relative/path: Directs users to the relative path in the Code Editor, based on Code-OSS, Visual Studio Code - Open Source application. -
app:Canvas:relative/path: Directs users to the relative path in the Canvas application.
- SessionExpirationDurationInSeconds
-
- Type: int
The session expiration duration in seconds. This value defaults to 43200.
- SpaceName
-
- Type: string
The name of the space.
- UserProfileName
-
- Required: Yes
- Type: string
The name of the UserProfile to sign-in as.
Result Syntax
[
'AuthorizedUrl' => '',
]
Result Details
Members
- AuthorizedUrl
-
- Type: string
The presigned URL.
Errors
- ResourceNotFound:
Resource being access is not found.
CreatePresignedMlflowAppUrl
$result = $client->createPresignedMlflowAppUrl([/* ... */]); $promise = $client->createPresignedMlflowAppUrlAsync([/* ... */]);
Returns a presigned URL that you can use to connect to the MLflow UI attached to your MLflow App. For more information, see Launch the MLflow UI using a presigned URL.
Parameter Syntax
$result = $client->createPresignedMlflowAppUrl([
'Arn' => '', // REQUIRED
'ExpiresInSeconds' => ,
'SessionExpirationDurationInSeconds' => ,
]);
Parameter Details
Members
- Arn
-
- Required: Yes
- Type: string
The ARN of the MLflow App to connect to your MLflow UI.
- ExpiresInSeconds
-
- Type: int
The duration in seconds that your presigned URL is valid. The presigned URL can be used only once.
- SessionExpirationDurationInSeconds
-
- Type: int
The duration in seconds that your presigned URL is valid. The presigned URL can be used only once.
Result Syntax
[
'AuthorizedUrl' => '',
]
Result Details
Members
- AuthorizedUrl
-
- Type: string
A presigned URL with an authorization token.
Errors
- ResourceNotFound:
Resource being access is not found.
CreatePresignedMlflowTrackingServerUrl
$result = $client->createPresignedMlflowTrackingServerUrl([/* ... */]); $promise = $client->createPresignedMlflowTrackingServerUrlAsync([/* ... */]);
Returns a presigned URL that you can use to connect to the MLflow UI attached to your tracking server. For more information, see Launch the MLflow UI using a presigned URL.
Parameter Syntax
$result = $client->createPresignedMlflowTrackingServerUrl([
'ExpiresInSeconds' => ,
'SessionExpirationDurationInSeconds' => ,
'TrackingServerName' => '', // REQUIRED
]);
Parameter Details
Members
- ExpiresInSeconds
-
- Type: int
The duration in seconds that your presigned URL is valid. The presigned URL can be used only once.
- SessionExpirationDurationInSeconds
-
- Type: int
The duration in seconds that your MLflow UI session is valid.
- TrackingServerName
-
- Required: Yes
- Type: string
The name of the tracking server to connect to your MLflow UI.
Result Syntax
[
'AuthorizedUrl' => '',
]
Result Details
Members
- AuthorizedUrl
-
- Type: string
A presigned URL with an authorization token.
Errors
- ResourceNotFound:
Resource being access is not found.
CreatePresignedNotebookInstanceUrl
$result = $client->createPresignedNotebookInstanceUrl([/* ... */]); $promise = $client->createPresignedNotebookInstanceUrlAsync([/* ... */]);
Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the SageMaker AI console, when you choose Open next to a notebook instance, SageMaker AI opens a new tab showing the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the page.
The IAM role or user used to call this API defines the permissions to access the notebook instance. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance.
You can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.
The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the Amazon Web Services console sign-in page.
Parameter Syntax
$result = $client->createPresignedNotebookInstanceUrl([
'NotebookInstanceName' => '', // REQUIRED
'SessionExpirationDurationInSeconds' => ,
]);
Parameter Details
Members
- NotebookInstanceName
-
- Required: Yes
- Type: string
The name of the notebook instance.
- SessionExpirationDurationInSeconds
-
- Type: int
The duration of the session, in seconds. The default is 12 hours.
Result Syntax
[
'AuthorizedUrl' => '',
]
Result Details
Members
- AuthorizedUrl
-
- Type: string
A JSON object that contains the URL string.
Errors
There are no errors described for this operation.
CreateProcessingJob
$result = $client->createProcessingJob([/* ... */]); $promise = $client->createProcessingJobAsync([/* ... */]);
Creates a processing job.
Parameter Syntax
$result = $client->createProcessingJob([
'AppSpecification' => [ // REQUIRED
'ContainerArguments' => ['', ...],
'ContainerEntrypoint' => ['', ...],
'ImageUri' => '', // REQUIRED
],
'Environment' => ['', ...],
'ExperimentConfig' => [
'ExperimentName' => '',
'RunName' => '',
'TrialComponentDisplayName' => '',
'TrialName' => '',
],
'NetworkConfig' => [
'EnableInterContainerTrafficEncryption' => true || false,
'EnableNetworkIsolation' => true || false,
'VpcConfig' => [
'SecurityGroupIds' => ['', ...], // REQUIRED
'Subnets' => ['', ...], // REQUIRED
],
],
'ProcessingInputs' => [
[
'AppManaged' => true || false,
'DatasetDefinition' => [
'AthenaDatasetDefinition' => [
'Catalog' => '', // REQUIRED
'Database' => '', // REQUIRED
'KmsKeyId' => '',
'OutputCompression' => 'GZIP|SNAPPY|ZLIB',
'OutputFormat' => 'PARQUET|ORC|AVRO|JSON|TEXTFILE', // REQUIRED
'OutputS3Uri' => '', // REQUIRED
'QueryString' => '', // REQUIRED
'WorkGroup' => '',
],
'DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'InputMode' => 'Pipe|File',
'LocalPath' => '',
'RedshiftDatasetDefinition' => [
'ClusterId' => '', // REQUIRED
'ClusterRoleArn' => '', // REQUIRED
'Database' => '', // REQUIRED
'DbUser' => '', // REQUIRED
'KmsKeyId' => '',
'OutputCompression' => 'None|GZIP|BZIP2|ZSTD|SNAPPY',
'OutputFormat' => 'PARQUET|CSV', // REQUIRED
'OutputS3Uri' => '', // REQUIRED
'QueryString' => '', // REQUIRED
],
],
'InputName' => '', // REQUIRED
'S3Input' => [
'LocalPath' => '',
'S3CompressionType' => 'None|Gzip',
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3DataType' => 'ManifestFile|S3Prefix', // REQUIRED
'S3InputMode' => 'Pipe|File',
'S3Uri' => '', // REQUIRED
],
],
// ...
],
'ProcessingJobName' => '', // REQUIRED
'ProcessingOutputConfig' => [
'KmsKeyId' => '',
'Outputs' => [ // REQUIRED
[
'AppManaged' => true || false,
'FeatureStoreOutput' => [
'FeatureGroupName' => '', // REQUIRED
],
'OutputName' => '', // REQUIRED
'S3Output' => [
'LocalPath' => '',
'S3UploadMode' => 'Continuous|EndOfJob', // REQUIRED
'S3Uri' => '', // REQUIRED
],
],
// ...
],
],
'ProcessingResources' => [ // REQUIRED
'ClusterConfig' => [ // REQUIRED
'InstanceCount' => ,
'InstancePreferences' => [
[
'InstanceCount' => ,
'InstanceType' => 'ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p5.4xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge', // REQUIRED
],
// ...
],
'InstanceType' => 'ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p5.4xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'SelectedInstanceCount' => ,
'SelectedInstanceType' => 'ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p5.4xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'VolumeKmsKeyId' => '',
'VolumeSizeInGB' => , // REQUIRED
],
],
'RoleArn' => '', // REQUIRED
'StoppingCondition' => [
'MaxRuntimeInSeconds' => , // REQUIRED
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- AppSpecification
-
- Required: Yes
- Type: AppSpecification structure
Configures the processing job to run a specified Docker container image.
- Environment
-
- Type: Associative array of custom strings keys (ProcessingEnvironmentKey) to strings
The environment variables to set in the Docker container. Up to 100 key and values entries in the map are supported.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields.
- ExperimentConfig
-
- Type: ExperimentConfig structure
Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:
- NetworkConfig
-
- Type: NetworkConfig structure
Networking options for a processing job, such as whether to allow inbound and outbound network calls to and from processing containers, and the VPC subnets and security groups to use for VPC-enabled processing jobs.
- ProcessingInputs
-
- Type: Array of ProcessingInput structures
An array of inputs configuring the data to download into the processing container.
- ProcessingJobName
-
- Required: Yes
- Type: string
The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
- ProcessingOutputConfig
-
- Type: ProcessingOutputConfig structure
Output configuration for the processing job.
- ProcessingResources
-
- Required: Yes
- Type: ProcessingResources structure
Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
- StoppingCondition
-
- Type: ProcessingStoppingCondition structure
The time limit for how long the processing job is allowed to run.
- Tags
-
- Type: Array of Tag structures
(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any tags. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request tag variable or plain text fields.
Result Syntax
[
'ProcessingJobArn' => '',
]
Result Details
Members
- ProcessingJobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the processing job.
Errors
- ResourceNotFound:
Resource being access is not found.
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateProject
$result = $client->createProject([/* ... */]); $promise = $client->createProjectAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->createProject([
'ProjectDescription' => '',
'ProjectName' => '', // REQUIRED
'ServiceCatalogProvisioningDetails' => [
'PathId' => '',
'ProductId' => '', // REQUIRED
'ProvisioningArtifactId' => '',
'ProvisioningParameters' => [
[
'Key' => '',
'Value' => '',
],
// ...
],
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
'TemplateProviders' => [
[
'CfnTemplateProvider' => [
'Parameters' => [
[
'Key' => '', // REQUIRED
'Value' => '',
],
// ...
],
'RoleARN' => '',
'TemplateName' => '', // REQUIRED
'TemplateURL' => '', // REQUIRED
],
],
// ...
],
]);
Parameter Details
Members
- ProjectDescription
-
- Type: string
A description for the project.
- ProjectName
-
- Required: Yes
- Type: string
The name of the project.
- ServiceCatalogProvisioningDetails
-
- Type: ServiceCatalogProvisioningDetails structure
The product ID and provisioning artifact ID to provision a service catalog. The provisioning artifact ID will default to the latest provisioning artifact ID of the product, if you don't provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service Catalog.
- Tags
-
- Type: Array of Tag structures
An array of key-value pairs that you want to use to organize and track your Amazon Web Services resource costs. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
- TemplateProviders
-
- Type: Array of CreateTemplateProvider structures
An array of template provider configurations for creating infrastructure resources for the project.
Result Syntax
[
'ProjectArn' => '',
'ProjectId' => '',
]
Result Details
Members
- ProjectArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the project.
- ProjectId
-
- Required: Yes
- Type: string
The ID of the new project.
Errors
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateSpace
$result = $client->createSpace([/* ... */]); $promise = $client->createSpaceAsync([/* ... */]);
Creates a private space or a space used for real time collaboration in a domain.
Parameter Syntax
$result = $client->createSpace([
'DomainId' => '', // REQUIRED
'OwnershipSettings' => [
'OwnerUserProfileName' => '', // REQUIRED
],
'SpaceDisplayName' => '',
'SpaceName' => '', // REQUIRED
'SpaceSettings' => [
'AppType' => 'JupyterServer|KernelGateway|DetailedProfiler|TensorBoard|CodeEditor|JupyterLab|RStudioServerPro|RSessionGateway|Canvas',
'CodeEditorAppSettings' => [
'AppLifecycleManagement' => [
'IdleSettings' => [
'IdleTimeoutInMinutes' => ,
],
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
],
'CustomFileSystems' => [
[
'EFSFileSystem' => [
'FileSystemId' => '', // REQUIRED
],
'FSxLustreFileSystem' => [
'FileSystemId' => '', // REQUIRED
],
'S3FileSystem' => [
'S3Uri' => '', // REQUIRED
],
],
// ...
],
'JupyterLabAppSettings' => [
'AppLifecycleManagement' => [
'IdleSettings' => [
'IdleTimeoutInMinutes' => ,
],
],
'CodeRepositories' => [
[
'RepositoryUrl' => '', // REQUIRED
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
],
'JupyterServerAppSettings' => [
'CodeRepositories' => [
[
'RepositoryUrl' => '', // REQUIRED
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
'LifecycleConfigArns' => ['', ...],
],
'KernelGatewayAppSettings' => [
'CustomImages' => [
[
'AppImageConfigName' => '', // REQUIRED
'ImageName' => '', // REQUIRED
'ImageVersionNumber' => ,
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
'LifecycleConfigArns' => ['', ...],
],
'RemoteAccess' => 'ENABLED|DISABLED',
'SpaceManagedResources' => 'ENABLED|DISABLED',
'SpaceStorageSettings' => [
'EbsStorageSettings' => [
'EbsVolumeSizeInGb' => , // REQUIRED
],
],
],
'SpaceSharingSettings' => [
'SharingType' => 'Private|Shared', // REQUIRED
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- DomainId
-
- Required: Yes
- Type: string
The ID of the associated domain.
- OwnershipSettings
-
- Type: OwnershipSettings structure
A collection of ownership settings.
- SpaceDisplayName
-
- Type: string
The name of the space that appears in the SageMaker Studio UI.
- SpaceName
-
- Required: Yes
- Type: string
The name of the space.
- SpaceSettings
-
- Type: SpaceSettings structure
A collection of space settings.
- SpaceSharingSettings
-
- Type: SpaceSharingSettings structure
A collection of space sharing settings.
- Tags
-
- Type: Array of Tag structures
Tags to associated with the space. Each tag consists of a key and an optional value. Tag keys must be unique for each resource. Tags are searchable using the
SearchAPI.
Result Syntax
[
'SpaceArn' => '',
]
Result Details
Members
- SpaceArn
-
- Type: string
The space's Amazon Resource Name (ARN).
Errors
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateStudioLifecycleConfig
$result = $client->createStudioLifecycleConfig([/* ... */]); $promise = $client->createStudioLifecycleConfigAsync([/* ... */]);
Creates a new Amazon SageMaker AI Studio Lifecycle Configuration.
Parameter Syntax
$result = $client->createStudioLifecycleConfig([
'StudioLifecycleConfigAppType' => 'JupyterServer|KernelGateway|CodeEditor|JupyterLab', // REQUIRED
'StudioLifecycleConfigContent' => '', // REQUIRED
'StudioLifecycleConfigName' => '', // REQUIRED
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- StudioLifecycleConfigAppType
-
- Required: Yes
- Type: string
The App type that the Lifecycle Configuration is attached to.
- StudioLifecycleConfigContent
-
- Required: Yes
- Type: string
The content of your Amazon SageMaker AI Studio Lifecycle Configuration script. This content must be base64 encoded.
- StudioLifecycleConfigName
-
- Required: Yes
- Type: string
The name of the Amazon SageMaker AI Studio Lifecycle Configuration to create.
- Tags
-
- Type: Array of Tag structures
Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.
Result Syntax
[
'StudioLifecycleConfigArn' => '',
]
Result Details
Members
- StudioLifecycleConfigArn
-
- Type: string
The ARN of your created Lifecycle Configuration.
Errors
- ResourceInUse:
Resource being accessed is in use.
CreateTrainingJob
$result = $client->createTrainingJob([/* ... */]); $promise = $client->createTrainingJobAsync([/* ... */]);
Starts a model training job. After training completes, SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify.
If you choose to host your model using SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than SageMaker, provided that you know how to use them for inference.
In the request body, you provide the following:
-
AlgorithmSpecification- Identifies the training algorithm to use. -
HyperParameters- Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms.Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request hyperparameter variable or plain text fields.
-
InputDataConfig- Describes the input required by the training job and the Amazon S3, EFS, or FSx location where it is stored. -
OutputDataConfig- Identifies the Amazon S3 bucket where you want SageMaker to save the results of model training. -
ResourceConfig- Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance. -
EnableManagedSpotTraining- Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training. -
RoleArn- The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that SageMaker can successfully complete model training. -
StoppingCondition- To help cap training costs, useMaxRuntimeInSecondsto set a time limit for training. UseMaxWaitTimeInSecondsto specify how long a managed spot training job has to complete. -
Environment- The environment variables to set in the Docker container.Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields.
-
RetryStrategy- The number of times to retry the job when the job fails due to anInternalServerError.
For more information about SageMaker, see How It Works.
Parameter Syntax
$result = $client->createTrainingJob([
'AlgorithmSpecification' => [
'AlgorithmName' => '',
'ContainerArguments' => ['', ...],
'ContainerEntrypoint' => ['', ...],
'EnableSageMakerMetricsTimeSeries' => true || false,
'MetricDefinitions' => [
[
'Name' => '', // REQUIRED
'Regex' => '', // REQUIRED
],
// ...
],
'TrainingImage' => '',
'TrainingImageConfig' => [
'TrainingRepositoryAccessMode' => 'Platform|Vpc', // REQUIRED
'TrainingRepositoryAuthConfig' => [
'TrainingRepositoryCredentialsProviderArn' => '', // REQUIRED
],
],
'TrainingInputMode' => 'Pipe|File|FastFile', // REQUIRED
],
'CheckpointConfig' => [
'LocalPath' => '',
'S3Uri' => '', // REQUIRED
],
'DebugHookConfig' => [
'CollectionConfigurations' => [
[
'CollectionName' => '',
'CollectionParameters' => ['', ...],
],
// ...
],
'HookParameters' => ['', ...],
'LocalPath' => '',
'S3OutputPath' => '', // REQUIRED
],
'DebugRuleConfigurations' => [
[
'InstanceType' => 'ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p5.4xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'LocalPath' => '',
'RuleConfigurationName' => '', // REQUIRED
'RuleEvaluatorImage' => '', // REQUIRED
'RuleParameters' => ['', ...],
'S3OutputPath' => '',
'VolumeSizeInGB' => ,
],
// ...
],
'EnableInterContainerTrafficEncryption' => true || false,
'EnableManagedSpotTraining' => true || false,
'EnableNetworkIsolation' => true || false,
'Environment' => ['', ...],
'ExperimentConfig' => [
'ExperimentName' => '',
'RunName' => '',
'TrialComponentDisplayName' => '',
'TrialName' => '',
],
'HyperParameters' => ['', ...],
'InfraCheckConfig' => [
'EnableInfraCheck' => true || false,
],
'InputDataConfig' => [
[
'ChannelName' => '', // REQUIRED
'CompressionType' => 'None|Gzip',
'ContentType' => '',
'DataSource' => [ // REQUIRED
'DatasetSource' => [
'DatasetArn' => '', // REQUIRED
],
'FileSystemDataSource' => [
'DirectoryPath' => '', // REQUIRED
'FileSystemAccessMode' => 'rw|ro', // REQUIRED
'FileSystemId' => '', // REQUIRED
'FileSystemType' => 'EFS|FSxLustre', // REQUIRED
],
'S3DataSource' => [
'AttributeNames' => ['', ...],
'HubAccessConfig' => [
'HubContentArn' => '', // REQUIRED
],
'InstanceGroupNames' => ['', ...],
'ModelAccessConfig' => [
'AcceptEula' => true || false, // REQUIRED
],
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile|Converse', // REQUIRED
'S3Uri' => '', // REQUIRED
],
],
'InputMode' => 'Pipe|File|FastFile',
'RecordWrapperType' => 'None|RecordIO',
'ShuffleConfig' => [
'Seed' => , // REQUIRED
],
],
// ...
],
'MlflowConfig' => [
'MlflowExperimentName' => '',
'MlflowResourceArn' => '', // REQUIRED
'MlflowRunName' => '',
],
'ModelPackageConfig' => [
'ModelPackageGroupArn' => '', // REQUIRED
'SourceModelPackageArn' => '',
],
'OutputDataConfig' => [ // REQUIRED
'CompressionType' => 'GZIP|NONE',
'KmsKeyId' => '',
'S3OutputPath' => '', // REQUIRED
],
'ProfilerConfig' => [
'DisableProfiler' => true || false,
'ProfilingIntervalInMilliseconds' => ,
'ProfilingParameters' => ['', ...],
'S3OutputPath' => '',
],
'ProfilerRuleConfigurations' => [
[
'InstanceType' => 'ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p5.4xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'LocalPath' => '',
'RuleConfigurationName' => '', // REQUIRED
'RuleEvaluatorImage' => '', // REQUIRED
'RuleParameters' => ['', ...],
'S3OutputPath' => '',
'VolumeSizeInGB' => ,
],
// ...
],
'RemoteDebugConfig' => [
'EnableRemoteDebug' => true || false,
],
'ResourceConfig' => [
'InstanceCount' => ,
'InstanceGroups' => [
[
'InstanceCount' => , // REQUIRED
'InstanceGroupName' => '', // REQUIRED
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge', // REQUIRED
],
// ...
],
'InstancePlacementConfig' => [
'EnableMultipleJobs' => true || false,
'PlacementSpecifications' => [
[
'InstanceCount' => , // REQUIRED
'UltraServerId' => '',
],
// ...
],
],
'InstancePreferences' => [
[
'InstanceCount' => ,
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge', // REQUIRED
'TrainingPlanArns' => ['', ...],
],
// ...
],
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'KeepAlivePeriodInSeconds' => ,
'SelectedInstanceCount' => ,
'SelectedInstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'TrainingPlanArn' => '',
'VolumeKmsKeyId' => '',
'VolumeSizeInGB' => ,
],
'RetryStrategy' => [
'MaximumRetryAttempts' => , // REQUIRED
],
'RoleArn' => '', // REQUIRED
'ServerlessJobConfig' => [
'AcceptEula' => true || false,
'BaseModelArn' => '', // REQUIRED
'CustomizationTechnique' => 'SFT|DPO|RLVR|RLAIF',
'EvaluationType' => 'LLMAJEvaluation|CustomScorerEvaluation|BenchmarkEvaluation',
'EvaluatorArn' => '',
'JobType' => 'FineTuning|Evaluation', // REQUIRED
'Peft' => 'LORA',
'SequenceLength' => '',
],
'SessionChainingConfig' => [
'EnableSessionTagChaining' => true || false,
],
'StoppingCondition' => [
'MaxPendingTimeInSeconds' => ,
'MaxRuntimeInSeconds' => ,
'MaxWaitTimeInSeconds' => ,
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
'TensorBoardOutputConfig' => [
'LocalPath' => '',
'S3OutputPath' => '', // REQUIRED
],
'TrainingJobName' => '', // REQUIRED
'VpcConfig' => [
'SecurityGroupIds' => ['', ...], // REQUIRED
'Subnets' => ['', ...], // REQUIRED
],
]);
Parameter Details
Members
- AlgorithmSpecification
-
- Type: AlgorithmSpecification structure
The registry path of the Docker image that contains the training algorithm and algorithm-specific metadata, including the input mode. For more information about algorithms provided by SageMaker, see Algorithms. For information about providing your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.
- CheckpointConfig
-
- Type: CheckpointConfig structure
Contains information about the output location for managed spot training checkpoint data.
- DebugHookConfig
-
- Type: DebugHookConfig structure
Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and storage paths. To learn more about how to configure the
DebugHookConfigparameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job. - DebugRuleConfigurations
-
- Type: Array of DebugRuleConfiguration structures
Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.
- EnableInterContainerTrafficEncryption
-
- Type: boolean
To encrypt all communications between ML compute instances in distributed training, choose
True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training. For more information, see Protect Communications Between ML Compute Instances in a Distributed Training Job. - EnableManagedSpotTraining
-
- Type: boolean
To train models using managed spot training, choose
True. Managed spot training provides a fully managed and scalable infrastructure for training machine learning models. this option is useful when training jobs can be interrupted and when there is flexibility when the training job is run.The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be used as a starting point to train models incrementally. Amazon SageMaker provides metrics and logs in CloudWatch. They can be used to see when managed spot training jobs are running, interrupted, resumed, or completed.
- EnableNetworkIsolation
-
- Type: boolean
Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If you enable network isolation for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.
- Environment
-
- Type: Associative array of custom strings keys (TrainingEnvironmentKey) to strings
The environment variables to set in the Docker container.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields.
- ExperimentConfig
-
- Type: ExperimentConfig structure
Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:
- HyperParameters
-
- Type: Associative array of custom strings keys (HyperParameterKey) to strings
Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms.
You can specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value pair. Each key and value is limited to 256 characters, as specified by the
Length Constraint.Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by any security-sensitive information included in the request hyperparameter variable or plain text fields.
- InfraCheckConfig
-
- Type: InfraCheckConfig structure
Contains information about the infrastructure health check configuration for the training job.
- InputDataConfig
-
- Type: Array of Channel structures
An array of
Channelobjects. Each channel is a named input source.InputDataConfigdescribes the input data and its location.Algorithms can accept input data from one or more channels. For example, an algorithm might have two channels of input data,
training_dataandvalidation_data. The configuration for each channel provides the S3, EFS, or FSx location where the input data is stored. It also provides information about the stored data: the MIME type, compression method, and whether the data is wrapped in RecordIO format.Depending on the input mode that the algorithm supports, SageMaker either copies input data files from an S3 bucket to a local directory in the Docker container, or makes it available as input streams. For example, if you specify an EFS location, input data files are available as input streams. They do not need to be downloaded.
Your input must be in the same Amazon Web Services region as your training job.
- MlflowConfig
-
- Type: MlflowConfig structure
The MLflow configuration using SageMaker managed MLflow.
- ModelPackageConfig
-
- Type: ModelPackageConfig structure
The configuration for the model package.
- OutputDataConfig
-
- Required: Yes
- Type: OutputDataConfig structure
Specifies the path to the S3 location where you want to store model artifacts. SageMaker creates subfolders for the artifacts.
- ProfilerConfig
-
- Type: ProfilerConfig structure
Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.
- ProfilerRuleConfigurations
-
- Type: Array of ProfilerRuleConfiguration structures
Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.
- RemoteDebugConfig
-
- Type: RemoteDebugConfig structure
Configuration for remote debugging. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.
- ResourceConfig
-
- Type: ResourceConfig structure
The resources, including the ML compute instances and ML storage volumes, to use for model training.
ML storage volumes store model artifacts and incremental states. Training algorithms might also use ML storage volumes for scratch space. If you want SageMaker to use the ML storage volume to store the training data, choose
Fileas theTrainingInputModein the algorithm specification. For distributed training algorithms, specify an instance count greater than 1. - RetryStrategy
-
- Type: RetryStrategy structure
The number of times to retry the job when the job fails due to an
InternalServerError. - RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform tasks on your behalf.
During model training, SageMaker needs your permission to read input data from an S3 bucket, download a Docker image that contains training code, write model artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant permissions for all of these tasks to an IAM role. For more information, see SageMaker Roles.
To be able to pass this role to SageMaker, the caller of this API must have the
iam:PassRolepermission. - ServerlessJobConfig
-
- Type: ServerlessJobConfig structure
The configuration for serverless training jobs.
- SessionChainingConfig
-
- Type: SessionChainingConfig structure
Contains information about attribute-based access control (ABAC) for the training job.
- StoppingCondition
-
- Type: StoppingCondition structure
Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.
To stop a job, SageMaker sends the algorithm the
SIGTERMsignal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost. - Tags
-
- 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.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any tags. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by any security-sensitive information included in the request tag variable or plain text fields.
- TensorBoardOutputConfig
-
- Type: TensorBoardOutputConfig structure
Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.
- TrainingJobName
-
- Required: Yes
- Type: string
The name of the training job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.
- VpcConfig
-
- Type: VpcConfig structure
A VpcConfig object that specifies the VPC that you want your training job to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.
Result Syntax
[
'TrainingJobArn' => '',
]
Result Details
Members
- TrainingJobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the training job.
Errors
- ResourceNotFound:
Resource being access is not found.
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateTrainingPlan
$result = $client->createTrainingPlan([/* ... */]); $promise = $client->createTrainingPlanAsync([/* ... */]);
Creates a new training plan in SageMaker to reserve compute capacity.
Amazon SageMaker Training Plan is a capability within SageMaker that allows customers to reserve and manage GPU capacity for large-scale AI model training. It provides a way to secure predictable access to computational resources within specific timelines and budgets, without the need to manage underlying infrastructure.
How it works
Plans can be created for specific resources such as SageMaker Training Jobs or SageMaker HyperPod clusters, automatically provisioning resources, setting up infrastructure, executing workloads, and handling infrastructure failures.
Plan creation workflow
-
Users search for available plan offerings based on their requirements (e.g., instance type, count, start time, duration) using the
SearchTrainingPlanOfferingsAPI operation. -
They create a plan that best matches their needs using the ID of the plan offering they want to use.
-
After successful upfront payment, the plan's status becomes
Scheduled. -
The plan can be used to:
-
Queue training jobs.
-
Allocate to an instance group of a SageMaker HyperPod cluster.
-
-
When the plan start date arrives, it becomes
Active. Based on available reserved capacity:-
Training jobs are launched.
-
Instance groups are provisioned.
-
Plan composition
A plan can consist of one or more Reserved Capacities, each defined by a specific instance type, quantity, Availability Zone, duration, and start and end times. For more information about Reserved Capacity, see ReservedCapacitySummary .
Parameter Syntax
$result = $client->createTrainingPlan([
'SpareInstanceCountPerUltraServer' => ,
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
'TrainingPlanName' => '', // REQUIRED
'TrainingPlanOfferingId' => '', // REQUIRED
]);
Parameter Details
Members
- SpareInstanceCountPerUltraServer
-
- Type: int
Number of spare instances to reserve per UltraServer for enhanced resiliency. Default is 1.
- Tags
-
- Type: Array of Tag structures
An array of key-value pairs to apply to this training plan.
- TrainingPlanName
-
- Required: Yes
- Type: string
The name of the training plan to create.
- TrainingPlanOfferingId
-
- Required: Yes
- Type: string
The unique identifier of the training plan offering to use for creating this plan.
Result Syntax
[
'TrainingPlanArn' => '',
]
Result Details
Members
- TrainingPlanArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN); of the created training plan.
Errors
- ResourceNotFound:
Resource being access is not found.
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateTransformJob
$result = $client->createTransformJob([/* ... */]); $promise = $client->createTransformJobAsync([/* ... */]);
Starts a transform job. A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify.
To perform batch transformations, you create a transform job and use the data that you have readily available.
In the request body, you provide the following:
-
TransformJobName- Identifies the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account. -
ModelName- Identifies the model to use.ModelNamemust be the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and Amazon Web Services account. For information on creating a model, see CreateModel. -
TransformInput- Describes the dataset to be transformed and the Amazon S3 location where it is stored. -
TransformOutput- Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job. -
TransformResources- Identifies the ML compute instances and AMI image versions for the transform job.
For more information about how batch transformation works, see Batch Transform.
Parameter Syntax
$result = $client->createTransformJob([
'BatchStrategy' => 'MultiRecord|SingleRecord',
'DataCaptureConfig' => [
'DestinationS3Uri' => '', // REQUIRED
'GenerateInferenceId' => true || false,
'KmsKeyId' => '',
],
'DataProcessing' => [
'InputFilter' => '',
'JoinSource' => 'Input|None',
'OutputFilter' => '',
],
'Environment' => ['', ...],
'ExperimentConfig' => [
'ExperimentName' => '',
'RunName' => '',
'TrialComponentDisplayName' => '',
'TrialName' => '',
],
'MaxConcurrentTransforms' => ,
'MaxPayloadInMB' => ,
'ModelClientConfig' => [
'InvocationsMaxRetries' => ,
'InvocationsTimeoutInSeconds' => ,
],
'ModelName' => '', // REQUIRED
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
'TransformInput' => [ // REQUIRED
'CompressionType' => 'None|Gzip',
'ContentType' => '',
'DataSource' => [ // REQUIRED
'S3DataSource' => [ // REQUIRED
'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile|Converse', // REQUIRED
'S3Uri' => '', // REQUIRED
],
],
'SplitType' => 'None|Line|RecordIO|TFRecord',
],
'TransformJobName' => '', // REQUIRED
'TransformOutput' => [ // REQUIRED
'Accept' => '',
'AssembleWith' => 'None|Line',
'KmsKeyId' => '',
'S3OutputPath' => '', // REQUIRED
],
'TransformResources' => [ // REQUIRED
'InstanceCount' => , // REQUIRED
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge', // REQUIRED
'TransformAmiVersion' => '',
'VolumeKmsKeyId' => '',
],
]);
Parameter Details
Members
- BatchStrategy
-
- Type: string
Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.
To enable the batch strategy, you must set the
SplitTypeproperty toLine,RecordIO, orTFRecord.To use only one record when making an HTTP invocation request to a container, set
BatchStrategytoSingleRecordandSplitTypetoLine.To fit as many records in a mini-batch as can fit within the
MaxPayloadInMBlimit, setBatchStrategytoMultiRecordandSplitTypetoLine. - DataCaptureConfig
-
- Type: BatchDataCaptureConfig structure
Configuration to control how SageMaker captures inference data.
- DataProcessing
-
- Type: DataProcessing structure
The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.
- Environment
-
- Type: Associative array of custom strings keys (TransformEnvironmentKey) to strings
The environment variables to set in the Docker container. Don't include any sensitive data in your environment variables. We support up to 16 key and values entries in the map.
- ExperimentConfig
-
- Type: ExperimentConfig structure
Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:
- MaxConcurrentTransforms
-
- Type: int
The maximum number of parallel requests that can be sent to each instance in a transform job. If
MaxConcurrentTransformsis set to0or left unset, Amazon SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is1. For more information on execution-parameters, see How Containers Serve Requests. For built-in algorithms, you don't need to set a value forMaxConcurrentTransforms. - MaxPayloadInMB
-
- Type: int
The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in
MaxPayloadInMBmust be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is6MB.The value of
MaxPayloadInMBcannot be greater than 100 MB. If you specify theMaxConcurrentTransformsparameter, the value of(MaxConcurrentTransforms * MaxPayloadInMB)also cannot exceed 100 MB.For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to
0. This feature works only in supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support HTTP chunked encoding. - ModelClientConfig
-
- Type: ModelClientConfig structure
Configures the timeout and maximum number of retries for processing a transform job invocation.
- ModelName
-
- Required: Yes
- Type: string
The name of the model that you want to use for the transform job.
ModelNamemust be the name of an existing Amazon SageMaker model within an Amazon Web Services Region in an Amazon Web Services account. - Tags
-
- Type: Array of Tag structures
(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
- TransformInput
-
- Required: Yes
- Type: TransformInput structure
Describes the input source and the way the transform job consumes it.
- TransformJobName
-
- Required: Yes
- Type: string
The name of the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.
- TransformOutput
-
- Required: Yes
- Type: TransformOutput structure
Describes the results of the transform job.
- TransformResources
-
- Required: Yes
- Type: TransformResources structure
Describes the resources, including ML instance types and ML instance count, to use for the transform job.
Result Syntax
[
'TransformJobArn' => '',
]
Result Details
Members
- TransformJobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the transform job.
Errors
- ResourceNotFound:
Resource being access is not found.
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateTrial
$result = $client->createTrial([/* ... */]); $promise = $client->createTrialAsync([/* ... */]);
Creates an SageMaker trial. A trial is a set of steps called trial components that produce a machine learning model. A trial is part of a single SageMaker experiment.
When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.
You can add tags to a trial and then use the Search API to search for the tags.
To get a list of all your trials, call the ListTrials API. To view a trial's properties, call the DescribeTrial API. To create a trial component, call the CreateTrialComponent API.
Parameter Syntax
$result = $client->createTrial([
'DisplayName' => '',
'ExperimentName' => '', // REQUIRED
'MetadataProperties' => [
'CommitId' => '',
'GeneratedBy' => '',
'ProjectId' => '',
'Repository' => '',
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
'TrialName' => '', // REQUIRED
]);
Parameter Details
Members
- DisplayName
-
- Type: string
The name of the trial as displayed. The name doesn't need to be unique. If
DisplayNameisn't specified,TrialNameis displayed. - ExperimentName
-
- Required: Yes
- Type: string
The name of the experiment to associate the trial with.
- MetadataProperties
-
- Type: MetadataProperties structure
Metadata properties of the tracking entity, trial, or trial component.
- Tags
-
- Type: Array of Tag structures
A list of tags to associate with the trial. You can use Search API to search on the tags.
- TrialName
-
- Required: Yes
- Type: string
The name of the trial. The name must be unique in your Amazon Web Services account and is not case-sensitive.
Result Syntax
[
'TrialArn' => '',
]
Result Details
Members
- TrialArn
-
- Type: string
The Amazon Resource Name (ARN) of the trial.
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.
CreateTrialComponent
$result = $client->createTrialComponent([/* ... */]); $promise = $client->createTrialComponentAsync([/* ... */]);
Creates a trial component, which is a stage of a machine learning trial. A trial is composed of one or more trial components. A trial component can be used in multiple trials.
Trial components include pre-processing jobs, training jobs, and batch transform jobs.
When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.
You can add tags to a trial component and then use the Search API to search for the tags.
Parameter Syntax
$result = $client->createTrialComponent([
'DisplayName' => '',
'EndTime' => ,
'InputArtifacts' => [
'' => [
'MediaType' => '',
'Value' => '', // REQUIRED
],
// ...
],
'MetadataProperties' => [
'CommitId' => '',
'GeneratedBy' => '',
'ProjectId' => '',
'Repository' => '',
],
'OutputArtifacts' => [
'' => [
'MediaType' => '',
'Value' => '', // REQUIRED
],
// ...
],
'Parameters' => [
'' => [
'NumberValue' => ,
'StringValue' => '',
],
// ...
],
'StartTime' => ,
'Status' => [
'Message' => '',
'PrimaryStatus' => 'InProgress|Completed|Failed|Stopping|Stopped',
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
'TrialComponentName' => '', // REQUIRED
]);
Parameter Details
Members
- DisplayName
-
- Type: string
The name of the component as displayed. The name doesn't need to be unique. If
DisplayNameisn't specified,TrialComponentNameis displayed. - EndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the component ended.
- InputArtifacts
-
- Type: Associative array of custom strings keys (TrialComponentKey128) to TrialComponentArtifact structures
The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.
- MetadataProperties
-
- Type: MetadataProperties structure
Metadata properties of the tracking entity, trial, or trial component.
- OutputArtifacts
-
- Type: Associative array of custom strings keys (TrialComponentKey128) to TrialComponentArtifact structures
The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.
- Parameters
-
- Type: Associative array of custom strings keys (TrialComponentKey320) to TrialComponentParameterValue structures
The hyperparameters for the component.
- StartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the component started.
- Status
-
- Type: TrialComponentStatus structure
The status of the component. States include:
-
InProgress
-
Completed
-
Failed
- Tags
-
- Type: Array of Tag structures
A list of tags to associate with the component. You can use Search API to search on the tags.
- TrialComponentName
-
- Required: Yes
- Type: string
The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.
Result Syntax
[
'TrialComponentArn' => '',
]
Result Details
Members
- TrialComponentArn
-
- Type: string
The Amazon Resource Name (ARN) of the trial component.
Errors
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateUserProfile
$result = $client->createUserProfile([/* ... */]); $promise = $client->createUserProfileAsync([/* ... */]);
Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a "person" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to a domain. If an administrator invites a person by email or imports them from IAM Identity Center, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System home directory.
Parameter Syntax
$result = $client->createUserProfile([
'DomainId' => '', // REQUIRED
'SingleSignOnUserIdentifier' => '',
'SingleSignOnUserValue' => '',
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
'UserProfileName' => '', // REQUIRED
'UserSettings' => [
'AutoMountHomeEFS' => 'Enabled|Disabled|DefaultAsDomain',
'CanvasAppSettings' => [
'DirectDeploySettings' => [
'Status' => 'ENABLED|DISABLED',
],
'EmrServerlessSettings' => [
'ExecutionRoleArn' => '',
'Status' => 'ENABLED|DISABLED',
],
'GenerativeAiSettings' => [
'AmazonBedrockRoleArn' => '',
],
'IdentityProviderOAuthSettings' => [
[
'DataSourceName' => 'SalesforceGenie|Snowflake',
'SecretArn' => '',
'Status' => 'ENABLED|DISABLED',
],
// ...
],
'KendraSettings' => [
'Status' => 'ENABLED|DISABLED',
],
'ModelRegisterSettings' => [
'CrossAccountModelRegisterRoleArn' => '',
'Status' => 'ENABLED|DISABLED',
],
'TimeSeriesForecastingSettings' => [
'AmazonForecastRoleArn' => '',
'Status' => 'ENABLED|DISABLED',
],
'WorkspaceSettings' => [
'S3ArtifactPath' => '',
'S3KmsKeyId' => '',
],
],
'CodeEditorAppSettings' => [
'AppLifecycleManagement' => [
'IdleSettings' => [
'IdleTimeoutInMinutes' => ,
'LifecycleManagement' => 'ENABLED|DISABLED',
'MaxIdleTimeoutInMinutes' => ,
'MinIdleTimeoutInMinutes' => ,
],
],
'BuiltInLifecycleConfigArn' => '',
'CustomImages' => [
[
'AppImageConfigName' => '', // REQUIRED
'ImageName' => '', // REQUIRED
'ImageVersionNumber' => ,
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
'LifecycleConfigArns' => ['', ...],
],
'CustomFileSystemConfigs' => [
[
'EFSFileSystemConfig' => [
'FileSystemId' => '', // REQUIRED
'FileSystemPath' => '',
],
'FSxLustreFileSystemConfig' => [
'FileSystemId' => '', // REQUIRED
'FileSystemPath' => '',
],
'S3FileSystemConfig' => [
'MountPath' => '',
'S3Uri' => '', // REQUIRED
],
],
// ...
],
'CustomPosixUserConfig' => [
'Gid' => , // REQUIRED
'Uid' => , // REQUIRED
],
'DefaultLandingUri' => '',
'ExecutionRole' => '',
'JupyterLabAppSettings' => [
'AppLifecycleManagement' => [
'IdleSettings' => [
'IdleTimeoutInMinutes' => ,
'LifecycleManagement' => 'ENABLED|DISABLED',
'MaxIdleTimeoutInMinutes' => ,
'MinIdleTimeoutInMinutes' => ,
],
],
'BuiltInLifecycleConfigArn' => '',
'CodeRepositories' => [
[
'RepositoryUrl' => '', // REQUIRED
],
// ...
],
'CustomImages' => [
[
'AppImageConfigName' => '', // REQUIRED
'ImageName' => '', // REQUIRED
'ImageVersionNumber' => ,
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
'EmrSettings' => [
'AssumableRoleArns' => ['', ...],
'ExecutionRoleArns' => ['', ...],
],
'LifecycleConfigArns' => ['', ...],
],
'JupyterServerAppSettings' => [
'CodeRepositories' => [
[
'RepositoryUrl' => '', // REQUIRED
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
'LifecycleConfigArns' => ['', ...],
],
'KernelGatewayAppSettings' => [
'CustomImages' => [
[
'AppImageConfigName' => '', // REQUIRED
'ImageName' => '', // REQUIRED
'ImageVersionNumber' => ,
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
'LifecycleConfigArns' => ['', ...],
],
'RSessionAppSettings' => [
'CustomImages' => [
[
'AppImageConfigName' => '', // REQUIRED
'ImageName' => '', // REQUIRED
'ImageVersionNumber' => ,
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
],
'RStudioServerProAppSettings' => [
'AccessStatus' => 'ENABLED|DISABLED',
'UserGroup' => 'R_STUDIO_ADMIN|R_STUDIO_USER',
],
'SecurityGroups' => ['', ...],
'SharingSettings' => [
'NotebookOutputOption' => 'Allowed|Disabled',
'S3KmsKeyId' => '',
'S3OutputPath' => '',
],
'SpaceStorageSettings' => [
'DefaultEbsStorageSettings' => [
'DefaultEbsVolumeSizeInGb' => , // REQUIRED
'MaximumEbsVolumeSizeInGb' => , // REQUIRED
],
],
'StudioWebPortal' => 'ENABLED|DISABLED',
'StudioWebPortalSettings' => [
'ExecutionRoleSessionNameMode' => 'STATIC|USER_IDENTITY',
'HiddenAppTypes' => ['', ...],
'HiddenInstanceTypes' => ['', ...],
'HiddenMlTools' => ['', ...],
'HiddenSageMakerImageVersionAliases' => [
[
'SageMakerImageName' => 'sagemaker_distribution',
'VersionAliases' => ['', ...],
],
// ...
],
],
'TensorBoardAppSettings' => [
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
],
],
]);
Parameter Details
Members
- DomainId
-
- Required: Yes
- Type: string
The ID of the associated Domain.
- SingleSignOnUserIdentifier
-
- Type: string
A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain's AuthMode is IAM Identity Center, this field is required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.
- SingleSignOnUserValue
-
- Type: string
The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.
- Tags
-
- Type: Array of Tag structures
Each tag consists of a key and an optional value. Tag keys must be unique per resource.
Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.
- UserProfileName
-
- Required: Yes
- Type: string
A name for the UserProfile. This value is not case sensitive.
- UserSettings
-
- Type: UserSettings structure
A collection of settings.
Result Syntax
[
'UserProfileArn' => '',
]
Result Details
Members
- UserProfileArn
-
- Type: string
The user profile Amazon Resource Name (ARN).
Errors
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
CreateWorkforce
$result = $client->createWorkforce([/* ... */]); $promise = $client->createWorkforceAsync([/* ... */]);
Use this operation to create a workforce. This operation will return an error if a workforce already exists in the Amazon Web Services Region that you specify. You can only create one workforce in each Amazon Web Services Region per Amazon Web Services account.
If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use the DeleteWorkforce API operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.
To create a private workforce using Amazon Cognito, you must specify a Cognito user pool in CognitoConfig. You can also create an Amazon Cognito workforce using the Amazon SageMaker console. For more information, see Create a Private Workforce (Amazon Cognito).
To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP configuration in OidcConfig. Your OIDC IdP must support groups because groups are used by Ground Truth and Amazon A2I to create work teams. For more information, see Create a Private Workforce (OIDC IdP).
Parameter Syntax
$result = $client->createWorkforce([
'CognitoConfig' => [
'ClientId' => '', // REQUIRED
'UserPool' => '', // REQUIRED
],
'IpAddressType' => 'ipv4|dualstack',
'OidcConfig' => [
'AuthenticationRequestExtraParams' => ['', ...],
'AuthorizationEndpoint' => '', // REQUIRED
'ClientId' => '', // REQUIRED
'ClientSecret' => '', // REQUIRED
'Issuer' => '', // REQUIRED
'JwksUri' => '', // REQUIRED
'LogoutEndpoint' => '', // REQUIRED
'Scope' => '',
'TokenEndpoint' => '', // REQUIRED
'UserInfoEndpoint' => '', // REQUIRED
],
'SourceIpConfig' => [
'Cidrs' => ['', ...], // REQUIRED
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
'WorkforceName' => '', // REQUIRED
'WorkforceVpcConfig' => [
'SecurityGroupIds' => ['', ...],
'Subnets' => ['', ...],
'VpcId' => '',
],
]);
Parameter Details
Members
- CognitoConfig
-
- Type: CognitoConfig structure
Use this parameter to configure an Amazon Cognito private workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.
Do not use
OidcConfigif you specify values forCognitoConfig. - IpAddressType
-
- Type: string
Use this parameter to specify whether you want
IPv4only ordualstack(IPv4andIPv6) to support your labeling workforce. - OidcConfig
-
- Type: OidcConfig structure
Use this parameter to configure a private workforce using your own OIDC Identity Provider.
Do not use
CognitoConfigif you specify values forOidcConfig. - SourceIpConfig
-
- Type: SourceIpConfig structure
A list of IP address ranges (CIDRs). Used to create an allow list of IP addresses for a private workforce. Workers will only be able to log in to their worker portal from an IP address within this range. By default, a workforce isn't restricted to specific IP addresses.
- Tags
-
- Type: Array of Tag structures
An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each tag consists of a key and a value, both of which you define.
- WorkforceName
-
- Required: Yes
- Type: string
The name of the private workforce.
- WorkforceVpcConfig
-
- Type: WorkforceVpcConfigRequest structure
Use this parameter to configure a workforce using VPC.
Result Syntax
[
'WorkforceArn' => '',
]
Result Details
Members
- WorkforceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the workforce.
Errors
There are no errors described for this operation.
CreateWorkteam
$result = $client->createWorkteam([/* ... */]); $promise = $client->createWorkteamAsync([/* ... */]);
Creates a new work team for labeling your data. A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team.
You cannot create more than 25 work teams in an account and region.
Parameter Syntax
$result = $client->createWorkteam([
'Description' => '', // REQUIRED
'MemberDefinitions' => [ // REQUIRED
[
'CognitoMemberDefinition' => [
'ClientId' => '', // REQUIRED
'UserGroup' => '', // REQUIRED
'UserPool' => '', // REQUIRED
],
'OidcMemberDefinition' => [
'Groups' => ['', ...],
],
],
// ...
],
'NotificationConfiguration' => [
'NotificationTopicArn' => '',
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
'WorkerAccessConfiguration' => [
'S3Presign' => [
'IamPolicyConstraints' => [
'SourceIp' => 'Enabled|Disabled',
'VpcSourceIp' => 'Enabled|Disabled',
],
],
],
'WorkforceName' => '',
'WorkteamName' => '', // REQUIRED
]);
Parameter Details
Members
- Description
-
- Required: Yes
- Type: string
A description of the work team.
- MemberDefinitions
-
- Required: Yes
- Type: Array of MemberDefinition structures
A list of
MemberDefinitionobjects that contains objects that identify the workers that make up the work team.Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use
CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) useOidcMemberDefinition. Do not provide input for both of these parameters in a single request.For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user groups within the user pool used to create a workforce. All of the
CognitoMemberDefinitionobjects that make up the member definition must have the sameClientIdandUserPoolvalues. To add a Amazon Cognito user group to an existing worker pool, see Adding groups to a User Pool. For more information about user pools, see Amazon Cognito User Pools.For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in
OidcMemberDefinitionby listing those groups inGroups. - NotificationConfiguration
-
- Type: NotificationConfiguration structure
Configures notification of workers regarding available or expiring work items.
- Tags
-
- Type: Array of Tag structures
An array of key-value pairs.
For more information, see Resource Tag and Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
- WorkerAccessConfiguration
-
- Type: WorkerAccessConfiguration structure
Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.
- WorkforceName
-
- Type: string
The name of the workforce.
- WorkteamName
-
- Required: Yes
- Type: string
The name of the work team. Use this name to identify the work team.
Result Syntax
[
'WorkteamArn' => '',
]
Result Details
Members
- WorkteamArn
-
- Type: string
The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the work team.
Errors
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
DeleteAIBenchmarkJob
$result = $client->deleteAIBenchmarkJob([/* ... */]); $promise = $client->deleteAIBenchmarkJobAsync([/* ... */]);
Deletes the specified AI benchmark job.
Parameter Syntax
$result = $client->deleteAIBenchmarkJob([
'AIBenchmarkJobName' => '', // REQUIRED
]);
Parameter Details
Members
- AIBenchmarkJobName
-
- Required: Yes
- Type: string
The name of the AI benchmark job to delete.
Result Syntax
[
'AIBenchmarkJobArn' => '',
]
Result Details
Members
- AIBenchmarkJobArn
-
- Type: string
The Amazon Resource Name (ARN) of the deleted benchmark job.
Errors
- ResourceNotFound:
Resource being access is not found.
DeleteAIRecommendationJob
$result = $client->deleteAIRecommendationJob([/* ... */]); $promise = $client->deleteAIRecommendationJobAsync([/* ... */]);
Deletes the specified AI recommendation job.
Parameter Syntax
$result = $client->deleteAIRecommendationJob([
'AIRecommendationJobName' => '', // REQUIRED
]);
Parameter Details
Members
- AIRecommendationJobName
-
- Required: Yes
- Type: string
The name of the AI recommendation job to delete.
Result Syntax
[
'AIRecommendationJobArn' => '',
]
Result Details
Members
- AIRecommendationJobArn
-
- Type: string
The Amazon Resource Name (ARN) of the deleted recommendation job.
Errors
- ResourceNotFound:
Resource being access is not found.
DeleteAIWorkloadConfig
$result = $client->deleteAIWorkloadConfig([/* ... */]); $promise = $client->deleteAIWorkloadConfigAsync([/* ... */]);
Deletes the specified AI workload configuration. You cannot delete a configuration that is referenced by an active benchmark job.
Parameter Syntax
$result = $client->deleteAIWorkloadConfig([
'AIWorkloadConfigName' => '', // REQUIRED
]);
Parameter Details
Members
- AIWorkloadConfigName
-
- Required: Yes
- Type: string
The name of the AI workload configuration to delete.
Result Syntax
[
'AIWorkloadConfigArn' => '',
]
Result Details
Members
- AIWorkloadConfigArn
-
- Type: string
The Amazon Resource Name (ARN) of the deleted AI workload configuration.
Errors
- ResourceNotFound:
Resource being access is not found.
- ResourceInUse:
Resource being accessed is in use.
DeleteAction
$result = $client->deleteAction([/* ... */]); $promise = $client->deleteActionAsync([/* ... */]);
Deletes an action.
Parameter Syntax
$result = $client->deleteAction([
'ActionName' => '', // REQUIRED
]);
Parameter Details
Members
- ActionName
-
- Required: Yes
- Type: string
The name of the action to delete.
Result Syntax
[
'ActionArn' => '',
]
Result Details
Members
- ActionArn
-
- Type: string
The Amazon Resource Name (ARN) of the action.
Errors
- ResourceNotFound:
Resource being access is not found.
DeleteAlgorithm
$result = $client->deleteAlgorithm([/* ... */]); $promise = $client->deleteAlgorithmAsync([/* ... */]);
Removes the specified algorithm from your account.
Parameter Syntax
$result = $client->deleteAlgorithm([
'AlgorithmName' => '', // REQUIRED
]);
Parameter Details
Members
- AlgorithmName
-
- Required: Yes
- Type: string
The name of the algorithm to delete.
Result Syntax
[]
Result Details
Errors
- ConflictException:
There was a conflict when you attempted to modify a SageMaker entity such as an
ExperimentorArtifact.
DeleteApp
$result = $client->deleteApp([/* ... */]); $promise = $client->deleteAppAsync([/* ... */]);
Used to stop and delete an app.
Parameter Syntax
$result = $client->deleteApp([
'AppName' => '', // REQUIRED
'AppType' => 'JupyterServer|KernelGateway|DetailedProfiler|TensorBoard|CodeEditor|JupyterLab|RStudioServerPro|RSessionGateway|Canvas', // REQUIRED
'DomainId' => '', // REQUIRED
'SpaceName' => '',
'UserProfileName' => '',
]);
Parameter Details
Members
- AppName
-
- Required: Yes
- Type: string
The name of the app.
- AppType
-
- Required: Yes
- Type: string
The type of app.
- DomainId
-
- Required: Yes
- Type: string
The domain ID.
- SpaceName
-
- Type: string
The name of the space. If this value is not set, then
UserProfileNamemust be set. - UserProfileName
-
- Type: string
The user profile name. If this value is not set, then
SpaceNamemust be set.
Result Syntax
[]
Result Details
Errors
- ResourceNotFound:
Resource being access is not found.
- ResourceInUse:
Resource being accessed is in use.
DeleteAppImageConfig
$result = $client->deleteAppImageConfig([/* ... */]); $promise = $client->deleteAppImageConfigAsync([/* ... */]);
Deletes an AppImageConfig.
Parameter Syntax
$result = $client->deleteAppImageConfig([
'AppImageConfigName' => '', // REQUIRED
]);
Parameter Details
Members
- AppImageConfigName
-
- Required: Yes
- Type: string
The name of the AppImageConfig to delete.
Result Syntax
[]
Result Details
Errors
- ResourceNotFound:
Resource being access is not found.
DeleteArtifact
$result = $client->deleteArtifact([/* ... */]); $promise = $client->deleteArtifactAsync([/* ... */]);
Deletes an artifact. Either ArtifactArn or Source must be specified.
Parameter Syntax
$result = $client->deleteArtifact([
'ArtifactArn' => '',
'Source' => [
'SourceTypes' => [
[
'SourceIdType' => 'MD5Hash|S3ETag|S3Version|Custom', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
'SourceUri' => '', // REQUIRED
],
]);
Parameter Details
Members
- ArtifactArn
-
- Type: string
The Amazon Resource Name (ARN) of the artifact to delete.
- Source
-
- Type: ArtifactSource structure
The URI of the source.
Result Syntax
[
'ArtifactArn' => '',
]
Result Details
Members
- ArtifactArn
-
- Type: string
The Amazon Resource Name (ARN) of the artifact.
Errors
- ResourceNotFound:
Resource being access is not found.
DeleteAssociation
$result = $client->deleteAssociation([/* ... */]); $promise = $client->deleteAssociationAsync([/* ... */]);
Deletes an association.
Parameter Syntax
$result = $client->deleteAssociation([
'DestinationArn' => '', // REQUIRED
'SourceArn' => '', // REQUIRED
]);
Parameter Details
Members
- 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' => '',
'SourceArn' => '',
]
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.
DeleteCluster
$result = $client->deleteCluster([/* ... */]); $promise = $client->deleteClusterAsync([/* ... */]);
Delete a SageMaker HyperPod cluster.
Parameter Syntax
$result = $client->deleteCluster([
'ClusterName' => '', // REQUIRED
]);
Parameter Details
Members
- ClusterName
-
- Required: Yes
- Type: string
The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.
Result Syntax
[
'ClusterArn' => '',
]
Result Details
Members
- ClusterArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.
Errors
- ConflictException:
There was a conflict when you attempted to modify a SageMaker entity such as an
ExperimentorArtifact.- ResourceNotFound:
Resource being access is not found.
DeleteClusterSchedulerConfig
$result = $client->deleteClusterSchedulerConfig([/* ... */]); $promise = $client->deleteClusterSchedulerConfigAsync([/* ... */]);
Deletes the cluster policy of the cluster.
Parameter Syntax
$result = $client->deleteClusterSchedulerConfig([
'ClusterSchedulerConfigId' => '', // REQUIRED
]);
Parameter Details
Members
- ClusterSchedulerConfigId
-
- Required: Yes
- Type: string
ID of the cluster policy.
Result Syntax
[]
Result Details
Errors
- ResourceNotFound:
Resource being access is not found.
DeleteCodeRepository
$result = $client->deleteCodeRepository([/* ... */]); $promise = $client->deleteCodeRepositoryAsync([/* ... */]);
Deletes the specified Git repository from your account.
Parameter Syntax
$result = $client->deleteCodeRepository([
'CodeRepositoryName' => '', // REQUIRED
]);
Parameter Details
Members
- CodeRepositoryName
-
- Required: Yes
- Type: string
The name of the Git repository to delete.
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DeleteCompilationJob
$result = $client->deleteCompilationJob([/* ... */]); $promise = $client->deleteCompilationJobAsync([/* ... */]);
Deletes the specified compilation job. This action deletes only the compilation job resource in Amazon SageMaker AI. It doesn't delete other resources that are related to that job, such as the model artifacts that the job creates, the compilation logs in CloudWatch, the compiled model, or the IAM role.
You can delete a compilation job only if its current status is COMPLETED, FAILED, or STOPPED. If the job status is STARTING or INPROGRESS, stop the job, and then delete it after its status becomes STOPPED.
Parameter Syntax
$result = $client->deleteCompilationJob([
'CompilationJobName' => '', // REQUIRED
]);
Parameter Details
Members
- CompilationJobName
-
- Required: Yes
- Type: string
The name of the compilation job to delete.
Result Syntax
[]
Result Details
Errors
- ResourceNotFound:
Resource being access is not found.
DeleteComputeQuota
$result = $client->deleteComputeQuota([/* ... */]); $promise = $client->deleteComputeQuotaAsync([/* ... */]);
Deletes the compute allocation from the cluster.
Parameter Syntax
$result = $client->deleteComputeQuota([
'ComputeQuotaId' => '', // REQUIRED
]);
Parameter Details
Members
- ComputeQuotaId
-
- Required: Yes
- Type: string
ID of the compute allocation definition.
Result Syntax
[]
Result Details
Errors
- ResourceNotFound:
Resource being access is not found.
DeleteContext
$result = $client->deleteContext([/* ... */]); $promise = $client->deleteContextAsync([/* ... */]);
Deletes an context.
Parameter Syntax
$result = $client->deleteContext([
'ContextName' => '', // REQUIRED
]);
Parameter Details
Members
- ContextName
-
- Required: Yes
- Type: string
The name of the context to delete.
Result Syntax
[
'ContextArn' => '',
]
Result Details
Members
- ContextArn
-
- Type: string
The Amazon Resource Name (ARN) of the context.
Errors
- ResourceNotFound:
Resource being access is not found.
DeleteDataQualityJobDefinition
$result = $client->deleteDataQualityJobDefinition([/* ... */]); $promise = $client->deleteDataQualityJobDefinitionAsync([/* ... */]);
Deletes a data quality monitoring job definition.
Parameter Syntax
$result = $client->deleteDataQualityJobDefinition([
'JobDefinitionName' => '', // REQUIRED
]);
Parameter Details
Members
- JobDefinitionName
-
- Required: Yes
- Type: string
The name of the data quality monitoring job definition to delete.
Result Syntax
[]
Result Details
Errors
- ResourceNotFound:
Resource being access is not found.
DeleteDeviceFleet
$result = $client->deleteDeviceFleet([/* ... */]); $promise = $client->deleteDeviceFleetAsync([/* ... */]);
Deletes a fleet.
Parameter Syntax
$result = $client->deleteDeviceFleet([
'DeviceFleetName' => '', // REQUIRED
]);
Parameter Details
Members
- DeviceFleetName
-
- Required: Yes
- Type: string
The name of the fleet to delete.
Result Syntax
[]
Result Details
Errors
- ResourceInUse:
Resource being accessed is in use.
DeleteDomain
$result = $client->deleteDomain([/* ... */]); $promise = $client->deleteDomainAsync([/* ... */]);
Used to delete a domain. If you onboarded with IAM mode, you will need to delete your domain to onboard again using IAM Identity Center. Use with caution. All of the members of the domain will lose access to their EFS volume, including data, notebooks, and other artifacts.
Parameter Syntax
$result = $client->deleteDomain([
'DomainId' => '', // REQUIRED
'RetentionPolicy' => [
'HomeEfsFileSystem' => 'Retain|Delete',
],
]);
Parameter Details
Members
- DomainId
-
- Required: Yes
- Type: string
The domain ID.
- RetentionPolicy
-
- Type: RetentionPolicy structure
The retention policy for this domain, which specifies whether resources will be retained after the Domain is deleted. By default, all resources are retained (not automatically deleted).
Result Syntax
[]
Result Details
Errors
- ResourceNotFound:
Resource being access is not found.
- ResourceInUse:
Resource being accessed is in use.
DeleteEdgeDeploymentPlan
$result = $client->deleteEdgeDeploymentPlan([/* ... */]); $promise = $client->deleteEdgeDeploymentPlanAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteEdgeDeploymentPlan([
'EdgeDeploymentPlanName' => '', // REQUIRED
]);
Parameter Details
Members
- EdgeDeploymentPlanName
-
- Required: Yes
- Type: string
The name of the edge deployment plan to delete.
Result Syntax
[]
Result Details
Errors
- ResourceInUse:
Resource being accessed is in use.
DeleteEdgeDeploymentStage
$result = $client->deleteEdgeDeploymentStage([/* ... */]); $promise = $client->deleteEdgeDeploymentStageAsync([/* ... */]);
Delete a stage in an edge deployment plan if (and only if) the stage is inactive.
Parameter Syntax
$result = $client->deleteEdgeDeploymentStage([
'EdgeDeploymentPlanName' => '', // REQUIRED
'StageName' => '', // REQUIRED
]);
Parameter Details
Members
- EdgeDeploymentPlanName
-
- Required: Yes
- Type: string
The name of the edge deployment plan from which the stage will be deleted.
- StageName
-
- Required: Yes
- Type: string
The name of the stage.
Result Syntax
[]
Result Details
Errors
- ResourceInUse:
Resource being accessed is in use.
DeleteEndpoint
$result = $client->deleteEndpoint([/* ... */]); $promise = $client->deleteEndpointAsync([/* ... */]);
Deletes an endpoint. SageMaker frees up all of the resources that were deployed when the endpoint was created.
SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't need to use the RevokeGrant API call.
When you delete your endpoint, SageMaker asynchronously deletes associated endpoint resources such as KMS key grants. You might still see these resources in your account for a few minutes after deleting your endpoint. Do not delete or revoke the permissions for your ExecutionRoleArn , otherwise SageMaker cannot delete these resources.
Parameter Syntax
$result = $client->deleteEndpoint([
'EndpointName' => '', // REQUIRED
]);
Parameter Details
Members
- EndpointName
-
- Required: Yes
- Type: string
The name of the endpoint that you want to delete.
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DeleteEndpointConfig
$result = $client->deleteEndpointConfig([/* ... */]); $promise = $client->deleteEndpointConfigAsync([/* ... */]);
Deletes an endpoint configuration. The DeleteEndpointConfig API deletes only the specified configuration. It does not delete endpoints created using the configuration.
You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.
Parameter Syntax
$result = $client->deleteEndpointConfig([
'EndpointConfigName' => '', // REQUIRED
]);
Parameter Details
Members
- EndpointConfigName
-
- Required: Yes
- Type: string
The name of the endpoint configuration that you want to delete.
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DeleteExperiment
$result = $client->deleteExperiment([/* ... */]); $promise = $client->deleteExperimentAsync([/* ... */]);
Deletes an SageMaker experiment. All trials associated with the experiment must be deleted first. Use the ListTrials API to get a list of the trials associated with the experiment.
Parameter Syntax
$result = $client->deleteExperiment([
'ExperimentName' => '', // REQUIRED
]);
Parameter Details
Members
- ExperimentName
-
- Required: Yes
- Type: string
The name of the experiment to delete.
Result Syntax
[
'ExperimentArn' => '',
]
Result Details
Members
- ExperimentArn
-
- Type: string
The Amazon Resource Name (ARN) of the experiment that is being deleted.
Errors
- ResourceNotFound:
Resource being access is not found.
DeleteFeatureGroup
$result = $client->deleteFeatureGroup([/* ... */]); $promise = $client->deleteFeatureGroupAsync([/* ... */]);
Delete the FeatureGroup and any data that was written to the OnlineStore of the FeatureGroup. Data cannot be accessed from the OnlineStore immediately after DeleteFeatureGroup is called.
Data written into the OfflineStore will not be deleted. The Amazon Web Services Glue database and tables that are automatically created for your OfflineStore are not deleted.
Note that it can take approximately 10-15 minutes to delete an OnlineStore FeatureGroup with the InMemory StorageType.
Parameter Syntax
$result = $client->deleteFeatureGroup([
'FeatureGroupName' => '', // REQUIRED
]);
Parameter Details
Members
- FeatureGroupName
-
- Required: Yes
- Type: string
The name of the
FeatureGroupyou want to delete. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.
Result Syntax
[]
Result Details
Errors
- ResourceNotFound:
Resource being access is not found.
DeleteFlowDefinition
$result = $client->deleteFlowDefinition([/* ... */]); $promise = $client->deleteFlowDefinitionAsync([/* ... */]);
Deletes the specified flow definition.
Parameter Syntax
$result = $client->deleteFlowDefinition([
'FlowDefinitionName' => '', // REQUIRED
]);
Parameter Details
Members
- FlowDefinitionName
-
- Required: Yes
- Type: string
The name of the flow definition you are deleting.
Result Syntax
[]
Result Details
Errors
- ResourceNotFound:
Resource being access is not found.
- ResourceInUse:
Resource being accessed is in use.
DeleteHub
$result = $client->deleteHub([/* ... */]); $promise = $client->deleteHubAsync([/* ... */]);
Delete a hub.
Parameter Syntax
$result = $client->deleteHub([
'HubName' => '', // REQUIRED
]);
Parameter Details
Members
- HubName
-
- Required: Yes
- Type: string
The name of the hub to delete.
Result Syntax
[]
Result Details
Errors
- ResourceNotFound:
Resource being access is not found.
- ResourceInUse:
Resource being accessed is in use.
DeleteHubContent
$result = $client->deleteHubContent([/* ... */]); $promise = $client->deleteHubContentAsync([/* ... */]);
Delete the contents of a hub.
Parameter Syntax
$result = $client->deleteHubContent([
'HubContentName' => '', // REQUIRED
'HubContentType' => 'Model|Notebook|ModelReference|DataSet|JsonDoc', // REQUIRED
'HubContentVersion' => '', // REQUIRED
'HubName' => '', // REQUIRED
]);
Parameter Details
Members
- HubContentName
-
- Required: Yes
- Type: string
The name of the content that you want to delete from a hub.
- HubContentType
-
- Required: Yes
- Type: string
The type of content that you want to delete from a hub.
- HubContentVersion
-
- Required: Yes
- Type: string
The version of the content that you want to delete from a hub.
- HubName
-
- Required: Yes
- Type: string
The name of the hub that you want to delete content in.
Result Syntax
[]
Result Details
Errors
- ResourceNotFound:
Resource being access is not found.
- ResourceInUse:
Resource being accessed is in use.
DeleteHubContentReference
$result = $client->deleteHubContentReference([/* ... */]); $promise = $client->deleteHubContentReferenceAsync([/* ... */]);
Delete a hub content reference in order to remove a model from a private hub.
Parameter Syntax
$result = $client->deleteHubContentReference([
'HubContentName' => '', // REQUIRED
'HubContentType' => 'Model|Notebook|ModelReference|DataSet|JsonDoc', // REQUIRED
'HubName' => '', // REQUIRED
]);
Parameter Details
Members
- HubContentName
-
- Required: Yes
- Type: string
The name of the hub content to delete.
- HubContentType
-
- Required: Yes
- Type: string
The type of hub content reference to delete. The only supported type of hub content reference to delete is
ModelReference. - HubName
-
- Required: Yes
- Type: string
The name of the hub to delete the hub content reference from.
Result Syntax
[]
Result Details
Errors
- ResourceNotFound:
Resource being access is not found.
DeleteHumanTaskUi
$result = $client->deleteHumanTaskUi([/* ... */]); $promise = $client->deleteHumanTaskUiAsync([/* ... */]);
Use this operation to delete a human task user interface (worker task template).
To see a list of human task user interfaces (work task templates) in your account, use ListHumanTaskUis. When you delete a worker task template, it no longer appears when you call ListHumanTaskUis.
Parameter Syntax
$result = $client->deleteHumanTaskUi([
'HumanTaskUiName' => '', // REQUIRED
]);
Parameter Details
Members
- HumanTaskUiName
-
- Required: Yes
- Type: string
The name of the human task user interface (work task template) you want to delete.
Result Syntax
[]
Result Details
Errors
- ResourceNotFound:
Resource being access is not found.
DeleteHyperParameterTuningJob
$result = $client->deleteHyperParameterTuningJob([/* ... */]); $promise = $client->deleteHyperParameterTuningJobAsync([/* ... */]);
Deletes a hyperparameter tuning job. The DeleteHyperParameterTuningJob API deletes only the tuning job entry that was created in SageMaker when you called the CreateHyperParameterTuningJob API. It does not delete training jobs, artifacts, or the IAM role that you specified when creating the model.
Parameter Syntax
$result = $client->deleteHyperParameterTuningJob([
'HyperParameterTuningJobName' => '', // REQUIRED
]);
Parameter Details
Members
- HyperParameterTuningJobName
-
- Required: Yes
- Type: string
The name of the hyperparameter tuning job that you want to delete.
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DeleteImage
$result = $client->deleteImage([/* ... */]); $promise = $client->deleteImageAsync([/* ... */]);
Deletes a SageMaker AI image and all versions of the image. The container images aren't deleted.
Parameter Syntax
$result = $client->deleteImage([
'ImageName' => '', // REQUIRED
]);
Parameter Details
Members
- ImageName
-
- Required: Yes
- Type: string
The name of the image to delete.
Result Syntax
[]
Result Details
Errors
- ResourceNotFound:
Resource being access is not found.
- ResourceInUse:
Resource being accessed is in use.
DeleteImageVersion
$result = $client->deleteImageVersion([/* ... */]); $promise = $client->deleteImageVersionAsync([/* ... */]);
Deletes a version of a SageMaker AI image. The container image the version represents isn't deleted.
Parameter Syntax
$result = $client->deleteImageVersion([
'Alias' => '',
'ImageName' => '', // REQUIRED
'Version' => ,
]);
Parameter Details
Members
- Alias
-
- Type: string
The alias of the image to delete.
- ImageName
-
- Required: Yes
- Type: string
The name of the image to delete.
- Version
-
- Type: int
The version to delete.
Result Syntax
[]
Result Details
Errors
- ResourceNotFound:
Resource being access is not found.
- ResourceInUse:
Resource being accessed is in use.
DeleteInferenceComponent
$result = $client->deleteInferenceComponent([/* ... */]); $promise = $client->deleteInferenceComponentAsync([/* ... */]);
Deletes an inference component.
Parameter Syntax
$result = $client->deleteInferenceComponent([
'InferenceComponentName' => '', // REQUIRED
]);
Parameter Details
Members
- InferenceComponentName
-
- Required: Yes
- Type: string
The name of the inference component to delete.
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DeleteInferenceExperiment
$result = $client->deleteInferenceExperiment([/* ... */]); $promise = $client->deleteInferenceExperimentAsync([/* ... */]);
Deletes an inference experiment.
This operation does not delete your endpoint, variants, or any underlying resources. This operation only deletes the metadata of your experiment.
Parameter Syntax
$result = $client->deleteInferenceExperiment([
'Name' => '', // REQUIRED
]);
Parameter Details
Members
- Name
-
- Required: Yes
- Type: string
The name of the inference experiment you want to delete.
Result Syntax
[
'InferenceExperimentArn' => '',
]
Result Details
Members
- InferenceExperimentArn
-
- Required: Yes
- Type: string
The ARN of the deleted inference experiment.
Errors
- ConflictException:
There was a conflict when you attempted to modify a SageMaker entity such as an
ExperimentorArtifact.- ResourceNotFound:
Resource being access is not found.
DeleteJob
$result = $client->deleteJob([/* ... */]); $promise = $client->deleteJobAsync([/* ... */]);
Deletes a job. This operation is idempotent. If the job is currently running, you must stop it before deleting it by calling StopJob.
The following operations are related to DeleteJob:
-
CreateJob -
StopJob -
DescribeJob
Parameter Syntax
$result = $client->deleteJob([
'JobCategory' => 'AgentRFT|AgentRFTEvaluation', // REQUIRED
'JobName' => '', // REQUIRED
]);
Parameter Details
Members
- JobCategory
-
- Required: Yes
- Type: string
The category of the job to delete.
- JobName
-
- Required: Yes
- Type: string
The name of the job to delete.
Result Syntax
[]
Result Details
Errors
- ResourceNotFound:
Resource being access is not found.
- ResourceInUse:
Resource being accessed is in use.
DeleteMlflowApp
$result = $client->deleteMlflowApp([/* ... */]); $promise = $client->deleteMlflowAppAsync([/* ... */]);
Deletes an MLflow App.
Parameter Syntax
$result = $client->deleteMlflowApp([
'Arn' => '', // REQUIRED
]);
Parameter Details
Members
- Arn
-
- Required: Yes
- Type: string
The ARN of the MLflow App to delete.
Result Syntax
[
'Arn' => '',
]
Result Details
Members
- Arn
-
- Type: string
The ARN of the deleted MLflow App.
Errors
- ResourceNotFound:
Resource being access is not found.
DeleteMlflowTrackingServer
$result = $client->deleteMlflowTrackingServer([/* ... */]); $promise = $client->deleteMlflowTrackingServerAsync([/* ... */]);
Deletes an MLflow Tracking Server. For more information, see Clean up MLflow resources.
Parameter Syntax
$result = $client->deleteMlflowTrackingServer([
'TrackingServerName' => '', // REQUIRED
]);
Parameter Details
Members
- TrackingServerName
-
- Required: Yes
- Type: string
The name of the the tracking server to delete.
Result Syntax
[
'TrackingServerArn' => '',
]
Result Details
Members
- TrackingServerArn
-
- Type: string
A
TrackingServerArnobject, the ARN of the tracking server that is deleted if successfully found.
Errors
- ResourceNotFound:
Resource being access is not found.
DeleteModel
$result = $client->deleteModel([/* ... */]); $promise = $client->deleteModelAsync([/* ... */]);
Deletes a model. The DeleteModel API deletes only the model entry that was created in SageMaker when you called the CreateModel API. It does not delete model artifacts, inference code, or the IAM role that you specified when creating the model.
Parameter Syntax
$result = $client->deleteModel([
'ModelName' => '', // REQUIRED
]);
Parameter Details
Members
- ModelName
-
- Required: Yes
- Type: string
The name of the model to delete.
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DeleteModelBiasJobDefinition
$result = $client->deleteModelBiasJobDefinition([/* ... */]); $promise = $client->deleteModelBiasJobDefinitionAsync([/* ... */]);
Deletes an Amazon SageMaker AI model bias job definition.
Parameter Syntax
$result = $client->deleteModelBiasJobDefinition([
'JobDefinitionName' => '', // REQUIRED
]);
Parameter Details
Members
- JobDefinitionName
-
- Required: Yes
- Type: string
The name of the model bias job definition to delete.
Result Syntax
[]
Result Details
Errors
- ResourceNotFound:
Resource being access is not found.
DeleteModelCard
$result = $client->deleteModelCard([/* ... */]); $promise = $client->deleteModelCardAsync([/* ... */]);
Deletes an Amazon SageMaker Model Card.
Parameter Syntax
$result = $client->deleteModelCard([
'ModelCardName' => '', // REQUIRED
]);
Parameter Details
Members
- ModelCardName
-
- Required: Yes
- Type: string
The name of the model card to delete.
Result Syntax
[]
Result Details
Errors
- ConflictException:
There was a conflict when you attempted to modify a SageMaker entity such as an
ExperimentorArtifact.- ResourceNotFound:
Resource being access is not found.
DeleteModelExplainabilityJobDefinition
$result = $client->deleteModelExplainabilityJobDefinition([/* ... */]); $promise = $client->deleteModelExplainabilityJobDefinitionAsync([/* ... */]);
Deletes an Amazon SageMaker AI model explainability job definition.
Parameter Syntax
$result = $client->deleteModelExplainabilityJobDefinition([
'JobDefinitionName' => '', // REQUIRED
]);
Parameter Details
Members
- JobDefinitionName
-
- Required: Yes
- Type: string
The name of the model explainability job definition to delete.
Result Syntax
[]
Result Details
Errors
- ResourceNotFound:
Resource being access is not found.
DeleteModelPackage
$result = $client->deleteModelPackage([/* ... */]); $promise = $client->deleteModelPackageAsync([/* ... */]);
Deletes a model package.
A model package is used to create SageMaker models or list on Amazon Web Services Marketplace. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.
Parameter Syntax
$result = $client->deleteModelPackage([
'ModelPackageName' => '', // REQUIRED
]);
Parameter Details
Members
- ModelPackageName
-
- Required: Yes
- Type: string
The name or Amazon Resource Name (ARN) of the model package to delete.
When you specify a name, the name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
Result Syntax
[]
Result Details
Errors
- ConflictException:
There was a conflict when you attempted to modify a SageMaker entity such as an
ExperimentorArtifact.
DeleteModelPackageGroup
$result = $client->deleteModelPackageGroup([/* ... */]); $promise = $client->deleteModelPackageGroupAsync([/* ... */]);
Deletes the specified model group.
Parameter Syntax
$result = $client->deleteModelPackageGroup([
'ModelPackageGroupName' => '', // REQUIRED
]);
Parameter Details
Members
- ModelPackageGroupName
-
- Required: Yes
- Type: string
The name of the model group to delete.
Result Syntax
[]
Result Details
Errors
- ConflictException:
There was a conflict when you attempted to modify a SageMaker entity such as an
ExperimentorArtifact.
DeleteModelPackageGroupPolicy
$result = $client->deleteModelPackageGroupPolicy([/* ... */]); $promise = $client->deleteModelPackageGroupPolicyAsync([/* ... */]);
Deletes a model group resource policy.
Parameter Syntax
$result = $client->deleteModelPackageGroupPolicy([
'ModelPackageGroupName' => '', // REQUIRED
]);
Parameter Details
Members
- ModelPackageGroupName
-
- Required: Yes
- Type: string
The name of the model group for which to delete the policy.
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DeleteModelQualityJobDefinition
$result = $client->deleteModelQualityJobDefinition([/* ... */]); $promise = $client->deleteModelQualityJobDefinitionAsync([/* ... */]);
Deletes the secified model quality monitoring job definition.
Parameter Syntax
$result = $client->deleteModelQualityJobDefinition([
'JobDefinitionName' => '', // REQUIRED
]);
Parameter Details
Members
- JobDefinitionName
-
- Required: Yes
- Type: string
The name of the model quality monitoring job definition to delete.
Result Syntax
[]
Result Details
Errors
- ResourceNotFound:
Resource being access is not found.
DeleteMonitoringSchedule
$result = $client->deleteMonitoringSchedule([/* ... */]); $promise = $client->deleteMonitoringScheduleAsync([/* ... */]);
Deletes a monitoring schedule. Also stops the schedule had not already been stopped. This does not delete the job execution history of the monitoring schedule.
Parameter Syntax
$result = $client->deleteMonitoringSchedule([
'MonitoringScheduleName' => '', // REQUIRED
]);
Parameter Details
Members
- MonitoringScheduleName
-
- Required: Yes
- Type: string
The name of the monitoring schedule to delete.
Result Syntax
[]
Result Details
Errors
- ResourceNotFound:
Resource being access is not found.
DeleteNotebookInstance
$result = $client->deleteNotebookInstance([/* ... */]); $promise = $client->deleteNotebookInstanceAsync([/* ... */]);
Deletes an SageMaker AI notebook instance. Before you can delete a notebook instance, you must call the StopNotebookInstance API.
When you delete a notebook instance, you lose all of your data. SageMaker AI removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance.
Parameter Syntax
$result = $client->deleteNotebookInstance([
'NotebookInstanceName' => '', // REQUIRED
]);
Parameter Details
Members
- NotebookInstanceName
-
- Required: Yes
- Type: string
The name of the SageMaker AI notebook instance to delete.
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DeleteNotebookInstanceLifecycleConfig
$result = $client->deleteNotebookInstanceLifecycleConfig([/* ... */]); $promise = $client->deleteNotebookInstanceLifecycleConfigAsync([/* ... */]);
Deletes a notebook instance lifecycle configuration.
Parameter Syntax
$result = $client->deleteNotebookInstanceLifecycleConfig([
'NotebookInstanceLifecycleConfigName' => '', // REQUIRED
]);
Parameter Details
Members
- NotebookInstanceLifecycleConfigName
-
- Required: Yes
- Type: string
The name of the lifecycle configuration to delete.
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DeleteOptimizationJob
$result = $client->deleteOptimizationJob([/* ... */]); $promise = $client->deleteOptimizationJobAsync([/* ... */]);
Deletes an optimization job.
Parameter Syntax
$result = $client->deleteOptimizationJob([
'OptimizationJobName' => '', // REQUIRED
]);
Parameter Details
Members
- OptimizationJobName
-
- Required: Yes
- Type: string
The name that you assigned to the optimization job.
Result Syntax
[]
Result Details
Errors
- ResourceNotFound:
Resource being access is not found.
DeletePartnerApp
$result = $client->deletePartnerApp([/* ... */]); $promise = $client->deletePartnerAppAsync([/* ... */]);
Deletes a SageMaker Partner AI App.
Parameter Syntax
$result = $client->deletePartnerApp([
'Arn' => '', // REQUIRED
'ClientToken' => '',
]);
Parameter Details
Members
- Arn
-
- Required: Yes
- Type: string
The ARN of the SageMaker Partner AI App to delete.
- ClientToken
-
- Type: string
A unique token that guarantees that the call to this API is idempotent.
Result Syntax
[
'Arn' => '',
]
Result Details
Members
- Arn
-
- Type: string
The ARN of the SageMaker Partner AI App that was deleted.
Errors
- ConflictException:
There was a conflict when you attempted to modify a SageMaker entity such as an
ExperimentorArtifact.- ResourceNotFound:
Resource being access is not found.
DeletePipeline
$result = $client->deletePipeline([/* ... */]); $promise = $client->deletePipelineAsync([/* ... */]);
Deletes a pipeline if there are no running instances of the pipeline. To delete a pipeline, you must stop all running instances of the pipeline using the StopPipelineExecution API. When you delete a pipeline, all instances of the pipeline are deleted.
Parameter Syntax
$result = $client->deletePipeline([
'ClientRequestToken' => '', // REQUIRED
'PipelineName' => '', // REQUIRED
]);
Parameter Details
Members
- ClientRequestToken
-
- Required: Yes
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.
- PipelineName
-
- Required: Yes
- Type: string
The name of the pipeline to delete.
Result Syntax
[
'PipelineArn' => '',
]
Result Details
Members
- PipelineArn
-
- Type: string
The Amazon Resource Name (ARN) of the pipeline to delete.
Errors
- ConflictException:
There was a conflict when you attempted to modify a SageMaker entity such as an
ExperimentorArtifact.- ResourceNotFound:
Resource being access is not found.
DeleteProcessingJob
$result = $client->deleteProcessingJob([/* ... */]); $promise = $client->deleteProcessingJobAsync([/* ... */]);
Deletes a processing job. After Amazon SageMaker deletes a processing job, all of the metadata for the processing job is lost. You can delete only processing jobs that are in a terminal state (Stopped, Failed, or Completed). You cannot delete a job that is in the InProgress or Stopping state. After deleting the job, you can reuse its name to create another processing job.
Parameter Syntax
$result = $client->deleteProcessingJob([
'ProcessingJobName' => '', // REQUIRED
]);
Parameter Details
Members
- ProcessingJobName
-
- Required: Yes
- Type: string
The name of the processing job to delete.
Result Syntax
[]
Result Details
Errors
- ResourceNotFound:
Resource being access is not found.
- ResourceInUse:
Resource being accessed is in use.
DeleteProject
$result = $client->deleteProject([/* ... */]); $promise = $client->deleteProjectAsync([/* ... */]);
Delete the specified project.
Parameter Syntax
$result = $client->deleteProject([
'ProjectName' => '', // REQUIRED
]);
Parameter Details
Members
- ProjectName
-
- Required: Yes
- Type: string
The name of the project to delete.
Result Syntax
[]
Result Details
Errors
- ConflictException:
There was a conflict when you attempted to modify a SageMaker entity such as an
ExperimentorArtifact.
DeleteSpace
$result = $client->deleteSpace([/* ... */]); $promise = $client->deleteSpaceAsync([/* ... */]);
Used to delete a space.
Parameter Syntax
$result = $client->deleteSpace([
'DomainId' => '', // REQUIRED
'SpaceName' => '', // REQUIRED
]);
Parameter Details
Members
- DomainId
-
- Required: Yes
- Type: string
The ID of the associated domain.
- SpaceName
-
- Required: Yes
- Type: string
The name of the space.
Result Syntax
[]
Result Details
Errors
- ResourceNotFound:
Resource being access is not found.
- ResourceInUse:
Resource being accessed is in use.
DeleteStudioLifecycleConfig
$result = $client->deleteStudioLifecycleConfig([/* ... */]); $promise = $client->deleteStudioLifecycleConfigAsync([/* ... */]);
Deletes the Amazon SageMaker AI Studio Lifecycle Configuration. In order to delete the Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You must also remove the Lifecycle Configuration from UserSettings in all Domains and UserProfiles.
Parameter Syntax
$result = $client->deleteStudioLifecycleConfig([
'StudioLifecycleConfigName' => '', // REQUIRED
]);
Parameter Details
Members
- StudioLifecycleConfigName
-
- Required: Yes
- Type: string
The name of the Amazon SageMaker AI Studio Lifecycle Configuration to delete.
Result Syntax
[]
Result Details
Errors
- ResourceNotFound:
Resource being access is not found.
- ResourceInUse:
Resource being accessed is in use.
DeleteTags
$result = $client->deleteTags([/* ... */]); $promise = $client->deleteTagsAsync([/* ... */]);
Deletes the specified tags from an SageMaker resource.
To list a resource's tags, use the ListTags API.
When you call this API to delete tags from a hyperparameter tuning job, the deleted tags are not removed from training jobs that the hyperparameter tuning job launched before you called this API.
When you call this API to delete tags from a SageMaker Domain or User Profile, the deleted tags are not removed from Apps that the SageMaker Domain or User Profile launched before you called this API.
Parameter Syntax
$result = $client->deleteTags([
'ResourceArn' => '', // REQUIRED
'TagKeys' => ['', ...], // REQUIRED
]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource whose tags you want to delete.
- TagKeys
-
- Required: Yes
- Type: Array of strings
An array or one or more tag keys to delete.
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DeleteTrainingJob
$result = $client->deleteTrainingJob([/* ... */]); $promise = $client->deleteTrainingJobAsync([/* ... */]);
Deletes a training job. After SageMaker deletes a training job, all of the metadata for the training job is lost. You can delete only training jobs that are in a terminal state (Stopped, Failed, or Completed) and don't retain an Available managed warm pool. You cannot delete a job that is in the InProgress or Stopping state. After deleting the job, you can reuse its name to create another training job.
Parameter Syntax
$result = $client->deleteTrainingJob([
'TrainingJobName' => '', // REQUIRED
]);
Parameter Details
Members
- TrainingJobName
-
- Required: Yes
- Type: string
The name of the training job to delete.
Result Syntax
[]
Result Details
Errors
- ResourceNotFound:
Resource being access is not found.
- ResourceInUse:
Resource being accessed is in use.
DeleteTrial
$result = $client->deleteTrial([/* ... */]); $promise = $client->deleteTrialAsync([/* ... */]);
Deletes the specified trial. All trial components that make up the trial must be deleted first. Use the DescribeTrialComponent API to get the list of trial components.
Parameter Syntax
$result = $client->deleteTrial([
'TrialName' => '', // REQUIRED
]);
Parameter Details
Members
- TrialName
-
- Required: Yes
- Type: string
The name of the trial to delete.
Result Syntax
[
'TrialArn' => '',
]
Result Details
Members
- TrialArn
-
- Type: string
The Amazon Resource Name (ARN) of the trial that is being deleted.
Errors
- ResourceNotFound:
Resource being access is not found.
DeleteTrialComponent
$result = $client->deleteTrialComponent([/* ... */]); $promise = $client->deleteTrialComponentAsync([/* ... */]);
Deletes the specified trial component. A trial component must be disassociated from all trials before the trial component can be deleted. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.
Parameter Syntax
$result = $client->deleteTrialComponent([
'TrialComponentName' => '', // REQUIRED
]);
Parameter Details
Members
- TrialComponentName
-
- Required: Yes
- Type: string
The name of the component to delete.
Result Syntax
[
'TrialComponentArn' => '',
]
Result Details
Members
- TrialComponentArn
-
- Type: string
The Amazon Resource Name (ARN) of the component is being deleted.
Errors
- ResourceNotFound:
Resource being access is not found.
DeleteUserProfile
$result = $client->deleteUserProfile([/* ... */]); $promise = $client->deleteUserProfileAsync([/* ... */]);
Deletes a user profile. When a user profile is deleted, the user loses access to their EFS volume, including data, notebooks, and other artifacts.
Parameter Syntax
$result = $client->deleteUserProfile([
'DomainId' => '', // REQUIRED
'UserProfileName' => '', // REQUIRED
]);
Parameter Details
Members
- DomainId
-
- Required: Yes
- Type: string
The domain ID.
- UserProfileName
-
- Required: Yes
- Type: string
The user profile name.
Result Syntax
[]
Result Details
Errors
- ResourceNotFound:
Resource being access is not found.
- ResourceInUse:
Resource being accessed is in use.
DeleteWorkforce
$result = $client->deleteWorkforce([/* ... */]); $promise = $client->deleteWorkforceAsync([/* ... */]);
Use this operation to delete a workforce.
If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use this operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.
If a private workforce contains one or more work teams, you must use the DeleteWorkteam operation to delete all work teams before you delete the workforce. If you try to delete a workforce that contains one or more work teams, you will receive a ResourceInUse error.
Parameter Syntax
$result = $client->deleteWorkforce([
'WorkforceName' => '', // REQUIRED
]);
Parameter Details
Members
- WorkforceName
-
- Required: Yes
- Type: string
The name of the workforce.
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DeleteWorkteam
$result = $client->deleteWorkteam([/* ... */]); $promise = $client->deleteWorkteamAsync([/* ... */]);
Deletes an existing work team. This operation can't be undone.
Parameter Syntax
$result = $client->deleteWorkteam([
'WorkteamName' => '', // REQUIRED
]);
Parameter Details
Members
- WorkteamName
-
- Required: Yes
- Type: string
The name of the work team to delete.
Result Syntax
[
'Success' => true || false,
]
Result Details
Members
- Success
-
- Required: Yes
- Type: boolean
Returns
trueif the work team was successfully deleted; otherwise, returnsfalse.
Errors
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
DeregisterDevices
$result = $client->deregisterDevices([/* ... */]); $promise = $client->deregisterDevicesAsync([/* ... */]);
Deregisters the specified devices. After you deregister a device, you will need to re-register the devices.
Parameter Syntax
$result = $client->deregisterDevices([
'DeviceFleetName' => '', // REQUIRED
'DeviceNames' => ['', ...], // REQUIRED
]);
Parameter Details
Members
- DeviceFleetName
-
- Required: Yes
- Type: string
The name of the fleet the devices belong to.
- DeviceNames
-
- Required: Yes
- Type: Array of strings
The unique IDs of the devices.
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DescribeAIBenchmarkJob
$result = $client->describeAIBenchmarkJob([/* ... */]); $promise = $client->describeAIBenchmarkJobAsync([/* ... */]);
Returns details of an AI benchmark job, including its status, configuration, target endpoint, and timing information.
Parameter Syntax
$result = $client->describeAIBenchmarkJob([
'AIBenchmarkJobName' => '', // REQUIRED
]);
Parameter Details
Members
- AIBenchmarkJobName
-
- Required: Yes
- Type: string
The name of the AI benchmark job to describe.
Result Syntax
[
'AIBenchmarkJobArn' => '',
'AIBenchmarkJobName' => '',
'AIBenchmarkJobStatus' => 'InProgress|Completed|Failed|Stopping|Stopped',
'AIWorkloadConfigIdentifier' => '',
'BenchmarkTarget' => [
'Endpoint' => [
'Identifier' => '',
'InferenceComponents' => [
[
'Identifier' => '',
],
// ...
],
'TargetContainerHostname' => '',
],
],
'CreationTime' => ,
'EndTime' => ,
'FailureReason' => '',
'NetworkConfig' => [
'VpcConfig' => [
'SecurityGroupIds' => ['', ...],
'Subnets' => ['', ...],
],
],
'OutputConfig' => [
'CloudWatchLogs' => [
[
'LogGroupArn' => '',
'LogStreamName' => '',
],
// ...
],
'MlflowConfig' => [
'MlflowExperimentName' => '',
'MlflowResourceArn' => '',
'MlflowRunName' => '',
],
'S3OutputLocation' => '',
],
'RoleArn' => '',
'StartTime' => ,
'Tags' => [
[
'Key' => '',
'Value' => '',
],
// ...
],
]
Result Details
Members
- AIBenchmarkJobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the AI benchmark job.
- AIBenchmarkJobName
-
- Required: Yes
- Type: string
The name of the AI benchmark job.
- AIBenchmarkJobStatus
-
- Required: Yes
- Type: string
The status of the AI benchmark job.
- AIWorkloadConfigIdentifier
-
- Required: Yes
- Type: string
The name or Amazon Resource Name (ARN) of the AI workload configuration used for this benchmark job.
- BenchmarkTarget
-
- Required: Yes
- Type: AIBenchmarkTarget structure
The target endpoint that was benchmarked.
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that indicates when the benchmark job was created.
- EndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that indicates when the benchmark job completed.
- FailureReason
-
- Type: string
If the benchmark job failed, the reason it failed.
- NetworkConfig
-
- Type: AIBenchmarkNetworkConfig structure
The network configuration for the benchmark job.
- OutputConfig
-
- Required: Yes
- Type: AIBenchmarkOutputResult structure
The output configuration for the benchmark job, including the Amazon S3 output location and CloudWatch log information.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the IAM role used by the benchmark job.
- StartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that indicates when the benchmark job started running.
- Tags
-
- Type: Array of Tag structures
The tags associated with the benchmark job.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeAIRecommendationJob
$result = $client->describeAIRecommendationJob([/* ... */]); $promise = $client->describeAIRecommendationJobAsync([/* ... */]);
Returns details of an AI recommendation job, including its status, model source, performance targets, optimization recommendations, and deployment configurations.
Parameter Syntax
$result = $client->describeAIRecommendationJob([
'AIRecommendationJobName' => '', // REQUIRED
]);
Parameter Details
Members
- AIRecommendationJobName
-
- Required: Yes
- Type: string
The name of the AI recommendation job to describe.
Result Syntax
[
'AIRecommendationJobArn' => '',
'AIRecommendationJobName' => '',
'AIRecommendationJobStatus' => 'InProgress|Completed|Failed|Stopping|Stopped',
'AIWorkloadConfigIdentifier' => '',
'AdapterSource' => [
'ModelPackageArns' => [
[
'AdapterId' => '',
'ModelPackageArn' => '',
],
// ...
],
'S3Uris' => [
[
'AdapterId' => '',
'S3Uri' => '',
],
// ...
],
],
'ComputeSpec' => [
'CapacityReservationConfig' => [
'CapacityReservationPreference' => 'capacity-reservations-only',
'MlReservationArns' => ['', ...],
],
'InstanceTypes' => ['', ...],
],
'CreationTime' => ,
'EndTime' => ,
'FailureReason' => '',
'InferenceSpecification' => [
'Framework' => 'LMI|VLLM',
],
'ModelSource' => [
'S3' => [
'S3Uri' => '',
],
],
'OptimizeModel' => true || false,
'OutputConfig' => [
'MlflowConfig' => [
'MlflowExperimentName' => '',
'MlflowResourceArn' => '',
'MlflowRunName' => '',
],
'ModelPackageGroupIdentifier' => '',
'S3OutputLocation' => '',
],
'PerformanceTarget' => [
'Constraints' => [
[
'Metric' => 'ttft-ms|throughput|cost',
],
// ...
],
],
'Recommendations' => [
[
'AIBenchmarkJobArn' => '',
'AdapterDetails' => [
'ModelPackageArns' => [
[
'AdapterId' => '',
'ModelPackageArn' => '',
],
// ...
],
'S3Uris' => [
[
'AdapterId' => '',
'S3Uri' => '',
],
// ...
],
],
'DeploymentConfiguration' => [
'CopyCountPerInstance' => ,
'EnvironmentVariables' => ['', ...],
'ImageUri' => '',
'InstanceCount' => ,
'InstanceType' => 'ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.4xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge',
'MinCpuMemoryRequiredInMb' => ,
'S3' => [
[
'ChannelName' => '',
'Uri' => '',
],
// ...
],
],
'ExpectedPerformance' => [
[
'Metric' => '',
'Stat' => '',
'Unit' => '',
'Value' => '',
],
// ...
],
'ModelDetails' => [
'InferenceSpecificationName' => '',
'InstanceDetails' => [
[
'CopyCountPerInstance' => ,
'InstanceCount' => ,
'InstanceType' => 'ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.4xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge',
],
// ...
],
'ModelPackageArn' => '',
],
'OptimizationDetails' => [
[
'OptimizationConfig' => ['', ...],
'OptimizationType' => 'SpeculativeDecoding|KernelTuning',
],
// ...
],
'RecommendationDescription' => '',
],
// ...
],
'RoleArn' => '',
'StartTime' => ,
'Tags' => [
[
'Key' => '',
'Value' => '',
],
// ...
],
]
Result Details
Members
- AIRecommendationJobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the AI recommendation job.
- AIRecommendationJobName
-
- Required: Yes
- Type: string
The name of the AI recommendation job.
- AIRecommendationJobStatus
-
- Required: Yes
- Type: string
The status of the AI recommendation job.
- AIWorkloadConfigIdentifier
-
- Required: Yes
- Type: string
The name or Amazon Resource Name (ARN) of the AI workload configuration used for this recommendation job.
- AdapterSource
-
- Type: AIAdapterSource structure
The LoRA adapter source that you specified when you created the recommendation job. This field is absent when you created the job without LoRA adapters.
- ComputeSpec
-
- Type: AIRecommendationComputeSpec structure
The compute resource specification for the recommendation job.
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that indicates when the recommendation job was created.
- EndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that indicates when the recommendation job completed.
- FailureReason
-
- Type: string
If the recommendation job failed, the reason it failed.
- InferenceSpecification
-
- Type: AIRecommendationInferenceSpecification structure
The inference framework configuration.
- ModelSource
-
- Required: Yes
- Type: AIModelSource structure
The source of the model that was analyzed.
- OptimizeModel
-
- Type: boolean
Whether model optimization techniques were allowed.
- OutputConfig
-
- Required: Yes
- Type: AIRecommendationOutputResult structure
The output configuration for the recommendation job.
- PerformanceTarget
-
- Type: AIRecommendationPerformanceTarget structure
The performance targets specified for the recommendation job.
- Recommendations
-
- Type: Array of AIRecommendation structures
The list of optimization recommendations generated by the job. Each recommendation includes optimization details, deployment configuration, expected performance metrics, and the associated benchmark job ARN.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the IAM role used by the recommendation job.
- StartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that indicates when the recommendation job started running.
- Tags
-
- Type: Array of Tag structures
The tags associated with the recommendation job.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeAIWorkloadConfig
$result = $client->describeAIWorkloadConfig([/* ... */]); $promise = $client->describeAIWorkloadConfigAsync([/* ... */]);
Returns details of an AI workload configuration, including the dataset configuration, benchmark tool settings, tags, and creation time.
Parameter Syntax
$result = $client->describeAIWorkloadConfig([
'AIWorkloadConfigName' => '', // REQUIRED
]);
Parameter Details
Members
- AIWorkloadConfigName
-
- Required: Yes
- Type: string
The name of the AI workload configuration to describe.
Result Syntax
[
'AIWorkloadConfigArn' => '',
'AIWorkloadConfigName' => '',
'AIWorkloadConfigs' => [
'WorkloadSpec' => [
'Inline' => '',
],
],
'CreationTime' => ,
'DatasetConfig' => [
'InputDataConfig' => [
[
'ChannelName' => '',
'DataSource' => [
'S3DataSource' => [
'S3Uri' => '',
],
],
],
// ...
],
],
'Tags' => [
[
'Key' => '',
'Value' => '',
],
// ...
],
]
Result Details
Members
- AIWorkloadConfigArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the AI workload configuration.
- AIWorkloadConfigName
-
- Required: Yes
- Type: string
The name of the AI workload configuration.
- AIWorkloadConfigs
-
- Type: AIWorkloadConfigs structure
The benchmark tool configuration and workload specification.
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that indicates when the AI workload configuration was created.
- DatasetConfig
-
- Type: AIDatasetConfig structure
The dataset configuration for the workload.
- Tags
-
- Type: Array of Tag structures
The tags associated with the AI workload configuration.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeAction
$result = $client->describeAction([/* ... */]); $promise = $client->describeActionAsync([/* ... */]);
Describes an action.
Parameter Syntax
$result = $client->describeAction([
'ActionName' => '', // REQUIRED
]);
Parameter Details
Members
- ActionName
-
- Required: Yes
- Type: string
The name of the action to describe.
Result Syntax
[
'ActionArn' => '',
'ActionName' => '',
'ActionType' => '',
'CreatedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'CreationTime' => ,
'Description' => '',
'LastModifiedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'LastModifiedTime' => ,
'LineageGroupArn' => '',
'MetadataProperties' => [
'CommitId' => '',
'GeneratedBy' => '',
'ProjectId' => '',
'Repository' => '',
],
'Properties' => ['', ...],
'Source' => [
'SourceId' => '',
'SourceType' => '',
'SourceUri' => '',
],
'Status' => 'Unknown|InProgress|Completed|Failed|Stopping|Stopped',
]
Result Details
Members
- ActionArn
-
- Type: string
The Amazon Resource Name (ARN) of the action.
- ActionName
-
- Type: string
The name of the action.
- ActionType
-
- Type: string
The type of the action.
- CreatedBy
-
- Type: UserContext structure
Information about the user who created or modified a SageMaker resource.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the action was created.
- Description
-
- Type: string
The description of the action.
- LastModifiedBy
-
- Type: UserContext structure
Information about the user who created or modified a SageMaker resource.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the action was last modified.
- LineageGroupArn
-
- Type: string
The Amazon Resource Name (ARN) of the lineage group.
- MetadataProperties
-
- Type: MetadataProperties structure
Metadata properties of the tracking entity, trial, or trial component.
- Properties
-
- Type: Associative array of custom strings keys (StringParameterValue) to strings
A list of the action's properties.
- Source
-
- Type: ActionSource structure
The source of the action.
- Status
-
- Type: string
The status of the action.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeAlgorithm
$result = $client->describeAlgorithm([/* ... */]); $promise = $client->describeAlgorithmAsync([/* ... */]);
Returns a description of the specified algorithm that is in your account.
Parameter Syntax
$result = $client->describeAlgorithm([
'AlgorithmName' => '', // REQUIRED
]);
Parameter Details
Members
- AlgorithmName
-
- Required: Yes
- Type: string
The name of the algorithm to describe.
Result Syntax
[
'AlgorithmArn' => '',
'AlgorithmDescription' => '',
'AlgorithmName' => '',
'AlgorithmStatus' => 'Pending|InProgress|Completed|Failed|Deleting',
'AlgorithmStatusDetails' => [
'ImageScanStatuses' => [
[
'FailureReason' => '',
'Name' => '',
'Status' => 'NotStarted|InProgress|Completed|Failed',
],
// ...
],
'ValidationStatuses' => [
[
'FailureReason' => '',
'Name' => '',
'Status' => 'NotStarted|InProgress|Completed|Failed',
],
// ...
],
],
'CertifyForMarketplace' => true || false,
'CreationTime' => ,
'InferenceSpecification' => [
'Containers' => [
[
'AdditionalModelDataSources' => [
[
'ChannelName' => '',
'S3DataSource' => [
'CompressionType' => 'None|Gzip',
'ETag' => '',
'HubAccessConfig' => [
'HubContentArn' => '',
],
'ManifestEtag' => '',
'ManifestS3Uri' => '',
'ModelAccessConfig' => [
'AcceptEula' => true || false,
],
'S3DataType' => 'S3Prefix|S3Object',
'S3Uri' => '',
],
],
// ...
],
'AdditionalS3DataSource' => [
'CompressionType' => 'None|Gzip',
'ETag' => '',
'S3DataType' => 'S3Object|S3Prefix',
'S3Uri' => '',
],
'BaseModel' => [
'HubContentName' => '',
'HubContentVersion' => '',
'RecipeName' => '',
],
'ContainerHostname' => '',
'Environment' => ['', ...],
'Framework' => '',
'FrameworkVersion' => '',
'Image' => '',
'ImageDigest' => '',
'IsCheckpoint' => true || false,
'ModelDataETag' => '',
'ModelDataSource' => [
'S3DataSource' => [
'CompressionType' => 'None|Gzip',
'ETag' => '',
'HubAccessConfig' => [
'HubContentArn' => '',
],
'ManifestEtag' => '',
'ManifestS3Uri' => '',
'ModelAccessConfig' => [
'AcceptEula' => true || false,
],
'S3DataType' => 'S3Prefix|S3Object',
'S3Uri' => '',
],
],
'ModelDataUrl' => '',
'ModelInput' => [
'DataInputConfig' => '',
],
'NearestModelName' => '',
'ProductId' => '',
],
// ...
],
'SupportedContentTypes' => ['', ...],
'SupportedRealtimeInferenceInstanceTypes' => ['', ...],
'SupportedResponseMIMETypes' => ['', ...],
'SupportedTransformInstanceTypes' => ['', ...],
],
'ProductId' => '',
'TrainingSpecification' => [
'AdditionalS3DataSource' => [
'CompressionType' => 'None|Gzip',
'ETag' => '',
'S3DataType' => 'S3Object|S3Prefix',
'S3Uri' => '',
],
'MetricDefinitions' => [
[
'Name' => '',
'Regex' => '',
],
// ...
],
'SupportedHyperParameters' => [
[
'DefaultValue' => '',
'Description' => '',
'IsRequired' => true || false,
'IsTunable' => true || false,
'Name' => '',
'Range' => [
'CategoricalParameterRangeSpecification' => [
'Values' => ['', ...],
],
'ContinuousParameterRangeSpecification' => [
'MaxValue' => '',
'MinValue' => '',
],
'IntegerParameterRangeSpecification' => [
'MaxValue' => '',
'MinValue' => '',
],
],
'Type' => 'Integer|Continuous|Categorical|FreeText',
],
// ...
],
'SupportedTrainingInstanceTypes' => ['', ...],
'SupportedTuningJobObjectiveMetrics' => [
[
'MetricName' => '',
'Type' => 'Maximize|Minimize',
],
// ...
],
'SupportsDistributedTraining' => true || false,
'TrainingChannels' => [
[
'Description' => '',
'IsRequired' => true || false,
'Name' => '',
'SupportedCompressionTypes' => ['', ...],
'SupportedContentTypes' => ['', ...],
'SupportedInputModes' => ['', ...],
],
// ...
],
'TrainingImage' => '',
'TrainingImageDigest' => '',
],
'ValidationSpecification' => [
'ValidationProfiles' => [
[
'ProfileName' => '',
'TrainingJobDefinition' => [
'HyperParameters' => ['', ...],
'InputDataConfig' => [
[
'ChannelName' => '',
'CompressionType' => 'None|Gzip',
'ContentType' => '',
'DataSource' => [
'DatasetSource' => [
'DatasetArn' => '',
],
'FileSystemDataSource' => [
'DirectoryPath' => '',
'FileSystemAccessMode' => 'rw|ro',
'FileSystemId' => '',
'FileSystemType' => 'EFS|FSxLustre',
],
'S3DataSource' => [
'AttributeNames' => ['', ...],
'HubAccessConfig' => [
'HubContentArn' => '',
],
'InstanceGroupNames' => ['', ...],
'ModelAccessConfig' => [
'AcceptEula' => true || false,
],
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile|Converse',
'S3Uri' => '',
],
],
'InputMode' => 'Pipe|File|FastFile',
'RecordWrapperType' => 'None|RecordIO',
'ShuffleConfig' => [
'Seed' => ,
],
],
// ...
],
'OutputDataConfig' => [
'CompressionType' => 'GZIP|NONE',
'KmsKeyId' => '',
'S3OutputPath' => '',
],
'ResourceConfig' => [
'InstanceCount' => ,
'InstanceGroups' => [
[
'InstanceCount' => ,
'InstanceGroupName' => '',
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
],
// ...
],
'InstancePlacementConfig' => [
'EnableMultipleJobs' => true || false,
'PlacementSpecifications' => [
[
'InstanceCount' => ,
'UltraServerId' => '',
],
// ...
],
],
'InstancePreferences' => [
[
'InstanceCount' => ,
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'TrainingPlanArns' => ['', ...],
],
// ...
],
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'KeepAlivePeriodInSeconds' => ,
'SelectedInstanceCount' => ,
'SelectedInstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'TrainingPlanArn' => '',
'VolumeKmsKeyId' => '',
'VolumeSizeInGB' => ,
],
'StoppingCondition' => [
'MaxPendingTimeInSeconds' => ,
'MaxRuntimeInSeconds' => ,
'MaxWaitTimeInSeconds' => ,
],
'TrainingInputMode' => 'Pipe|File|FastFile',
],
'TransformJobDefinition' => [
'BatchStrategy' => 'MultiRecord|SingleRecord',
'Environment' => ['', ...],
'MaxConcurrentTransforms' => ,
'MaxPayloadInMB' => ,
'TransformInput' => [
'CompressionType' => 'None|Gzip',
'ContentType' => '',
'DataSource' => [
'S3DataSource' => [
'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile|Converse',
'S3Uri' => '',
],
],
'SplitType' => 'None|Line|RecordIO|TFRecord',
],
'TransformOutput' => [
'Accept' => '',
'AssembleWith' => 'None|Line',
'KmsKeyId' => '',
'S3OutputPath' => '',
],
'TransformResources' => [
'InstanceCount' => ,
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge',
'TransformAmiVersion' => '',
'VolumeKmsKeyId' => '',
],
],
],
// ...
],
'ValidationRole' => '',
],
]
Result Details
Members
- AlgorithmArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the algorithm.
- AlgorithmDescription
-
- Type: string
A brief summary about the algorithm.
- AlgorithmName
-
- Required: Yes
- Type: string
The name of the algorithm being described.
- AlgorithmStatus
-
- Required: Yes
- Type: string
The current status of the algorithm.
- AlgorithmStatusDetails
-
- Required: Yes
- Type: AlgorithmStatusDetails structure
Details about the current status of the algorithm.
- CertifyForMarketplace
-
- Type: boolean
Whether the algorithm is certified to be listed in Amazon Web Services Marketplace.
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp specifying when the algorithm was created.
- InferenceSpecification
-
- Type: InferenceSpecification structure
Details about inference jobs that the algorithm runs.
- ProductId
-
- Type: string
The product identifier of the algorithm.
- TrainingSpecification
-
- Required: Yes
- Type: TrainingSpecification structure
Details about training jobs run by this algorithm.
- ValidationSpecification
-
- Type: AlgorithmValidationSpecification structure
Details about configurations for one or more training jobs that SageMaker runs to test the algorithm.
Errors
There are no errors described for this operation.
DescribeApp
$result = $client->describeApp([/* ... */]); $promise = $client->describeAppAsync([/* ... */]);
Describes the app.
Parameter Syntax
$result = $client->describeApp([
'AppName' => '', // REQUIRED
'AppType' => 'JupyterServer|KernelGateway|DetailedProfiler|TensorBoard|CodeEditor|JupyterLab|RStudioServerPro|RSessionGateway|Canvas', // REQUIRED
'DomainId' => '', // REQUIRED
'SpaceName' => '',
'UserProfileName' => '',
]);
Parameter Details
Members
- AppName
-
- Required: Yes
- Type: string
The name of the app.
- AppType
-
- Required: Yes
- Type: string
The type of app.
- DomainId
-
- Required: Yes
- Type: string
The domain ID.
- SpaceName
-
- Type: string
The name of the space.
- UserProfileName
-
- Type: string
The user profile name. If this value is not set, then
SpaceNamemust be set.
Result Syntax
[
'AppArn' => '',
'AppName' => '',
'AppType' => 'JupyterServer|KernelGateway|DetailedProfiler|TensorBoard|CodeEditor|JupyterLab|RStudioServerPro|RSessionGateway|Canvas',
'BuiltInLifecycleConfigArn' => '',
'CreationTime' => ,
'DomainId' => '',
'EffectiveTrustedIdentityPropagationStatus' => 'ENABLED|DISABLED',
'FailureReason' => '',
'LastHealthCheckTimestamp' => ,
'LastUserActivityTimestamp' => ,
'RecoveryMode' => true || false,
'ResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
'SpaceName' => '',
'Status' => 'Deleted|Deleting|Failed|InService|Pending',
'UserProfileName' => '',
]
Result Details
Members
- AppArn
-
- Type: string
The Amazon Resource Name (ARN) of the app.
- AppName
-
- Type: string
The name of the app.
- AppType
-
- Type: string
The type of app.
- BuiltInLifecycleConfigArn
-
- Type: string
The lifecycle configuration that runs before the default lifecycle configuration
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation time of the application.
After an application has been shut down for 24 hours, SageMaker AI deletes all metadata for the application. To be considered an update and retain application metadata, applications must be restarted within 24 hours after the previous application has been shut down. After this time window, creation of an application is considered a new application rather than an update of the previous application.
- DomainId
-
- Type: string
The domain ID.
- EffectiveTrustedIdentityPropagationStatus
-
- Type: string
The effective status of Trusted Identity Propagation (TIP) for this application. When enabled, user identities from IAM Identity Center are being propagated through the application to TIP enabled Amazon Web Services services. When disabled, standard IAM role-based access is used.
- FailureReason
-
- Type: string
The failure reason.
- LastHealthCheckTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the last health check.
- LastUserActivityTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the last user's activity.
LastUserActivityTimestampis also updated when SageMaker AI performs health checks without user activity. As a result, this value is set to the same value asLastHealthCheckTimestamp. - RecoveryMode
-
- Type: boolean
Indicates whether the application is launched in recovery mode.
- ResourceSpec
-
- Type: ResourceSpec structure
The instance type and the Amazon Resource Name (ARN) of the SageMaker AI image created on the instance.
- SpaceName
-
- Type: string
The name of the space. If this value is not set, then
UserProfileNamemust be set. - Status
-
- Type: string
The status.
- UserProfileName
-
- Type: string
The user profile name.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeAppImageConfig
$result = $client->describeAppImageConfig([/* ... */]); $promise = $client->describeAppImageConfigAsync([/* ... */]);
Describes an AppImageConfig.
Parameter Syntax
$result = $client->describeAppImageConfig([
'AppImageConfigName' => '', // REQUIRED
]);
Parameter Details
Members
- AppImageConfigName
-
- Required: Yes
- Type: string
The name of the AppImageConfig to describe.
Result Syntax
[
'AppImageConfigArn' => '',
'AppImageConfigName' => '',
'CodeEditorAppImageConfig' => [
'ContainerConfig' => [
'ContainerArguments' => ['', ...],
'ContainerEntrypoint' => ['', ...],
'ContainerEnvironmentVariables' => ['', ...],
],
'FileSystemConfig' => [
'DefaultGid' => ,
'DefaultUid' => ,
'MountPath' => '',
],
],
'CreationTime' => ,
'JupyterLabAppImageConfig' => [
'ContainerConfig' => [
'ContainerArguments' => ['', ...],
'ContainerEntrypoint' => ['', ...],
'ContainerEnvironmentVariables' => ['', ...],
],
'FileSystemConfig' => [
'DefaultGid' => ,
'DefaultUid' => ,
'MountPath' => '',
],
],
'KernelGatewayImageConfig' => [
'FileSystemConfig' => [
'DefaultGid' => ,
'DefaultUid' => ,
'MountPath' => '',
],
'KernelSpecs' => [
[
'DisplayName' => '',
'Name' => '',
],
// ...
],
],
'LastModifiedTime' => ,
]
Result Details
Members
- AppImageConfigArn
-
- Type: string
The ARN of the AppImageConfig.
- AppImageConfigName
-
- Type: string
The name of the AppImageConfig.
- CodeEditorAppImageConfig
-
- Type: CodeEditorAppImageConfig structure
The configuration of the Code Editor app.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the AppImageConfig was created.
- JupyterLabAppImageConfig
-
- Type: JupyterLabAppImageConfig structure
The configuration of the JupyterLab app.
- KernelGatewayImageConfig
-
- Type: KernelGatewayImageConfig structure
The configuration of a KernelGateway app.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the AppImageConfig was last modified.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeArtifact
$result = $client->describeArtifact([/* ... */]); $promise = $client->describeArtifactAsync([/* ... */]);
Describes an artifact.
Parameter Syntax
$result = $client->describeArtifact([
'ArtifactArn' => '', // REQUIRED
]);
Parameter Details
Members
- ArtifactArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the artifact to describe.
Result Syntax
[
'ArtifactArn' => '',
'ArtifactName' => '',
'ArtifactType' => '',
'CreatedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'CreationTime' => ,
'LastModifiedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'LastModifiedTime' => ,
'LineageGroupArn' => '',
'MetadataProperties' => [
'CommitId' => '',
'GeneratedBy' => '',
'ProjectId' => '',
'Repository' => '',
],
'Properties' => ['', ...],
'Source' => [
'SourceTypes' => [
[
'SourceIdType' => 'MD5Hash|S3ETag|S3Version|Custom',
'Value' => '',
],
// ...
],
'SourceUri' => '',
],
]
Result Details
Members
- ArtifactArn
-
- Type: string
The Amazon Resource Name (ARN) of the artifact.
- ArtifactName
-
- Type: string
The name of the artifact.
- ArtifactType
-
- Type: string
The type of the artifact.
- CreatedBy
-
- Type: UserContext structure
Information about the user who created or modified a SageMaker resource.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the artifact was created.
- LastModifiedBy
-
- Type: UserContext structure
Information about the user who created or modified a SageMaker resource.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the artifact was last modified.
- LineageGroupArn
-
- Type: string
The Amazon Resource Name (ARN) of the lineage group.
- MetadataProperties
-
- Type: MetadataProperties structure
Metadata properties of the tracking entity, trial, or trial component.
- Properties
-
- Type: Associative array of custom strings keys (StringParameterValue) to strings
A list of the artifact's properties.
- Source
-
- Type: ArtifactSource structure
The source of the artifact.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeAutoMLJob
$result = $client->describeAutoMLJob([/* ... */]); $promise = $client->describeAutoMLJobAsync([/* ... */]);
Returns information about an AutoML job created by calling CreateAutoMLJob.
AutoML jobs created by calling CreateAutoMLJobV2 cannot be described by DescribeAutoMLJob.
Parameter Syntax
$result = $client->describeAutoMLJob([
'AutoMLJobName' => '', // REQUIRED
]);
Parameter Details
Members
- AutoMLJobName
-
- Required: Yes
- Type: string
Requests information about an AutoML job using its unique name.
Result Syntax
[
'AutoMLJobArn' => '',
'AutoMLJobArtifacts' => [
'CandidateDefinitionNotebookLocation' => '',
'DataExplorationNotebookLocation' => '',
],
'AutoMLJobConfig' => [
'CandidateGenerationConfig' => [
'AlgorithmsConfig' => [
[
'AutoMLAlgorithms' => ['', ...],
],
// ...
],
'FeatureSpecificationS3Uri' => '',
],
'CompletionCriteria' => [
'MaxAutoMLJobRuntimeInSeconds' => ,
'MaxCandidates' => ,
'MaxRuntimePerTrainingJobInSeconds' => ,
],
'DataSplitConfig' => [
'ValidationFraction' => ,
],
'Mode' => 'AUTO|ENSEMBLING|HYPERPARAMETER_TUNING',
'SecurityConfig' => [
'EnableInterContainerTrafficEncryption' => true || false,
'VolumeKmsKeyId' => '',
'VpcConfig' => [
'SecurityGroupIds' => ['', ...],
'Subnets' => ['', ...],
],
],
],
'AutoMLJobName' => '',
'AutoMLJobObjective' => [
'MetricName' => 'Accuracy|MSE|F1|F1macro|AUC|RMSE|BalancedAccuracy|R2|Recall|RecallMacro|Precision|PrecisionMacro|MAE|MAPE|MASE|WAPE|AverageWeightedQuantileLoss',
],
'AutoMLJobSecondaryStatus' => 'Starting|MaxCandidatesReached|Failed|Stopped|MaxAutoMLJobRuntimeReached|Stopping|CandidateDefinitionsGenerated|Completed|ExplainabilityError|DeployingModel|ModelDeploymentError|GeneratingModelInsightsReport|ModelInsightsError|AnalyzingData|FeatureEngineering|ModelTuning|GeneratingExplainabilityReport|TrainingModels|PreTraining',
'AutoMLJobStatus' => 'Completed|InProgress|Failed|Stopped|Stopping',
'BestCandidate' => [
'CandidateName' => '',
'CandidateProperties' => [
'CandidateArtifactLocations' => [
'BacktestResults' => '',
'Explainability' => '',
'ModelInsights' => '',
],
'CandidateMetrics' => [
[
'MetricName' => 'Accuracy|MSE|F1|F1macro|AUC|RMSE|BalancedAccuracy|R2|Recall|RecallMacro|Precision|PrecisionMacro|MAE|MAPE|MASE|WAPE|AverageWeightedQuantileLoss',
'Set' => 'Train|Validation|Test',
'StandardMetricName' => 'Accuracy|MSE|F1|F1macro|AUC|RMSE|MAE|R2|BalancedAccuracy|Precision|PrecisionMacro|Recall|RecallMacro|LogLoss|InferenceLatency|MAPE|MASE|WAPE|AverageWeightedQuantileLoss|Rouge1|Rouge2|RougeL|RougeLSum|Perplexity|ValidationLoss|TrainingLoss',
'Value' => ,
],
// ...
],
],
'CandidateStatus' => 'Completed|InProgress|Failed|Stopped|Stopping',
'CandidateSteps' => [
[
'CandidateStepArn' => '',
'CandidateStepName' => '',
'CandidateStepType' => 'AWS::SageMaker::TrainingJob|AWS::SageMaker::TransformJob|AWS::SageMaker::ProcessingJob',
],
// ...
],
'CreationTime' => ,
'EndTime' => ,
'FailureReason' => '',
'FinalAutoMLJobObjectiveMetric' => [
'MetricName' => 'Accuracy|MSE|F1|F1macro|AUC|RMSE|BalancedAccuracy|R2|Recall|RecallMacro|Precision|PrecisionMacro|MAE|MAPE|MASE|WAPE|AverageWeightedQuantileLoss',
'StandardMetricName' => 'Accuracy|MSE|F1|F1macro|AUC|RMSE|BalancedAccuracy|R2|Recall|RecallMacro|Precision|PrecisionMacro|MAE|MAPE|MASE|WAPE|AverageWeightedQuantileLoss',
'Type' => 'Maximize|Minimize',
'Value' => ,
],
'InferenceContainerDefinitions' => [
'' => [
[
'Environment' => ['', ...],
'Image' => '',
'ModelDataUrl' => '',
],
// ...
],
// ...
],
'InferenceContainers' => [
[
'Environment' => ['', ...],
'Image' => '',
'ModelDataUrl' => '',
],
// ...
],
'LastModifiedTime' => ,
'ObjectiveStatus' => 'Succeeded|Pending|Failed',
],
'CreationTime' => ,
'EndTime' => ,
'FailureReason' => '',
'GenerateCandidateDefinitionsOnly' => true || false,
'InputDataConfig' => [
[
'ChannelType' => 'training|validation',
'CompressionType' => 'None|Gzip',
'ContentType' => '',
'DataSource' => [
'S3DataSource' => [
'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile',
'S3Uri' => '',
],
],
'SampleWeightAttributeName' => '',
'TargetAttributeName' => '',
],
// ...
],
'LastModifiedTime' => ,
'ModelDeployConfig' => [
'AutoGenerateEndpointName' => true || false,
'EndpointName' => '',
],
'ModelDeployResult' => [
'EndpointName' => '',
],
'OutputDataConfig' => [
'KmsKeyId' => '',
'S3OutputPath' => '',
],
'PartialFailureReasons' => [
[
'PartialFailureMessage' => '',
],
// ...
],
'ProblemType' => 'BinaryClassification|MulticlassClassification|Regression',
'ResolvedAttributes' => [
'AutoMLJobObjective' => [
'MetricName' => 'Accuracy|MSE|F1|F1macro|AUC|RMSE|BalancedAccuracy|R2|Recall|RecallMacro|Precision|PrecisionMacro|MAE|MAPE|MASE|WAPE|AverageWeightedQuantileLoss',
],
'CompletionCriteria' => [
'MaxAutoMLJobRuntimeInSeconds' => ,
'MaxCandidates' => ,
'MaxRuntimePerTrainingJobInSeconds' => ,
],
'ProblemType' => 'BinaryClassification|MulticlassClassification|Regression',
],
'RoleArn' => '',
]
Result Details
Members
- AutoMLJobArn
-
- Required: Yes
- Type: string
Returns the ARN of the AutoML job.
- AutoMLJobArtifacts
-
- Type: AutoMLJobArtifacts structure
Returns information on the job's artifacts found in
AutoMLJobArtifacts. - AutoMLJobConfig
-
- Type: AutoMLJobConfig structure
Returns the configuration for the AutoML job.
- AutoMLJobName
-
- Required: Yes
- Type: string
Returns the name of the AutoML job.
- AutoMLJobObjective
-
- Type: AutoMLJobObjective structure
Returns the job's objective.
- AutoMLJobSecondaryStatus
-
- Required: Yes
- Type: string
Returns the secondary status of the AutoML job.
- AutoMLJobStatus
-
- Required: Yes
- Type: string
Returns the status of the AutoML job.
- BestCandidate
-
- Type: AutoMLCandidate structure
The best model candidate selected by SageMaker AI Autopilot using both the best objective metric and lowest InferenceLatency for an experiment.
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Returns the creation time of the AutoML job.
- EndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Returns the end time of the AutoML job.
- FailureReason
-
- Type: string
Returns the failure reason for an AutoML job, when applicable.
- GenerateCandidateDefinitionsOnly
-
- Type: boolean
Indicates whether the output for an AutoML job generates candidate definitions only.
- InputDataConfig
-
- Required: Yes
- Type: Array of AutoMLChannel structures
Returns the input data configuration for the AutoML job.
- LastModifiedTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Returns the job's last modified time.
- ModelDeployConfig
-
- Type: ModelDeployConfig structure
Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.
- ModelDeployResult
-
- Type: ModelDeployResult structure
Provides information about endpoint for the model deployment.
- OutputDataConfig
-
- Required: Yes
- Type: AutoMLOutputDataConfig structure
Returns the job's output data config.
- PartialFailureReasons
-
- Type: Array of AutoMLPartialFailureReason structures
Returns a list of reasons for partial failures within an AutoML job.
- ProblemType
-
- Type: string
Returns the job's problem type.
- ResolvedAttributes
-
- Type: ResolvedAttributes structure
Contains
ProblemType,AutoMLJobObjective, andCompletionCriteria. If you do not provide these values, they are inferred. - RoleArn
-
- Required: Yes
- Type: string
The ARN of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeAutoMLJobV2
$result = $client->describeAutoMLJobV2([/* ... */]); $promise = $client->describeAutoMLJobV2Async([/* ... */]);
Returns information about an AutoML job created by calling CreateAutoMLJobV2 or CreateAutoMLJob.
Parameter Syntax
$result = $client->describeAutoMLJobV2([
'AutoMLJobName' => '', // REQUIRED
]);
Parameter Details
Members
- AutoMLJobName
-
- Required: Yes
- Type: string
Requests information about an AutoML job V2 using its unique name.
Result Syntax
[
'AutoMLComputeConfig' => [
'EmrServerlessComputeConfig' => [
'ExecutionRoleARN' => '',
],
],
'AutoMLJobArn' => '',
'AutoMLJobArtifacts' => [
'CandidateDefinitionNotebookLocation' => '',
'DataExplorationNotebookLocation' => '',
],
'AutoMLJobInputDataConfig' => [
[
'ChannelType' => 'training|validation',
'CompressionType' => 'None|Gzip',
'ContentType' => '',
'DataSource' => [
'S3DataSource' => [
'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile',
'S3Uri' => '',
],
],
],
// ...
],
'AutoMLJobName' => '',
'AutoMLJobObjective' => [
'MetricName' => 'Accuracy|MSE|F1|F1macro|AUC|RMSE|BalancedAccuracy|R2|Recall|RecallMacro|Precision|PrecisionMacro|MAE|MAPE|MASE|WAPE|AverageWeightedQuantileLoss',
],
'AutoMLJobSecondaryStatus' => 'Starting|MaxCandidatesReached|Failed|Stopped|MaxAutoMLJobRuntimeReached|Stopping|CandidateDefinitionsGenerated|Completed|ExplainabilityError|DeployingModel|ModelDeploymentError|GeneratingModelInsightsReport|ModelInsightsError|AnalyzingData|FeatureEngineering|ModelTuning|GeneratingExplainabilityReport|TrainingModels|PreTraining',
'AutoMLJobStatus' => 'Completed|InProgress|Failed|Stopped|Stopping',
'AutoMLProblemTypeConfig' => [
'ImageClassificationJobConfig' => [
'CompletionCriteria' => [
'MaxAutoMLJobRuntimeInSeconds' => ,
'MaxCandidates' => ,
'MaxRuntimePerTrainingJobInSeconds' => ,
],
],
'TabularJobConfig' => [
'CandidateGenerationConfig' => [
'AlgorithmsConfig' => [
[
'AutoMLAlgorithms' => ['', ...],
],
// ...
],
],
'CompletionCriteria' => [
'MaxAutoMLJobRuntimeInSeconds' => ,
'MaxCandidates' => ,
'MaxRuntimePerTrainingJobInSeconds' => ,
],
'FeatureSpecificationS3Uri' => '',
'GenerateCandidateDefinitionsOnly' => true || false,
'Mode' => 'AUTO|ENSEMBLING|HYPERPARAMETER_TUNING',
'ProblemType' => 'BinaryClassification|MulticlassClassification|Regression',
'SampleWeightAttributeName' => '',
'TargetAttributeName' => '',
],
'TextClassificationJobConfig' => [
'CompletionCriteria' => [
'MaxAutoMLJobRuntimeInSeconds' => ,
'MaxCandidates' => ,
'MaxRuntimePerTrainingJobInSeconds' => ,
],
'ContentColumn' => '',
'TargetLabelColumn' => '',
],
'TextGenerationJobConfig' => [
'BaseModelName' => '',
'CompletionCriteria' => [
'MaxAutoMLJobRuntimeInSeconds' => ,
'MaxCandidates' => ,
'MaxRuntimePerTrainingJobInSeconds' => ,
],
'ModelAccessConfig' => [
'AcceptEula' => true || false,
],
'TextGenerationHyperParameters' => ['', ...],
],
'TimeSeriesForecastingJobConfig' => [
'CandidateGenerationConfig' => [
'AlgorithmsConfig' => [
[
'AutoMLAlgorithms' => ['', ...],
],
// ...
],
],
'CompletionCriteria' => [
'MaxAutoMLJobRuntimeInSeconds' => ,
'MaxCandidates' => ,
'MaxRuntimePerTrainingJobInSeconds' => ,
],
'FeatureSpecificationS3Uri' => '',
'ForecastFrequency' => '',
'ForecastHorizon' => ,
'ForecastQuantiles' => ['', ...],
'HolidayConfig' => [
[
'CountryCode' => '',
],
// ...
],
'TimeSeriesConfig' => [
'GroupingAttributeNames' => ['', ...],
'ItemIdentifierAttributeName' => '',
'TargetAttributeName' => '',
'TimestampAttributeName' => '',
],
'Transformations' => [
'Aggregation' => ['', ...],
'Filling' => [
'' => ['', ...],
// ...
],
],
],
],
'AutoMLProblemTypeConfigName' => 'ImageClassification|TextClassification|TimeSeriesForecasting|Tabular|TextGeneration',
'BestCandidate' => [
'CandidateName' => '',
'CandidateProperties' => [
'CandidateArtifactLocations' => [
'BacktestResults' => '',
'Explainability' => '',
'ModelInsights' => '',
],
'CandidateMetrics' => [
[
'MetricName' => 'Accuracy|MSE|F1|F1macro|AUC|RMSE|BalancedAccuracy|R2|Recall|RecallMacro|Precision|PrecisionMacro|MAE|MAPE|MASE|WAPE|AverageWeightedQuantileLoss',
'Set' => 'Train|Validation|Test',
'StandardMetricName' => 'Accuracy|MSE|F1|F1macro|AUC|RMSE|MAE|R2|BalancedAccuracy|Precision|PrecisionMacro|Recall|RecallMacro|LogLoss|InferenceLatency|MAPE|MASE|WAPE|AverageWeightedQuantileLoss|Rouge1|Rouge2|RougeL|RougeLSum|Perplexity|ValidationLoss|TrainingLoss',
'Value' => ,
],
// ...
],
],
'CandidateStatus' => 'Completed|InProgress|Failed|Stopped|Stopping',
'CandidateSteps' => [
[
'CandidateStepArn' => '',
'CandidateStepName' => '',
'CandidateStepType' => 'AWS::SageMaker::TrainingJob|AWS::SageMaker::TransformJob|AWS::SageMaker::ProcessingJob',
],
// ...
],
'CreationTime' => ,
'EndTime' => ,
'FailureReason' => '',
'FinalAutoMLJobObjectiveMetric' => [
'MetricName' => 'Accuracy|MSE|F1|F1macro|AUC|RMSE|BalancedAccuracy|R2|Recall|RecallMacro|Precision|PrecisionMacro|MAE|MAPE|MASE|WAPE|AverageWeightedQuantileLoss',
'StandardMetricName' => 'Accuracy|MSE|F1|F1macro|AUC|RMSE|BalancedAccuracy|R2|Recall|RecallMacro|Precision|PrecisionMacro|MAE|MAPE|MASE|WAPE|AverageWeightedQuantileLoss',
'Type' => 'Maximize|Minimize',
'Value' => ,
],
'InferenceContainerDefinitions' => [
'' => [
[
'Environment' => ['', ...],
'Image' => '',
'ModelDataUrl' => '',
],
// ...
],
// ...
],
'InferenceContainers' => [
[
'Environment' => ['', ...],
'Image' => '',
'ModelDataUrl' => '',
],
// ...
],
'LastModifiedTime' => ,
'ObjectiveStatus' => 'Succeeded|Pending|Failed',
],
'CreationTime' => ,
'DataSplitConfig' => [
'ValidationFraction' => ,
],
'EndTime' => ,
'FailureReason' => '',
'LastModifiedTime' => ,
'ModelDeployConfig' => [
'AutoGenerateEndpointName' => true || false,
'EndpointName' => '',
],
'ModelDeployResult' => [
'EndpointName' => '',
],
'OutputDataConfig' => [
'KmsKeyId' => '',
'S3OutputPath' => '',
],
'PartialFailureReasons' => [
[
'PartialFailureMessage' => '',
],
// ...
],
'ResolvedAttributes' => [
'AutoMLJobObjective' => [
'MetricName' => 'Accuracy|MSE|F1|F1macro|AUC|RMSE|BalancedAccuracy|R2|Recall|RecallMacro|Precision|PrecisionMacro|MAE|MAPE|MASE|WAPE|AverageWeightedQuantileLoss',
],
'AutoMLProblemTypeResolvedAttributes' => [
'TabularResolvedAttributes' => [
'ProblemType' => 'BinaryClassification|MulticlassClassification|Regression',
],
'TextGenerationResolvedAttributes' => [
'BaseModelName' => '',
],
],
'CompletionCriteria' => [
'MaxAutoMLJobRuntimeInSeconds' => ,
'MaxCandidates' => ,
'MaxRuntimePerTrainingJobInSeconds' => ,
],
],
'RoleArn' => '',
'SecurityConfig' => [
'EnableInterContainerTrafficEncryption' => true || false,
'VolumeKmsKeyId' => '',
'VpcConfig' => [
'SecurityGroupIds' => ['', ...],
'Subnets' => ['', ...],
],
],
]
Result Details
Members
- AutoMLComputeConfig
-
- Type: AutoMLComputeConfig structure
The compute configuration used for the AutoML job V2.
- AutoMLJobArn
-
- Required: Yes
- Type: string
Returns the Amazon Resource Name (ARN) of the AutoML job V2.
- AutoMLJobArtifacts
-
- Type: AutoMLJobArtifacts structure
The artifacts that are generated during an AutoML job.
- AutoMLJobInputDataConfig
-
- Required: Yes
- Type: Array of AutoMLJobChannel structures
Returns an array of channel objects describing the input data and their location.
- AutoMLJobName
-
- Required: Yes
- Type: string
Returns the name of the AutoML job V2.
- AutoMLJobObjective
-
- Type: AutoMLJobObjective structure
Returns the job's objective.
- AutoMLJobSecondaryStatus
-
- Required: Yes
- Type: string
Returns the secondary status of the AutoML job V2.
- AutoMLJobStatus
-
- Required: Yes
- Type: string
Returns the status of the AutoML job V2.
- AutoMLProblemTypeConfig
-
- Type: AutoMLProblemTypeConfig structure
Returns the configuration settings of the problem type set for the AutoML job V2.
- AutoMLProblemTypeConfigName
-
- Type: string
Returns the name of the problem type configuration set for the AutoML job V2.
- BestCandidate
-
- Type: AutoMLCandidate structure
Information about the candidate produced by an AutoML training job V2, including its status, steps, and other properties.
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Returns the creation time of the AutoML job V2.
- DataSplitConfig
-
- Type: AutoMLDataSplitConfig structure
Returns the configuration settings of how the data are split into train and validation datasets.
- EndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Returns the end time of the AutoML job V2.
- FailureReason
-
- Type: string
Returns the reason for the failure of the AutoML job V2, when applicable.
- LastModifiedTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Returns the job's last modified time.
- ModelDeployConfig
-
- Type: ModelDeployConfig structure
Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.
- ModelDeployResult
-
- Type: ModelDeployResult structure
Provides information about endpoint for the model deployment.
- OutputDataConfig
-
- Required: Yes
- Type: AutoMLOutputDataConfig structure
Returns the job's output data config.
- PartialFailureReasons
-
- Type: Array of AutoMLPartialFailureReason structures
Returns a list of reasons for partial failures within an AutoML job V2.
- ResolvedAttributes
-
- Type: AutoMLResolvedAttributes structure
Returns the resolved attributes used by the AutoML job V2.
- RoleArn
-
- Required: Yes
- Type: string
The ARN of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.
- SecurityConfig
-
- Type: AutoMLSecurityConfig structure
Returns the security configuration for traffic encryption or Amazon VPC settings.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeCluster
$result = $client->describeCluster([/* ... */]); $promise = $client->describeClusterAsync([/* ... */]);
Retrieves information of a SageMaker HyperPod cluster.
Parameter Syntax
$result = $client->describeCluster([
'ClusterName' => '', // REQUIRED
]);
Parameter Details
Members
- ClusterName
-
- Required: Yes
- Type: string
The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.
Result Syntax
[
'AutoScaling' => [
'AutoScalerType' => 'Karpenter',
'FailureMessage' => '',
'Mode' => 'Enable|Disable',
'Status' => 'InService|Failed|Creating|Deleting',
],
'ClusterArn' => '',
'ClusterName' => '',
'ClusterRole' => '',
'ClusterStatus' => 'Creating|Deleting|Failed|InService|RollingBack|SystemUpdating|Updating',
'CreationTime' => ,
'FailureMessage' => '',
'InstanceGroups' => [
[
'ActiveOperations' => [, ...],
'ActiveSoftwareUpdateConfig' => [
'AutoRollbackConfiguration' => [
[
'AlarmName' => '',
],
// ...
],
'RollingUpdatePolicy' => [
'MaximumBatchSize' => [
'Type' => 'INSTANCE_COUNT|CAPACITY_PERCENTAGE',
'Value' => ,
],
'RollbackMaximumBatchSize' => [
'Type' => 'INSTANCE_COUNT|CAPACITY_PERCENTAGE',
'Value' => ,
],
],
'WaitIntervalInSeconds' => ,
],
'AutoPatchConfig' => [
'CurrentPatchSchedule' => [
'NextPatchDate' => ,
],
'DeploymentConfig' => [
'AutoRollbackConfiguration' => [
[
'AlarmName' => '',
],
// ...
],
'RollingUpdatePolicy' => [
'MaximumBatchSize' => [
'Type' => 'INSTANCE_COUNT|CAPACITY_PERCENTAGE',
'Value' => ,
],
'RollbackMaximumBatchSize' => [
'Type' => 'INSTANCE_COUNT|CAPACITY_PERCENTAGE',
'Value' => ,
],
],
'WaitIntervalInSeconds' => ,
],
'DesiredPatchSchedule' => [
'NextPatchDate' => ,
],
'PatchingStrategy' => 'WhenIdle|WhenAllIdle',
],
'CapacityRequirements' => [
'OnDemand' => [
],
'Spot' => [
],
],
'CurrentCount' => ,
'CurrentImageId' => '',
'CurrentImageReleaseVersion' => '',
'DesiredImageId' => '',
'DesiredImageReleaseVersion' => '',
'ExecutionRole' => '',
'ImageVersionStatus' => 'UpToDate|UpdateAvailable|SecurityUpdateRequired|EndOfLife',
'InstanceGroupName' => '',
'InstanceRequirements' => [
'CurrentInstanceTypes' => ['', ...],
'DesiredInstanceTypes' => ['', ...],
],
'InstanceStorageConfigs' => [
[
'EbsVolumeConfig' => [
'RootVolume' => true || false,
'VolumeKmsKeyId' => '',
'VolumeSizeInGB' => ,
],
'FsxLustreConfig' => [
'DnsName' => '',
'MountName' => '',
'MountPath' => '',
],
'FsxOpenZfsConfig' => [
'DnsName' => '',
'MountPath' => '',
],
],
// ...
],
'InstanceType' => 'ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5.4xlarge|ml.p6e-gb200.36xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.c5n.large|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.gr6.4xlarge|ml.gr6.8xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.trn2.3xlarge|ml.trn2.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.i3en.large|ml.i3en.xlarge|ml.i3en.2xlarge|ml.i3en.3xlarge|ml.i3en.6xlarge|ml.i3en.12xlarge|ml.i3en.24xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.r5d.16xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.p6-b300.48xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.c6g.medium|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c7g.medium|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.c6a.large|ml.c6a.xlarge|ml.c6a.2xlarge|ml.c6a.4xlarge|ml.c6a.8xlarge|ml.c6a.12xlarge|ml.c6a.16xlarge|ml.c6a.24xlarge|ml.c6a.32xlarge|ml.c6a.48xlarge|ml.m6a.large|ml.m6a.xlarge|ml.m6a.2xlarge|ml.m6a.4xlarge|ml.m6a.8xlarge|ml.m6a.12xlarge|ml.m6a.16xlarge|ml.m6a.24xlarge|ml.m6a.32xlarge|ml.m6a.48xlarge|ml.m6g.medium|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m7g.medium|ml.m7g.large|ml.m7g.xlarge|ml.m7g.2xlarge|ml.m7g.4xlarge|ml.m7g.8xlarge|ml.m7g.12xlarge|ml.m7g.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.c8a.16xlarge|ml.m8a.16xlarge',
'InstanceTypeDetails' => [
[
'CurrentCount' => ,
'InstanceType' => 'ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5.4xlarge|ml.p6e-gb200.36xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.c5n.large|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.gr6.4xlarge|ml.gr6.8xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.trn2.3xlarge|ml.trn2.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.i3en.large|ml.i3en.xlarge|ml.i3en.2xlarge|ml.i3en.3xlarge|ml.i3en.6xlarge|ml.i3en.12xlarge|ml.i3en.24xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.r5d.16xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.p6-b300.48xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.c6g.medium|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c7g.medium|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.c6a.large|ml.c6a.xlarge|ml.c6a.2xlarge|ml.c6a.4xlarge|ml.c6a.8xlarge|ml.c6a.12xlarge|ml.c6a.16xlarge|ml.c6a.24xlarge|ml.c6a.32xlarge|ml.c6a.48xlarge|ml.m6a.large|ml.m6a.xlarge|ml.m6a.2xlarge|ml.m6a.4xlarge|ml.m6a.8xlarge|ml.m6a.12xlarge|ml.m6a.16xlarge|ml.m6a.24xlarge|ml.m6a.32xlarge|ml.m6a.48xlarge|ml.m6g.medium|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m7g.medium|ml.m7g.large|ml.m7g.xlarge|ml.m7g.2xlarge|ml.m7g.4xlarge|ml.m7g.8xlarge|ml.m7g.12xlarge|ml.m7g.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.c8a.16xlarge|ml.m8a.16xlarge',
'ThreadsPerCore' => ,
],
// ...
],
'KubernetesConfig' => [
'CurrentLabels' => ['', ...],
'CurrentTaints' => [
[
'Effect' => 'NoSchedule|PreferNoSchedule|NoExecute',
'Key' => '',
'Value' => '',
],
// ...
],
'DesiredLabels' => ['', ...],
'DesiredTaints' => [
[
'Effect' => 'NoSchedule|PreferNoSchedule|NoExecute',
'Key' => '',
'Value' => '',
],
// ...
],
],
'LifeCycleConfig' => [
'OnCreate' => '',
'OnInitComplete' => '',
'SourceS3Uri' => '',
],
'MinCount' => ,
'NetworkInterface' => [
'InterfaceType' => 'efa|efa-only',
],
'OnStartDeepHealthChecks' => ['', ...],
'OverrideVpcConfig' => [
'SecurityGroupIds' => ['', ...],
'Subnets' => ['', ...],
],
'ScheduledUpdateConfig' => [
'DeploymentConfig' => [
'AutoRollbackConfiguration' => [
[
'AlarmName' => '',
],
// ...
],
'RollingUpdatePolicy' => [
'MaximumBatchSize' => [
'Type' => 'INSTANCE_COUNT|CAPACITY_PERCENTAGE',
'Value' => ,
],
'RollbackMaximumBatchSize' => [
'Type' => 'INSTANCE_COUNT|CAPACITY_PERCENTAGE',
'Value' => ,
],
],
'WaitIntervalInSeconds' => ,
],
'ScheduleExpression' => '',
],
'SlurmConfig' => [
'NodeType' => 'Controller|Login|Compute',
'PartitionNames' => ['', ...],
],
'SoftwareUpdateStatus' => 'Pending|InProgress|Succeeded|Failed|RollbackInProgress|RollbackComplete',
'Status' => 'InService|Creating|Updating|Failed|Degraded|SystemUpdating|Deleting',
'TargetCount' => ,
'TargetStateCount' => ,
'ThreadsPerCore' => ,
'TrainingPlanArn' => '',
'TrainingPlanStatus' => '',
],
// ...
],
'NodeProvisioningMode' => 'Continuous',
'NodeRecovery' => 'Automatic|None',
'Orchestrator' => [
'Eks' => [
'ClusterArn' => '',
],
'Slurm' => [
'AccountingDatabase' => [
'Endpoint' => '',
'Name' => '',
'Port' => ,
'SecretArn' => '',
],
'SlurmConfigStrategy' => 'Overwrite|Managed|Merge',
],
],
'RestrictedInstanceGroups' => [
[
'CurrentCount' => ,
'EnvironmentConfig' => [
'FSxLustreConfig' => [
'PerUnitStorageThroughput' => ,
'SizeInGiB' => ,
],
'S3OutputPath' => '',
],
'ExecutionRole' => '',
'InstanceGroupName' => '',
'InstanceStorageConfigs' => [
[
'EbsVolumeConfig' => [
'RootVolume' => true || false,
'VolumeKmsKeyId' => '',
'VolumeSizeInGB' => ,
],
'FsxLustreConfig' => [
'DnsName' => '',
'MountName' => '',
'MountPath' => '',
],
'FsxOpenZfsConfig' => [
'DnsName' => '',
'MountPath' => '',
],
],
// ...
],
'InstanceType' => 'ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5.4xlarge|ml.p6e-gb200.36xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.c5n.large|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.gr6.4xlarge|ml.gr6.8xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.trn2.3xlarge|ml.trn2.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.i3en.large|ml.i3en.xlarge|ml.i3en.2xlarge|ml.i3en.3xlarge|ml.i3en.6xlarge|ml.i3en.12xlarge|ml.i3en.24xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.r5d.16xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.p6-b300.48xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.c6g.medium|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c7g.medium|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.c6a.large|ml.c6a.xlarge|ml.c6a.2xlarge|ml.c6a.4xlarge|ml.c6a.8xlarge|ml.c6a.12xlarge|ml.c6a.16xlarge|ml.c6a.24xlarge|ml.c6a.32xlarge|ml.c6a.48xlarge|ml.m6a.large|ml.m6a.xlarge|ml.m6a.2xlarge|ml.m6a.4xlarge|ml.m6a.8xlarge|ml.m6a.12xlarge|ml.m6a.16xlarge|ml.m6a.24xlarge|ml.m6a.32xlarge|ml.m6a.48xlarge|ml.m6g.medium|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m7g.medium|ml.m7g.large|ml.m7g.xlarge|ml.m7g.2xlarge|ml.m7g.4xlarge|ml.m7g.8xlarge|ml.m7g.12xlarge|ml.m7g.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.c8a.16xlarge|ml.m8a.16xlarge',
'OnStartDeepHealthChecks' => ['', ...],
'OverrideVpcConfig' => [
'SecurityGroupIds' => ['', ...],
'Subnets' => ['', ...],
],
'ScheduledUpdateConfig' => [
'DeploymentConfig' => [
'AutoRollbackConfiguration' => [
[
'AlarmName' => '',
],
// ...
],
'RollingUpdatePolicy' => [
'MaximumBatchSize' => [
'Type' => 'INSTANCE_COUNT|CAPACITY_PERCENTAGE',
'Value' => ,
],
'RollbackMaximumBatchSize' => [
'Type' => 'INSTANCE_COUNT|CAPACITY_PERCENTAGE',
'Value' => ,
],
],
'WaitIntervalInSeconds' => ,
],
'ScheduleExpression' => '',
],
'Status' => 'InService|Creating|Updating|Failed|Degraded|SystemUpdating|Deleting',
'TargetCount' => ,
'ThreadsPerCore' => ,
'TrainingPlanArn' => '',
'TrainingPlanStatus' => '',
],
// ...
],
'RestrictedInstanceGroupsConfig' => [
'SharedEnvironmentConfig' => [
'CurrentFSxLustreConfig' => [
'PerUnitStorageThroughput' => ,
'SizeInGiB' => ,
],
'CurrentFSxLustreDeletionPolicy' => 'DeleteIfNotUsed|Keep',
'DesiredFSxLustreConfig' => [
'PerUnitStorageThroughput' => ,
'SizeInGiB' => ,
],
'DesiredFSxLustreDeletionPolicy' => 'DeleteIfNotUsed|Keep',
],
],
'TieredStorageConfig' => [
'InstanceMemoryAllocationPercentage' => ,
'Mode' => 'Enable|Disable',
],
'VpcConfig' => [
'SecurityGroupIds' => ['', ...],
'Subnets' => ['', ...],
],
]
Result Details
Members
- AutoScaling
-
- Type: ClusterAutoScalingConfigOutput structure
The current autoscaling configuration and status for the autoscaler.
- ClusterArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.
- ClusterName
-
- Type: string
The name of the SageMaker HyperPod cluster.
- ClusterRole
-
- Type: string
The Amazon Resource Name (ARN) of the IAM role that HyperPod uses for cluster autoscaling operations.
- ClusterStatus
-
- Required: Yes
- Type: string
The status of the SageMaker HyperPod cluster.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the SageMaker Cluster is created.
- FailureMessage
-
- Type: string
The failure message of the SageMaker HyperPod cluster.
- InstanceGroups
-
- Required: Yes
- Type: Array of ClusterInstanceGroupDetails structures
The instance groups of the SageMaker HyperPod cluster.
- NodeProvisioningMode
-
- Type: string
The mode used for provisioning nodes in the cluster.
- NodeRecovery
-
- Type: string
The node recovery mode configured for the SageMaker HyperPod cluster.
- Orchestrator
-
- Type: ClusterOrchestrator structure
The type of orchestrator used for the SageMaker HyperPod cluster.
- RestrictedInstanceGroups
-
- Type: Array of ClusterRestrictedInstanceGroupDetails structures
The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.
- RestrictedInstanceGroupsConfig
-
- Type: ClusterRestrictedInstanceGroupsConfigOutput structure
The configuration for the restricted instance groups (RIG) in the SageMaker HyperPod cluster.
- TieredStorageConfig
-
- Type: ClusterTieredStorageConfig structure
The current configuration for managed tier checkpointing on the HyperPod cluster. For example, this shows whether the feature is enabled and the percentage of cluster memory allocated for checkpoint storage.
- VpcConfig
-
- Type: VpcConfig structure
Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeClusterEvent
$result = $client->describeClusterEvent([/* ... */]); $promise = $client->describeClusterEventAsync([/* ... */]);
Retrieves detailed information about a specific event for a given HyperPod cluster. This functionality is only supported when the NodeProvisioningMode is set to Continuous.
Parameter Syntax
$result = $client->describeClusterEvent([
'ClusterName' => '', // REQUIRED
'EventId' => '', // REQUIRED
]);
Parameter Details
Members
- ClusterName
-
- Required: Yes
- Type: string
The name or Amazon Resource Name (ARN) of the HyperPod cluster associated with the event.
- EventId
-
- Required: Yes
- Type: string
The unique identifier (UUID) of the event to describe. This ID can be obtained from the
ListClusterEventsoperation.
Result Syntax
[
'EventDetails' => [
'ClusterArn' => '',
'ClusterName' => '',
'Description' => '',
'EventDetails' => [
'EventMetadata' => [
'Cluster' => [
'EksRoleAccessEntries' => ['', ...],
'FailureMessage' => '',
'SlrAccessEntry' => '',
],
'DatabaseConfiguration' => [
'Advisory' => '',
'FailureMessage' => '',
'RollbackStatus' => 'NotApplicable|Reverted|RevertFailed',
],
'Instance' => [
'AdditionalEnis' => [
'EfaEnis' => ['', ...],
],
'CapacityReservation' => [
'Arn' => '',
'Type' => 'ODCR|CRG',
],
'CustomerEni' => '',
'FailureMessage' => '',
'InstanceRequirementsEniConfigurations' => [
[
'AdditionalEnis' => [
'EfaEnis' => ['', ...],
],
'CustomerEni' => '',
],
// ...
],
'LcsExecutionState' => '',
'NodeLogicalId' => '',
],
'InstanceGroup' => [
'AmiOverride' => '',
'AvailabilityZoneId' => '',
'CapacityReservation' => [
'Arn' => '',
'Type' => 'ODCR|CRG',
],
'FailureMessage' => '',
'SecurityGroupIds' => ['', ...],
'SubnetId' => '',
],
'InstanceGroupScaling' => [
'FailureMessage' => '',
'InstanceCount' => ,
'MinCount' => ,
'TargetCount' => ,
],
'SlurmHealth' => [
'Component' => 'Slurmdbd',
'Reason' => 'DaemonDown|DaemonDisabled|DbUnreachable',
'Status' => 'Healthy|Unhealthy',
],
],
],
'EventId' => '',
'EventLevel' => 'Info|Warn|Error',
'EventTime' => ,
'InstanceGroupName' => '',
'InstanceId' => '',
'ResourceType' => 'Cluster|InstanceGroup|Instance',
],
]
Result Details
Members
- EventDetails
-
- Type: ClusterEventDetail structure
Detailed information about the requested cluster event, including event metadata for various resource types such as
Cluster,InstanceGroup,Instance, and their associated attributes.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeClusterNode
$result = $client->describeClusterNode([/* ... */]); $promise = $client->describeClusterNodeAsync([/* ... */]);
Retrieves information of a node (also called a instance interchangeably) of a SageMaker HyperPod cluster.
Parameter Syntax
$result = $client->describeClusterNode([
'ClusterName' => '', // REQUIRED
'NodeId' => '',
'NodeLogicalId' => '',
]);
Parameter Details
Members
- ClusterName
-
- Required: Yes
- Type: string
The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which the node is.
- NodeId
-
- Type: string
The ID of the SageMaker HyperPod cluster node.
- NodeLogicalId
-
- Type: string
The logical identifier of the node to describe. You can specify either
NodeLogicalIdorInstanceId, but not both.NodeLogicalIdcan be used to describe nodes that are still being provisioned and don't yet have anInstanceIdassigned.
Result Syntax
[
'NodeDetails' => [
'CapacityType' => 'Spot|OnDemand',
'CurrentImageId' => '',
'CurrentImageReleaseVersion' => '',
'DesiredImageId' => '',
'DesiredImageReleaseVersion' => '',
'ImageVersionStatus' => 'UpToDate|UpdateAvailable|SecurityUpdateRequired|EndOfLife',
'InstanceGroupName' => '',
'InstanceId' => '',
'InstanceStatus' => [
'Message' => '',
'Status' => 'Running|Failure|Pending|ShuttingDown|SystemUpdating|DeepHealthCheckInProgress|NotFound',
],
'InstanceStorageConfigs' => [
[
'EbsVolumeConfig' => [
'RootVolume' => true || false,
'VolumeKmsKeyId' => '',
'VolumeSizeInGB' => ,
],
'FsxLustreConfig' => [
'DnsName' => '',
'MountName' => '',
'MountPath' => '',
],
'FsxOpenZfsConfig' => [
'DnsName' => '',
'MountPath' => '',
],
],
// ...
],
'InstanceType' => 'ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5.4xlarge|ml.p6e-gb200.36xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.c5n.large|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.gr6.4xlarge|ml.gr6.8xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.trn2.3xlarge|ml.trn2.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.i3en.large|ml.i3en.xlarge|ml.i3en.2xlarge|ml.i3en.3xlarge|ml.i3en.6xlarge|ml.i3en.12xlarge|ml.i3en.24xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.r5d.16xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.p6-b300.48xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.c6g.medium|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c7g.medium|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.c6a.large|ml.c6a.xlarge|ml.c6a.2xlarge|ml.c6a.4xlarge|ml.c6a.8xlarge|ml.c6a.12xlarge|ml.c6a.16xlarge|ml.c6a.24xlarge|ml.c6a.32xlarge|ml.c6a.48xlarge|ml.m6a.large|ml.m6a.xlarge|ml.m6a.2xlarge|ml.m6a.4xlarge|ml.m6a.8xlarge|ml.m6a.12xlarge|ml.m6a.16xlarge|ml.m6a.24xlarge|ml.m6a.32xlarge|ml.m6a.48xlarge|ml.m6g.medium|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m7g.medium|ml.m7g.large|ml.m7g.xlarge|ml.m7g.2xlarge|ml.m7g.4xlarge|ml.m7g.8xlarge|ml.m7g.12xlarge|ml.m7g.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.c8a.16xlarge|ml.m8a.16xlarge',
'KubernetesConfig' => [
'CurrentLabels' => ['', ...],
'CurrentTaints' => [
[
'Effect' => 'NoSchedule|PreferNoSchedule|NoExecute',
'Key' => '',
'Value' => '',
],
// ...
],
'DesiredLabels' => ['', ...],
'DesiredTaints' => [
[
'Effect' => 'NoSchedule|PreferNoSchedule|NoExecute',
'Key' => '',
'Value' => '',
],
// ...
],
],
'LastSoftwareUpdateTime' => ,
'LaunchTime' => ,
'LifeCycleConfig' => [
'OnCreate' => '',
'OnInitComplete' => '',
'SourceS3Uri' => '',
],
'NetworkInterface' => [
'InterfaceType' => 'efa|efa-only',
],
'NodeLogicalId' => '',
'OverrideVpcConfig' => [
'SecurityGroupIds' => ['', ...],
'Subnets' => ['', ...],
],
'Placement' => [
'AvailabilityZone' => '',
'AvailabilityZoneId' => '',
],
'PrivateDnsHostname' => '',
'PrivatePrimaryIp' => '',
'PrivatePrimaryIpv6' => '',
'ThreadsPerCore' => ,
'UltraServerInfo' => [
'Id' => '',
'Type' => '',
],
],
]
Result Details
Members
- NodeDetails
-
- Required: Yes
- Type: ClusterNodeDetails structure
The details of the SageMaker HyperPod cluster node.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeClusterSchedulerConfig
$result = $client->describeClusterSchedulerConfig([/* ... */]); $promise = $client->describeClusterSchedulerConfigAsync([/* ... */]);
Description of the cluster policy. This policy is used for task prioritization and fair-share allocation. This helps prioritize critical workloads and distributes idle compute across entities.
Parameter Syntax
$result = $client->describeClusterSchedulerConfig([
'ClusterSchedulerConfigId' => '', // REQUIRED
'ClusterSchedulerConfigVersion' => ,
]);
Parameter Details
Members
- ClusterSchedulerConfigId
-
- Required: Yes
- Type: string
ID of the cluster policy.
- ClusterSchedulerConfigVersion
-
- Type: int
Version of the cluster policy.
Result Syntax
[
'ClusterArn' => '',
'ClusterSchedulerConfigArn' => '',
'ClusterSchedulerConfigId' => '',
'ClusterSchedulerConfigVersion' => ,
'CreatedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'CreationTime' => ,
'Description' => '',
'FailureReason' => '',
'LastModifiedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'LastModifiedTime' => ,
'Name' => '',
'SchedulerConfig' => [
'FairShare' => 'Enabled|Disabled',
'IdleResourceSharing' => 'Enabled|Disabled',
'PriorityClasses' => [
[
'Name' => '',
'Weight' => ,
],
// ...
],
],
'Status' => 'Creating|CreateFailed|CreateRollbackFailed|Created|Updating|UpdateFailed|UpdateRollbackFailed|Updated|Deleting|DeleteFailed|DeleteRollbackFailed|Deleted',
'StatusDetails' => ['', ...],
]
Result Details
Members
- ClusterArn
-
- Type: string
ARN of the cluster where the cluster policy is applied.
- ClusterSchedulerConfigArn
-
- Required: Yes
- Type: string
ARN of the cluster policy.
- ClusterSchedulerConfigId
-
- Required: Yes
- Type: string
ID of the cluster policy.
- ClusterSchedulerConfigVersion
-
- Required: Yes
- Type: int
Version of the cluster policy.
- CreatedBy
-
- Type: UserContext structure
Information about the user who created or modified a SageMaker resource.
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Creation time of the cluster policy.
- Description
-
- Type: string
Description of the cluster policy.
- FailureReason
-
- Type: string
Failure reason of the cluster policy.
- LastModifiedBy
-
- Type: UserContext structure
Information about the user who created or modified a SageMaker resource.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Last modified time of the cluster policy.
- Name
-
- Required: Yes
- Type: string
Name of the cluster policy.
- SchedulerConfig
-
- Type: SchedulerConfig structure
Cluster policy configuration. This policy is used for task prioritization and fair-share allocation. This helps prioritize critical workloads and distributes idle compute across entities.
- Status
-
- Required: Yes
- Type: string
Status of the cluster policy.
- StatusDetails
-
- Type: Associative array of custom strings keys (SchedulerConfigComponent) to strings
Additional details about the status of the cluster policy. This field provides context when the policy is in a non-active state, such as during creation, updates, or if failures occur.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeCodeRepository
$result = $client->describeCodeRepository([/* ... */]); $promise = $client->describeCodeRepositoryAsync([/* ... */]);
Gets details about the specified Git repository.
Parameter Syntax
$result = $client->describeCodeRepository([
'CodeRepositoryName' => '', // REQUIRED
]);
Parameter Details
Members
- CodeRepositoryName
-
- Required: Yes
- Type: string
The name of the Git repository to describe.
Result Syntax
[
'CodeRepositoryArn' => '',
'CodeRepositoryName' => '',
'CreationTime' => ,
'GitConfig' => [
'Branch' => '',
'RepositoryUrl' => '',
'SecretArn' => '',
],
'LastModifiedTime' => ,
]
Result Details
Members
- CodeRepositoryArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Git repository.
- CodeRepositoryName
-
- Required: Yes
- Type: string
The name of the Git repository.
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the repository was created.
- GitConfig
-
- Type: GitConfig structure
Configuration details about the repository, including the URL where the repository is located, the default branch, and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository.
- LastModifiedTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the repository was last changed.
Errors
There are no errors described for this operation.
DescribeCompilationJob
$result = $client->describeCompilationJob([/* ... */]); $promise = $client->describeCompilationJobAsync([/* ... */]);
Returns information about a model compilation job.
To create a model compilation job, use CreateCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.
Parameter Syntax
$result = $client->describeCompilationJob([
'CompilationJobName' => '', // REQUIRED
]);
Parameter Details
Members
- CompilationJobName
-
- Required: Yes
- Type: string
The name of the model compilation job that you want information about.
Result Syntax
[
'CompilationEndTime' => ,
'CompilationJobArn' => '',
'CompilationJobName' => '',
'CompilationJobStatus' => 'INPROGRESS|COMPLETED|FAILED|STARTING|STOPPING|STOPPED',
'CompilationStartTime' => ,
'CreationTime' => ,
'DerivedInformation' => [
'DerivedDataInputConfig' => '',
],
'FailureReason' => '',
'InferenceImage' => '',
'InputConfig' => [
'DataInputConfig' => '',
'Framework' => 'TENSORFLOW|KERAS|MXNET|ONNX|PYTORCH|XGBOOST|TFLITE|DARKNET|SKLEARN',
'FrameworkVersion' => '',
'S3Uri' => '',
],
'LastModifiedTime' => ,
'ModelArtifacts' => [
'S3ModelArtifacts' => '',
],
'ModelDigests' => [
'ArtifactDigest' => '',
],
'ModelPackageVersionArn' => '',
'OutputConfig' => [
'CompilerOptions' => '',
'KmsKeyId' => '',
'S3OutputLocation' => '',
'TargetDevice' => 'lambda|ml_m4|ml_m5|ml_m6g|ml_c4|ml_c5|ml_c6g|ml_p2|ml_p3|ml_g4dn|ml_inf1|ml_inf2|ml_trn1|ml_eia2|jetson_tx1|jetson_tx2|jetson_nano|jetson_xavier|rasp3b|rasp4b|imx8qm|deeplens|rk3399|rk3288|aisage|sbe_c|qcs605|qcs603|sitara_am57x|amba_cv2|amba_cv22|amba_cv25|x86_win32|x86_win64|coreml|jacinto_tda4vm|imx8mplus',
'TargetPlatform' => [
'Accelerator' => 'INTEL_GRAPHICS|MALI|NVIDIA|NNA',
'Arch' => 'X86_64|X86|ARM64|ARM_EABI|ARM_EABIHF',
'Os' => 'ANDROID|LINUX',
],
],
'RoleArn' => '',
'StoppingCondition' => [
'MaxPendingTimeInSeconds' => ,
'MaxRuntimeInSeconds' => ,
'MaxWaitTimeInSeconds' => ,
],
'VpcConfig' => [
'SecurityGroupIds' => ['', ...],
'Subnets' => ['', ...],
],
]
Result Details
Members
- CompilationEndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the model compilation job on a compilation job instance ended. For a successful or stopped job, this is when the job's model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker AI detected that the job failed.
- CompilationJobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the model compilation job.
- CompilationJobName
-
- Required: Yes
- Type: string
The name of the model compilation job.
- CompilationJobStatus
-
- Required: Yes
- Type: string
The status of the model compilation job.
- CompilationStartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the model compilation job started the
CompilationJobinstances.You are billed for the time between this timestamp and the timestamp in the
CompilationEndTimefield. In Amazon CloudWatch Logs, the start time might be later than this time. That's because it takes time to download the compilation job, which depends on the size of the compilation job container. - CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the model compilation job was created.
- DerivedInformation
-
- Type: DerivedInformation structure
Information that SageMaker Neo automatically derived about the model.
- FailureReason
-
- Required: Yes
- Type: string
If a model compilation job failed, the reason it failed.
- InferenceImage
-
- Type: string
The inference image to use when compiling a model. Specify an image only if the target device is a cloud instance.
- InputConfig
-
- Required: Yes
- Type: InputConfig structure
Information about the location in Amazon S3 of the input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.
- LastModifiedTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the status of the model compilation job was last modified.
- ModelArtifacts
-
- Required: Yes
- Type: ModelArtifacts structure
Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.
- ModelDigests
-
- Type: ModelDigests structure
Provides a BLAKE2 hash value that identifies the compiled model artifacts in Amazon S3.
- ModelPackageVersionArn
-
- Type: string
The Amazon Resource Name (ARN) of the versioned model package that was provided to SageMaker Neo when you initiated a compilation job.
- OutputConfig
-
- Required: Yes
- Type: OutputConfig structure
Information about the output location for the compiled model and the target device that the model runs on.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI assumes to perform the model compilation job.
- StoppingCondition
-
- Required: Yes
- Type: StoppingCondition structure
Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker AI ends the compilation job. Use this API to cap model training costs.
- VpcConfig
-
- Type: NeoVpcConfig structure
A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeComputeQuota
$result = $client->describeComputeQuota([/* ... */]); $promise = $client->describeComputeQuotaAsync([/* ... */]);
Description of the compute allocation definition.
Parameter Syntax
$result = $client->describeComputeQuota([
'ComputeQuotaId' => '', // REQUIRED
'ComputeQuotaVersion' => ,
]);
Parameter Details
Members
- ComputeQuotaId
-
- Required: Yes
- Type: string
ID of the compute allocation definition.
- ComputeQuotaVersion
-
- Type: int
Version of the compute allocation definition.
Result Syntax
[
'ActivationState' => 'Enabled|Disabled',
'ClusterArn' => '',
'ComputeQuotaArn' => '',
'ComputeQuotaConfig' => [
'ComputeQuotaResources' => [
[
'AcceleratorPartition' => [
'Count' => ,
'Type' => 'mig-1g.5gb|mig-1g.10gb|mig-1g.18gb|mig-1g.20gb|mig-1g.23gb|mig-1g.35gb|mig-1g.45gb|mig-1g.47gb|mig-2g.10gb|mig-2g.20gb|mig-2g.35gb|mig-2g.45gb|mig-2g.47gb|mig-3g.20gb|mig-3g.40gb|mig-3g.71gb|mig-3g.90gb|mig-3g.93gb|mig-4g.20gb|mig-4g.40gb|mig-4g.71gb|mig-4g.90gb|mig-4g.93gb|mig-7g.40gb|mig-7g.80gb|mig-7g.141gb|mig-7g.180gb|mig-7g.186gb',
],
'Accelerators' => ,
'Count' => ,
'InstanceType' => 'ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5.4xlarge|ml.p6e-gb200.36xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.c5n.large|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.gr6.4xlarge|ml.gr6.8xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.trn2.3xlarge|ml.trn2.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.i3en.large|ml.i3en.xlarge|ml.i3en.2xlarge|ml.i3en.3xlarge|ml.i3en.6xlarge|ml.i3en.12xlarge|ml.i3en.24xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.r5d.16xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.p6-b300.48xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.c6g.medium|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c7g.medium|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.c6a.large|ml.c6a.xlarge|ml.c6a.2xlarge|ml.c6a.4xlarge|ml.c6a.8xlarge|ml.c6a.12xlarge|ml.c6a.16xlarge|ml.c6a.24xlarge|ml.c6a.32xlarge|ml.c6a.48xlarge|ml.m6a.large|ml.m6a.xlarge|ml.m6a.2xlarge|ml.m6a.4xlarge|ml.m6a.8xlarge|ml.m6a.12xlarge|ml.m6a.16xlarge|ml.m6a.24xlarge|ml.m6a.32xlarge|ml.m6a.48xlarge|ml.m6g.medium|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m7g.medium|ml.m7g.large|ml.m7g.xlarge|ml.m7g.2xlarge|ml.m7g.4xlarge|ml.m7g.8xlarge|ml.m7g.12xlarge|ml.m7g.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.c8a.16xlarge|ml.m8a.16xlarge',
'MemoryInGiB' => ,
'VCpu' => ,
],
// ...
],
'PreemptTeamTasks' => 'Never|LowerPriority',
'ResourceSharingConfig' => [
'AbsoluteBorrowLimits' => [
[
'AcceleratorPartition' => [
'Count' => ,
'Type' => 'mig-1g.5gb|mig-1g.10gb|mig-1g.18gb|mig-1g.20gb|mig-1g.23gb|mig-1g.35gb|mig-1g.45gb|mig-1g.47gb|mig-2g.10gb|mig-2g.20gb|mig-2g.35gb|mig-2g.45gb|mig-2g.47gb|mig-3g.20gb|mig-3g.40gb|mig-3g.71gb|mig-3g.90gb|mig-3g.93gb|mig-4g.20gb|mig-4g.40gb|mig-4g.71gb|mig-4g.90gb|mig-4g.93gb|mig-7g.40gb|mig-7g.80gb|mig-7g.141gb|mig-7g.180gb|mig-7g.186gb',
],
'Accelerators' => ,
'Count' => ,
'InstanceType' => 'ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5.4xlarge|ml.p6e-gb200.36xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.c5n.large|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.gr6.4xlarge|ml.gr6.8xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.trn2.3xlarge|ml.trn2.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.i3en.large|ml.i3en.xlarge|ml.i3en.2xlarge|ml.i3en.3xlarge|ml.i3en.6xlarge|ml.i3en.12xlarge|ml.i3en.24xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.r5d.16xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.p6-b300.48xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.c6g.medium|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c7g.medium|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.c6a.large|ml.c6a.xlarge|ml.c6a.2xlarge|ml.c6a.4xlarge|ml.c6a.8xlarge|ml.c6a.12xlarge|ml.c6a.16xlarge|ml.c6a.24xlarge|ml.c6a.32xlarge|ml.c6a.48xlarge|ml.m6a.large|ml.m6a.xlarge|ml.m6a.2xlarge|ml.m6a.4xlarge|ml.m6a.8xlarge|ml.m6a.12xlarge|ml.m6a.16xlarge|ml.m6a.24xlarge|ml.m6a.32xlarge|ml.m6a.48xlarge|ml.m6g.medium|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m7g.medium|ml.m7g.large|ml.m7g.xlarge|ml.m7g.2xlarge|ml.m7g.4xlarge|ml.m7g.8xlarge|ml.m7g.12xlarge|ml.m7g.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.c8a.16xlarge|ml.m8a.16xlarge',
'MemoryInGiB' => ,
'VCpu' => ,
],
// ...
],
'BorrowLimit' => ,
'Strategy' => 'Lend|DontLend|LendAndBorrow',
],
],
'ComputeQuotaId' => '',
'ComputeQuotaTarget' => [
'FairShareWeight' => ,
'TeamName' => '',
],
'ComputeQuotaVersion' => ,
'CreatedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'CreationTime' => ,
'Description' => '',
'FailureReason' => '',
'LastModifiedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'LastModifiedTime' => ,
'Name' => '',
'Status' => 'Creating|CreateFailed|CreateRollbackFailed|Created|Updating|UpdateFailed|UpdateRollbackFailed|Updated|Deleting|DeleteFailed|DeleteRollbackFailed|Deleted',
]
Result Details
Members
- ActivationState
-
- Type: string
The state of the compute allocation being described. Use to enable or disable compute allocation.
Default is
Enabled. - ClusterArn
-
- Type: string
ARN of the cluster.
- ComputeQuotaArn
-
- Required: Yes
- Type: string
ARN of the compute allocation definition.
- ComputeQuotaConfig
-
- Type: ComputeQuotaConfig structure
Configuration of the compute allocation definition. This includes the resource sharing option, and the setting to preempt low priority tasks.
- ComputeQuotaId
-
- Required: Yes
- Type: string
ID of the compute allocation definition.
- ComputeQuotaTarget
-
- Required: Yes
- Type: ComputeQuotaTarget structure
The target entity to allocate compute resources to.
- ComputeQuotaVersion
-
- Required: Yes
- Type: int
Version of the compute allocation definition.
- CreatedBy
-
- Type: UserContext structure
Information about the user who created or modified a SageMaker resource.
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Creation time of the compute allocation configuration.
- Description
-
- Type: string
Description of the compute allocation definition.
- FailureReason
-
- Type: string
Failure reason of the compute allocation definition.
- LastModifiedBy
-
- Type: UserContext structure
Information about the user who created or modified a SageMaker resource.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Last modified time of the compute allocation configuration.
- Name
-
- Required: Yes
- Type: string
Name of the compute allocation definition.
- Status
-
- Required: Yes
- Type: string
Status of the compute allocation definition.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeContext
$result = $client->describeContext([/* ... */]); $promise = $client->describeContextAsync([/* ... */]);
Describes a context.
Parameter Syntax
$result = $client->describeContext([
'ContextName' => '', // REQUIRED
]);
Parameter Details
Members
- ContextName
-
- Required: Yes
- Type: string
The name of the context to describe.
Result Syntax
[
'ContextArn' => '',
'ContextName' => '',
'ContextType' => '',
'CreatedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'CreationTime' => ,
'Description' => '',
'LastModifiedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'LastModifiedTime' => ,
'LineageGroupArn' => '',
'Properties' => ['', ...],
'Source' => [
'SourceId' => '',
'SourceType' => '',
'SourceUri' => '',
],
]
Result Details
Members
- ContextArn
-
- Type: string
The Amazon Resource Name (ARN) of the context.
- ContextName
-
- Type: string
The name of the context.
- ContextType
-
- Type: string
The type of the context.
- CreatedBy
-
- Type: UserContext structure
Information about the user who created or modified a SageMaker resource.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the context was created.
- Description
-
- Type: string
The description of the context.
- LastModifiedBy
-
- Type: UserContext structure
Information about the user who created or modified a SageMaker resource.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the context was last modified.
- LineageGroupArn
-
- Type: string
The Amazon Resource Name (ARN) of the lineage group.
- Properties
-
- Type: Associative array of custom strings keys (StringParameterValue) to strings
A list of the context's properties.
- Source
-
- Type: ContextSource structure
The source of the context.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeDataQualityJobDefinition
$result = $client->describeDataQualityJobDefinition([/* ... */]); $promise = $client->describeDataQualityJobDefinitionAsync([/* ... */]);
Gets the details of a data quality monitoring job definition.
Parameter Syntax
$result = $client->describeDataQualityJobDefinition([
'JobDefinitionName' => '', // REQUIRED
]);
Parameter Details
Members
- JobDefinitionName
-
- Required: Yes
- Type: string
The name of the data quality monitoring job definition to describe.
Result Syntax
[
'CreationTime' => ,
'DataQualityAppSpecification' => [
'ContainerArguments' => ['', ...],
'ContainerEntrypoint' => ['', ...],
'Environment' => ['', ...],
'ImageUri' => '',
'PostAnalyticsProcessorSourceUri' => '',
'RecordPreprocessorSourceUri' => '',
],
'DataQualityBaselineConfig' => [
'BaseliningJobName' => '',
'ConstraintsResource' => [
'S3Uri' => '',
],
'StatisticsResource' => [
'S3Uri' => '',
],
],
'DataQualityJobInput' => [
'BatchTransformInput' => [
'DataCapturedDestinationS3Uri' => '',
'DatasetFormat' => [
'Csv' => [
'Header' => true || false,
],
'Json' => [
'Line' => true || false,
],
'Parquet' => [
],
],
'EndTimeOffset' => '',
'ExcludeFeaturesAttribute' => '',
'FeaturesAttribute' => '',
'InferenceAttribute' => '',
'LocalPath' => '',
'ProbabilityAttribute' => '',
'ProbabilityThresholdAttribute' => ,
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3InputMode' => 'Pipe|File',
'StartTimeOffset' => '',
],
'EndpointInput' => [
'EndTimeOffset' => '',
'EndpointName' => '',
'ExcludeFeaturesAttribute' => '',
'FeaturesAttribute' => '',
'InferenceAttribute' => '',
'LocalPath' => '',
'ProbabilityAttribute' => '',
'ProbabilityThresholdAttribute' => ,
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3InputMode' => 'Pipe|File',
'StartTimeOffset' => '',
],
],
'DataQualityJobOutputConfig' => [
'KmsKeyId' => '',
'MonitoringOutputs' => [
[
'S3Output' => [
'LocalPath' => '',
'S3UploadMode' => 'Continuous|EndOfJob',
'S3Uri' => '',
],
],
// ...
],
],
'JobDefinitionArn' => '',
'JobDefinitionName' => '',
'JobResources' => [
'ClusterConfig' => [
'InstanceCount' => ,
'InstanceType' => 'ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p5.4xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'VolumeKmsKeyId' => '',
'VolumeSizeInGB' => ,
],
],
'NetworkConfig' => [
'EnableInterContainerTrafficEncryption' => true || false,
'EnableNetworkIsolation' => true || false,
'VpcConfig' => [
'SecurityGroupIds' => ['', ...],
'Subnets' => ['', ...],
],
],
'RoleArn' => '',
'StoppingCondition' => [
'MaxRuntimeInSeconds' => ,
],
]
Result Details
Members
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the data quality monitoring job definition was created.
- DataQualityAppSpecification
-
- Required: Yes
- Type: DataQualityAppSpecification structure
Information about the container that runs the data quality monitoring job.
- DataQualityBaselineConfig
-
- Type: DataQualityBaselineConfig structure
The constraints and baselines for the data quality monitoring job definition.
- DataQualityJobInput
-
- Required: Yes
- Type: DataQualityJobInput structure
The list of inputs for the data quality monitoring job. Currently endpoints are supported.
- DataQualityJobOutputConfig
-
- Required: Yes
- Type: MonitoringOutputConfig structure
The output configuration for monitoring jobs.
- JobDefinitionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the data quality monitoring job definition.
- JobDefinitionName
-
- Required: Yes
- Type: string
The name of the data quality monitoring job definition.
- JobResources
-
- Required: Yes
- Type: MonitoringResources structure
Identifies the resources to deploy for a monitoring job.
- NetworkConfig
-
- Type: MonitoringNetworkConfig structure
The networking configuration for the data quality monitoring job.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.
- StoppingCondition
-
- Type: MonitoringStoppingCondition structure
A time limit for how long the monitoring job is allowed to run before stopping.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeDevice
$result = $client->describeDevice([/* ... */]); $promise = $client->describeDeviceAsync([/* ... */]);
Describes the device.
Parameter Syntax
$result = $client->describeDevice([
'DeviceFleetName' => '', // REQUIRED
'DeviceName' => '', // REQUIRED
'NextToken' => '',
]);
Parameter Details
Members
- DeviceFleetName
-
- Required: Yes
- Type: string
The name of the fleet the devices belong to.
- DeviceName
-
- Required: Yes
- Type: string
The unique ID of the device.
- NextToken
-
- Type: string
Next token of device description.
Result Syntax
[
'AgentVersion' => '',
'Description' => '',
'DeviceArn' => '',
'DeviceFleetName' => '',
'DeviceName' => '',
'IotThingName' => '',
'LatestHeartbeat' => ,
'MaxModels' => ,
'Models' => [
[
'LatestInference' => ,
'LatestSampleTime' => ,
'ModelName' => '',
'ModelVersion' => '',
],
// ...
],
'NextToken' => '',
'RegistrationTime' => ,
]
Result Details
Members
- AgentVersion
-
- Type: string
Edge Manager agent version.
- Description
-
- Type: string
A description of the device.
- DeviceArn
-
- Type: string
The Amazon Resource Name (ARN) of the device.
- DeviceFleetName
-
- Required: Yes
- Type: string
The name of the fleet the device belongs to.
- DeviceName
-
- Required: Yes
- Type: string
The unique identifier of the device.
- IotThingName
-
- Type: string
The Amazon Web Services Internet of Things (IoT) object thing name associated with the device.
- LatestHeartbeat
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last heartbeat received from the device.
- MaxModels
-
- Type: int
The maximum number of models.
- Models
-
- Type: Array of EdgeModel structures
Models on the device.
- NextToken
-
- Type: string
The response from the last list when returning a list large enough to need tokening.
- RegistrationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the last registration or de-reregistration.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeDeviceFleet
$result = $client->describeDeviceFleet([/* ... */]); $promise = $client->describeDeviceFleetAsync([/* ... */]);
A description of the fleet the device belongs to.
Parameter Syntax
$result = $client->describeDeviceFleet([
'DeviceFleetName' => '', // REQUIRED
]);
Parameter Details
Members
- DeviceFleetName
-
- Required: Yes
- Type: string
The name of the fleet.
Result Syntax
[
'CreationTime' => ,
'Description' => '',
'DeviceFleetArn' => '',
'DeviceFleetName' => '',
'IotRoleAlias' => '',
'LastModifiedTime' => ,
'OutputConfig' => [
'KmsKeyId' => '',
'PresetDeploymentConfig' => '',
'PresetDeploymentType' => 'GreengrassV2Component',
'S3OutputLocation' => '',
],
'RoleArn' => '',
]
Result Details
Members
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp of when the device fleet was created.
- Description
-
- Type: string
A description of the fleet.
- DeviceFleetArn
-
- Required: Yes
- Type: string
The The Amazon Resource Name (ARN) of the fleet.
- DeviceFleetName
-
- Required: Yes
- Type: string
The name of the fleet.
- IotRoleAlias
-
- Type: string
The Amazon Resource Name (ARN) alias created in Amazon Web Services Internet of Things (IoT).
- LastModifiedTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp of when the device fleet was last updated.
- OutputConfig
-
- Required: Yes
- Type: EdgeOutputConfig structure
The output configuration for storing sampled data.
- RoleArn
-
- Type: string
The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeDomain
$result = $client->describeDomain([/* ... */]); $promise = $client->describeDomainAsync([/* ... */]);
The description of the domain.
Parameter Syntax
$result = $client->describeDomain([
'DomainId' => '', // REQUIRED
]);
Parameter Details
Members
- DomainId
-
- Required: Yes
- Type: string
The domain ID.
Result Syntax
[
'AppNetworkAccessType' => 'PublicInternetOnly|VpcOnly',
'AppSecurityGroupManagement' => 'Service|Customer',
'AuthMode' => 'SSO|IAM',
'CreationTime' => ,
'DefaultSpaceSettings' => [
'CustomFileSystemConfigs' => [
[
'EFSFileSystemConfig' => [
'FileSystemId' => '',
'FileSystemPath' => '',
],
'FSxLustreFileSystemConfig' => [
'FileSystemId' => '',
'FileSystemPath' => '',
],
'S3FileSystemConfig' => [
'MountPath' => '',
'S3Uri' => '',
],
],
// ...
],
'CustomPosixUserConfig' => [
'Gid' => ,
'Uid' => ,
],
'ExecutionRole' => '',
'JupyterLabAppSettings' => [
'AppLifecycleManagement' => [
'IdleSettings' => [
'IdleTimeoutInMinutes' => ,
'LifecycleManagement' => 'ENABLED|DISABLED',
'MaxIdleTimeoutInMinutes' => ,
'MinIdleTimeoutInMinutes' => ,
],
],
'BuiltInLifecycleConfigArn' => '',
'CodeRepositories' => [
[
'RepositoryUrl' => '',
],
// ...
],
'CustomImages' => [
[
'AppImageConfigName' => '',
'ImageName' => '',
'ImageVersionNumber' => ,
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
'EmrSettings' => [
'AssumableRoleArns' => ['', ...],
'ExecutionRoleArns' => ['', ...],
],
'LifecycleConfigArns' => ['', ...],
],
'JupyterServerAppSettings' => [
'CodeRepositories' => [
[
'RepositoryUrl' => '',
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
'LifecycleConfigArns' => ['', ...],
],
'KernelGatewayAppSettings' => [
'CustomImages' => [
[
'AppImageConfigName' => '',
'ImageName' => '',
'ImageVersionNumber' => ,
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
'LifecycleConfigArns' => ['', ...],
],
'SecurityGroups' => ['', ...],
'SpaceStorageSettings' => [
'DefaultEbsStorageSettings' => [
'DefaultEbsVolumeSizeInGb' => ,
'MaximumEbsVolumeSizeInGb' => ,
],
],
],
'DefaultUserSettings' => [
'AutoMountHomeEFS' => 'Enabled|Disabled|DefaultAsDomain',
'CanvasAppSettings' => [
'DirectDeploySettings' => [
'Status' => 'ENABLED|DISABLED',
],
'EmrServerlessSettings' => [
'ExecutionRoleArn' => '',
'Status' => 'ENABLED|DISABLED',
],
'GenerativeAiSettings' => [
'AmazonBedrockRoleArn' => '',
],
'IdentityProviderOAuthSettings' => [
[
'DataSourceName' => 'SalesforceGenie|Snowflake',
'SecretArn' => '',
'Status' => 'ENABLED|DISABLED',
],
// ...
],
'KendraSettings' => [
'Status' => 'ENABLED|DISABLED',
],
'ModelRegisterSettings' => [
'CrossAccountModelRegisterRoleArn' => '',
'Status' => 'ENABLED|DISABLED',
],
'TimeSeriesForecastingSettings' => [
'AmazonForecastRoleArn' => '',
'Status' => 'ENABLED|DISABLED',
],
'WorkspaceSettings' => [
'S3ArtifactPath' => '',
'S3KmsKeyId' => '',
],
],
'CodeEditorAppSettings' => [
'AppLifecycleManagement' => [
'IdleSettings' => [
'IdleTimeoutInMinutes' => ,
'LifecycleManagement' => 'ENABLED|DISABLED',
'MaxIdleTimeoutInMinutes' => ,
'MinIdleTimeoutInMinutes' => ,
],
],
'BuiltInLifecycleConfigArn' => '',
'CustomImages' => [
[
'AppImageConfigName' => '',
'ImageName' => '',
'ImageVersionNumber' => ,
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
'LifecycleConfigArns' => ['', ...],
],
'CustomFileSystemConfigs' => [
[
'EFSFileSystemConfig' => [
'FileSystemId' => '',
'FileSystemPath' => '',
],
'FSxLustreFileSystemConfig' => [
'FileSystemId' => '',
'FileSystemPath' => '',
],
'S3FileSystemConfig' => [
'MountPath' => '',
'S3Uri' => '',
],
],
// ...
],
'CustomPosixUserConfig' => [
'Gid' => ,
'Uid' => ,
],
'DefaultLandingUri' => '',
'ExecutionRole' => '',
'JupyterLabAppSettings' => [
'AppLifecycleManagement' => [
'IdleSettings' => [
'IdleTimeoutInMinutes' => ,
'LifecycleManagement' => 'ENABLED|DISABLED',
'MaxIdleTimeoutInMinutes' => ,
'MinIdleTimeoutInMinutes' => ,
],
],
'BuiltInLifecycleConfigArn' => '',
'CodeRepositories' => [
[
'RepositoryUrl' => '',
],
// ...
],
'CustomImages' => [
[
'AppImageConfigName' => '',
'ImageName' => '',
'ImageVersionNumber' => ,
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
'EmrSettings' => [
'AssumableRoleArns' => ['', ...],
'ExecutionRoleArns' => ['', ...],
],
'LifecycleConfigArns' => ['', ...],
],
'JupyterServerAppSettings' => [
'CodeRepositories' => [
[
'RepositoryUrl' => '',
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
'LifecycleConfigArns' => ['', ...],
],
'KernelGatewayAppSettings' => [
'CustomImages' => [
[
'AppImageConfigName' => '',
'ImageName' => '',
'ImageVersionNumber' => ,
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
'LifecycleConfigArns' => ['', ...],
],
'RSessionAppSettings' => [
'CustomImages' => [
[
'AppImageConfigName' => '',
'ImageName' => '',
'ImageVersionNumber' => ,
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
],
'RStudioServerProAppSettings' => [
'AccessStatus' => 'ENABLED|DISABLED',
'UserGroup' => 'R_STUDIO_ADMIN|R_STUDIO_USER',
],
'SecurityGroups' => ['', ...],
'SharingSettings' => [
'NotebookOutputOption' => 'Allowed|Disabled',
'S3KmsKeyId' => '',
'S3OutputPath' => '',
],
'SpaceStorageSettings' => [
'DefaultEbsStorageSettings' => [
'DefaultEbsVolumeSizeInGb' => ,
'MaximumEbsVolumeSizeInGb' => ,
],
],
'StudioWebPortal' => 'ENABLED|DISABLED',
'StudioWebPortalSettings' => [
'ExecutionRoleSessionNameMode' => 'STATIC|USER_IDENTITY',
'HiddenAppTypes' => ['', ...],
'HiddenInstanceTypes' => ['', ...],
'HiddenMlTools' => ['', ...],
'HiddenSageMakerImageVersionAliases' => [
[
'SageMakerImageName' => 'sagemaker_distribution',
'VersionAliases' => ['', ...],
],
// ...
],
],
'TensorBoardAppSettings' => [
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
],
],
'DomainArn' => '',
'DomainId' => '',
'DomainName' => '',
'DomainSettings' => [
'AmazonQSettings' => [
'QProfileArn' => '',
'Status' => 'ENABLED|DISABLED',
],
'DockerSettings' => [
'EnableDockerAccess' => 'ENABLED|DISABLED',
'RootlessDocker' => 'ENABLED|DISABLED',
'VpcOnlyTrustedAccounts' => ['', ...],
],
'ExecutionRoleIdentityConfig' => 'USER_PROFILE_NAME|DISABLED',
'IpAddressType' => 'ipv4|dualstack',
'RStudioServerProDomainSettings' => [
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
'DomainExecutionRoleArn' => '',
'RStudioConnectUrl' => '',
'RStudioPackageManagerUrl' => '',
],
'SecurityGroupIds' => ['', ...],
'TrustedIdentityPropagationSettings' => [
'Status' => 'ENABLED|DISABLED',
],
'UnifiedStudioSettings' => [
'DomainAccountId' => '',
'DomainId' => '',
'DomainRegion' => '',
'EnvironmentId' => '',
'ProjectId' => '',
'ProjectS3Path' => '',
'SingleSignOnApplicationArn' => '',
'StudioWebPortalAccess' => 'ENABLED|DISABLED',
],
],
'FailureReason' => '',
'HomeEfsFileSystemCreation' => 'Enabled|Disabled',
'HomeEfsFileSystemId' => '',
'HomeEfsFileSystemKmsKeyId' => '',
'KmsKeyId' => '',
'LastModifiedTime' => ,
'SecurityGroupIdForDomainBoundary' => '',
'SingleSignOnApplicationArn' => '',
'SingleSignOnManagedApplicationInstanceId' => '',
'Status' => 'Deleting|Failed|InService|Pending|Updating|Update_Failed|Delete_Failed',
'SubnetIds' => ['', ...],
'TagPropagation' => 'ENABLED|DISABLED',
'Url' => '',
'VpcId' => '',
]
Result Details
Members
- AppNetworkAccessType
-
- Type: string
Specifies the VPC used for non-EFS traffic. The default value is
PublicInternetOnly.-
PublicInternetOnly- Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access -
VpcOnly- All traffic is through the specified VPC and subnets
- AppSecurityGroupManagement
-
- Type: string
The entity that creates and manages the required security groups for inter-app communication in
VPCOnlymode. Required whenCreateDomain.AppNetworkAccessTypeisVPCOnlyandDomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArnis provided. - AuthMode
-
- Type: string
The domain's authentication mode.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation time.
- DefaultSpaceSettings
-
- Type: DefaultSpaceSettings structure
The default settings for shared spaces that users create in the domain.
- DefaultUserSettings
-
- Type: UserSettings structure
Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile.
- DomainArn
-
- Type: string
The domain's Amazon Resource Name (ARN).
- DomainId
-
- Type: string
The domain ID.
- DomainName
-
- Type: string
The domain name.
- DomainSettings
-
- Type: DomainSettings structure
A collection of
Domainsettings. - FailureReason
-
- Type: string
The failure reason.
- HomeEfsFileSystemCreation
-
- Type: string
Indicates whether a home EFS file system is created for the domain.
- HomeEfsFileSystemId
-
- Type: string
The ID of the Amazon Elastic File System managed by this Domain.
- HomeEfsFileSystemKmsKeyId
-
- Type: string
Use
KmsKeyId. - KmsKeyId
-
- Type: string
The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last modified time.
- SecurityGroupIdForDomainBoundary
-
- Type: string
The ID of the security group that authorizes traffic between the
RSessionGatewayapps and theRStudioServerProapp. - SingleSignOnApplicationArn
-
- Type: string
The ARN of the application managed by SageMaker AI in IAM Identity Center. This value is only returned for domains created after October 1, 2023.
- SingleSignOnManagedApplicationInstanceId
-
- Type: string
The IAM Identity Center managed application instance ID.
- Status
-
- Type: string
The status.
- SubnetIds
-
- Type: Array of strings
The VPC subnets that the domain uses for communication.
- TagPropagation
-
- Type: string
Indicates whether custom tag propagation is supported for the domain.
- Url
-
- Type: string
The domain's URL.
- VpcId
-
- Type: string
The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeEdgeDeploymentPlan
$result = $client->describeEdgeDeploymentPlan([/* ... */]); $promise = $client->describeEdgeDeploymentPlanAsync([/* ... */]);
Describes an edge deployment plan with deployment status per stage.
Parameter Syntax
$result = $client->describeEdgeDeploymentPlan([
'EdgeDeploymentPlanName' => '', // REQUIRED
'MaxResults' => ,
'NextToken' => '',
]);
Parameter Details
Members
- EdgeDeploymentPlanName
-
- Required: Yes
- Type: string
The name of the deployment plan to describe.
- MaxResults
-
- Type: int
The maximum number of results to select (50 by default).
- NextToken
-
- Type: string
If the edge deployment plan has enough stages to require tokening, then this is the response from the last list of stages returned.
Result Syntax
[
'CreationTime' => ,
'DeviceFleetName' => '',
'EdgeDeploymentFailed' => ,
'EdgeDeploymentPending' => ,
'EdgeDeploymentPlanArn' => '',
'EdgeDeploymentPlanName' => '',
'EdgeDeploymentSuccess' => ,
'LastModifiedTime' => ,
'ModelConfigs' => [
[
'EdgePackagingJobName' => '',
'ModelHandle' => '',
],
// ...
],
'NextToken' => '',
'Stages' => [
[
'DeploymentConfig' => [
'FailureHandlingPolicy' => 'ROLLBACK_ON_FAILURE|DO_NOTHING',
],
'DeploymentStatus' => [
'EdgeDeploymentFailedInStage' => ,
'EdgeDeploymentPendingInStage' => ,
'EdgeDeploymentStageStartTime' => ,
'EdgeDeploymentStatusMessage' => '',
'EdgeDeploymentSuccessInStage' => ,
'StageStatus' => 'CREATING|READYTODEPLOY|STARTING|INPROGRESS|DEPLOYED|FAILED|STOPPING|STOPPED',
],
'DeviceSelectionConfig' => [
'DeviceNameContains' => '',
'DeviceNames' => ['', ...],
'DeviceSubsetType' => 'PERCENTAGE|SELECTION|NAMECONTAINS',
'Percentage' => ,
],
'StageName' => '',
],
// ...
],
]
Result Details
Members
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the edge deployment plan was created.
- DeviceFleetName
-
- Required: Yes
- Type: string
The device fleet used for this edge deployment plan.
- EdgeDeploymentFailed
-
- Type: int
The number of edge devices that failed the deployment.
- EdgeDeploymentPending
-
- Type: int
The number of edge devices yet to pick up deployment, or in progress.
- EdgeDeploymentPlanArn
-
- Required: Yes
- Type: string
The ARN of edge deployment plan.
- EdgeDeploymentPlanName
-
- Required: Yes
- Type: string
The name of the edge deployment plan.
- EdgeDeploymentSuccess
-
- Type: int
The number of edge devices with the successful deployment.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the edge deployment plan was last updated.
- ModelConfigs
-
- Required: Yes
- Type: Array of EdgeDeploymentModelConfig structures
List of models associated with the edge deployment plan.
- NextToken
-
- Type: string
Token to use when calling the next set of stages in the edge deployment plan.
- Stages
-
- Required: Yes
- Type: Array of DeploymentStageStatusSummary structures
List of stages in the edge deployment plan.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeEdgePackagingJob
$result = $client->describeEdgePackagingJob([/* ... */]); $promise = $client->describeEdgePackagingJobAsync([/* ... */]);
A description of edge packaging jobs.
Parameter Syntax
$result = $client->describeEdgePackagingJob([
'EdgePackagingJobName' => '', // REQUIRED
]);
Parameter Details
Members
- EdgePackagingJobName
-
- Required: Yes
- Type: string
The name of the edge packaging job.
Result Syntax
[
'CompilationJobName' => '',
'CreationTime' => ,
'EdgePackagingJobArn' => '',
'EdgePackagingJobName' => '',
'EdgePackagingJobStatus' => 'STARTING|INPROGRESS|COMPLETED|FAILED|STOPPING|STOPPED',
'EdgePackagingJobStatusMessage' => '',
'LastModifiedTime' => ,
'ModelArtifact' => '',
'ModelName' => '',
'ModelSignature' => '',
'ModelVersion' => '',
'OutputConfig' => [
'KmsKeyId' => '',
'PresetDeploymentConfig' => '',
'PresetDeploymentType' => 'GreengrassV2Component',
'S3OutputLocation' => '',
],
'PresetDeploymentOutput' => [
'Artifact' => '',
'Status' => 'COMPLETED|FAILED',
'StatusMessage' => '',
'Type' => 'GreengrassV2Component',
],
'ResourceKey' => '',
'RoleArn' => '',
]
Result Details
Members
- CompilationJobName
-
- Type: string
The name of the SageMaker Neo compilation job that is used to locate model artifacts that are being packaged.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the packaging job was created.
- EdgePackagingJobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the edge packaging job.
- EdgePackagingJobName
-
- Required: Yes
- Type: string
The name of the edge packaging job.
- EdgePackagingJobStatus
-
- Required: Yes
- Type: string
The current status of the packaging job.
- EdgePackagingJobStatusMessage
-
- Type: string
Returns a message describing the job status and error messages.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the job was last updated.
- ModelArtifact
-
- Type: string
The Amazon Simple Storage (S3) URI where model artifacts ares stored.
- ModelName
-
- Type: string
The name of the model.
- ModelSignature
-
- Type: string
The signature document of files in the model artifact.
- ModelVersion
-
- Type: string
The version of the model.
- OutputConfig
-
- Type: EdgeOutputConfig structure
The output configuration for the edge packaging job.
- PresetDeploymentOutput
-
- Type: EdgePresetDeploymentOutput structure
The output of a SageMaker Edge Manager deployable resource.
- ResourceKey
-
- Type: string
The Amazon Web Services KMS key to use when encrypting the EBS volume the job run on.
- RoleArn
-
- Type: string
The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact Neo.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeEndpoint
$result = $client->describeEndpoint([/* ... */]); $promise = $client->describeEndpointAsync([/* ... */]);
Returns the description of an endpoint.
Parameter Syntax
$result = $client->describeEndpoint([
'EndpointName' => '', // REQUIRED
]);
Parameter Details
Members
- EndpointName
-
- Required: Yes
- Type: string
The name of the endpoint.
Result Syntax
[
'AsyncInferenceConfig' => [
'ClientConfig' => [
'MaxConcurrentInvocationsPerInstance' => ,
],
'OutputConfig' => [
'KmsKeyId' => '',
'NotificationConfig' => [
'ErrorTopic' => '',
'IncludeInferenceResponseIn' => ['', ...],
'SuccessTopic' => '',
],
'S3FailurePath' => '',
'S3OutputPath' => '',
],
],
'CreationTime' => ,
'DataCaptureConfig' => [
'CaptureStatus' => 'Started|Stopped',
'CurrentSamplingPercentage' => ,
'DestinationS3Uri' => '',
'EnableCapture' => true || false,
'KmsKeyId' => '',
],
'EndpointArn' => '',
'EndpointConfigName' => '',
'EndpointName' => '',
'EndpointStatus' => 'OutOfService|Creating|Updating|SystemUpdating|RollingBack|InService|Deleting|Failed|UpdateRollbackFailed',
'ExplainerConfig' => [
'ClarifyExplainerConfig' => [
'EnableExplanations' => '',
'InferenceConfig' => [
'ContentTemplate' => '',
'FeatureHeaders' => ['', ...],
'FeatureTypes' => ['', ...],
'FeaturesAttribute' => '',
'LabelAttribute' => '',
'LabelHeaders' => ['', ...],
'LabelIndex' => ,
'MaxPayloadInMB' => ,
'MaxRecordCount' => ,
'ProbabilityAttribute' => '',
'ProbabilityIndex' => ,
],
'ShapConfig' => [
'NumberOfSamples' => ,
'Seed' => ,
'ShapBaselineConfig' => [
'MimeType' => '',
'ShapBaseline' => '',
'ShapBaselineUri' => '',
],
'TextConfig' => [
'Granularity' => 'token|sentence|paragraph',
'Language' => 'af|sq|ar|hy|eu|bn|bg|ca|zh|hr|cs|da|nl|en|et|fi|fr|de|el|gu|he|hi|hu|is|id|ga|it|kn|ky|lv|lt|lb|mk|ml|mr|ne|nb|fa|pl|pt|ro|ru|sa|sr|tn|si|sk|sl|es|sv|tl|ta|tt|te|tr|uk|ur|yo|lij|xx',
],
'UseLogit' => true || false,
],
],
],
'FailureReason' => '',
'LastDeploymentConfig' => [
'AutoRollbackConfiguration' => [
'Alarms' => [
[
'AlarmName' => '',
],
// ...
],
],
'BlueGreenUpdatePolicy' => [
'MaximumExecutionTimeoutInSeconds' => ,
'TerminationWaitInSeconds' => ,
'TrafficRoutingConfiguration' => [
'CanarySize' => [
'Type' => 'INSTANCE_COUNT|CAPACITY_PERCENT',
'Value' => ,
],
'LinearStepSize' => [
'Type' => 'INSTANCE_COUNT|CAPACITY_PERCENT',
'Value' => ,
],
'Type' => 'ALL_AT_ONCE|CANARY|LINEAR',
'WaitIntervalInSeconds' => ,
],
],
'RollingUpdatePolicy' => [
'MaximumBatchSize' => [
'Type' => 'INSTANCE_COUNT|CAPACITY_PERCENT',
'Value' => ,
],
'MaximumExecutionTimeoutInSeconds' => ,
'RollbackMaximumBatchSize' => [
'Type' => 'INSTANCE_COUNT|CAPACITY_PERCENT',
'Value' => ,
],
'WaitIntervalInSeconds' => ,
],
],
'LastModifiedTime' => ,
'MetricsConfig' => [
'EnableDetailedObservability' => true || false,
'EnableEnhancedMetrics' => true || false,
'MetricPublishFrequencyInSeconds' => ,
],
'PendingDeploymentSummary' => [
'EndpointConfigName' => '',
'ProductionVariants' => [
[
'AcceleratorType' => 'ml.eia1.medium|ml.eia1.large|ml.eia1.xlarge|ml.eia2.medium|ml.eia2.large|ml.eia2.xlarge',
'CurrentInstanceCount' => ,
'CurrentServerlessConfig' => [
'MaxConcurrency' => ,
'MemorySizeInMB' => ,
'ProvisionedConcurrency' => ,
],
'CurrentWeight' => ,
'DeployedImages' => [
[
'ResolutionTime' => ,
'ResolvedImage' => '',
'SpecifiedImage' => '',
],
// ...
],
'DesiredInstanceCount' => ,
'DesiredServerlessConfig' => [
'MaxConcurrency' => ,
'MemorySizeInMB' => ,
'ProvisionedConcurrency' => ,
],
'DesiredWeight' => ,
'InstancePools' => [
[
'CurrentInstanceCount' => ,
'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.12xlarge|ml.m5d.24xlarge|ml.c4.large|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.large|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.12xlarge|ml.r5.24xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.12xlarge|ml.r5d.24xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.dl1.24xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.r8g.medium|ml.r8g.large|ml.r8g.xlarge|ml.r8g.2xlarge|ml.r8g.4xlarge|ml.r8g.8xlarge|ml.r8g.12xlarge|ml.r8g.16xlarge|ml.r8g.24xlarge|ml.r8g.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.p4d.24xlarge|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m6gd.large|ml.m6gd.xlarge|ml.m6gd.2xlarge|ml.m6gd.4xlarge|ml.m6gd.8xlarge|ml.m6gd.12xlarge|ml.m6gd.16xlarge|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c6gd.large|ml.c6gd.xlarge|ml.c6gd.2xlarge|ml.c6gd.4xlarge|ml.c6gd.8xlarge|ml.c6gd.12xlarge|ml.c6gd.16xlarge|ml.c6gn.large|ml.c6gn.xlarge|ml.c6gn.2xlarge|ml.c6gn.4xlarge|ml.c6gn.8xlarge|ml.c6gn.12xlarge|ml.c6gn.16xlarge|ml.r6g.large|ml.r6g.xlarge|ml.r6g.2xlarge|ml.r6g.4xlarge|ml.r6g.8xlarge|ml.r6g.12xlarge|ml.r6g.16xlarge|ml.r6gd.large|ml.r6gd.xlarge|ml.r6gd.2xlarge|ml.r6gd.4xlarge|ml.r6gd.8xlarge|ml.r6gd.12xlarge|ml.r6gd.16xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.r7gd.medium|ml.r7gd.large|ml.r7gd.xlarge|ml.r7gd.2xlarge|ml.r7gd.4xlarge|ml.r7gd.8xlarge|ml.r7gd.12xlarge|ml.r7gd.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.c6in.large|ml.c6in.xlarge|ml.c6in.2xlarge|ml.c6in.4xlarge|ml.c6in.8xlarge|ml.c6in.12xlarge|ml.c6in.16xlarge|ml.c6in.24xlarge|ml.c6in.32xlarge|ml.p6-b200.48xlarge|ml.p6-b300.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge',
],
// ...
],
'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.12xlarge|ml.m5d.24xlarge|ml.c4.large|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.large|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.12xlarge|ml.r5.24xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.12xlarge|ml.r5d.24xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.dl1.24xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.r8g.medium|ml.r8g.large|ml.r8g.xlarge|ml.r8g.2xlarge|ml.r8g.4xlarge|ml.r8g.8xlarge|ml.r8g.12xlarge|ml.r8g.16xlarge|ml.r8g.24xlarge|ml.r8g.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.p4d.24xlarge|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m6gd.large|ml.m6gd.xlarge|ml.m6gd.2xlarge|ml.m6gd.4xlarge|ml.m6gd.8xlarge|ml.m6gd.12xlarge|ml.m6gd.16xlarge|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c6gd.large|ml.c6gd.xlarge|ml.c6gd.2xlarge|ml.c6gd.4xlarge|ml.c6gd.8xlarge|ml.c6gd.12xlarge|ml.c6gd.16xlarge|ml.c6gn.large|ml.c6gn.xlarge|ml.c6gn.2xlarge|ml.c6gn.4xlarge|ml.c6gn.8xlarge|ml.c6gn.12xlarge|ml.c6gn.16xlarge|ml.r6g.large|ml.r6g.xlarge|ml.r6g.2xlarge|ml.r6g.4xlarge|ml.r6g.8xlarge|ml.r6g.12xlarge|ml.r6g.16xlarge|ml.r6gd.large|ml.r6gd.xlarge|ml.r6gd.2xlarge|ml.r6gd.4xlarge|ml.r6gd.8xlarge|ml.r6gd.12xlarge|ml.r6gd.16xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.r7gd.medium|ml.r7gd.large|ml.r7gd.xlarge|ml.r7gd.2xlarge|ml.r7gd.4xlarge|ml.r7gd.8xlarge|ml.r7gd.12xlarge|ml.r7gd.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.c6in.large|ml.c6in.xlarge|ml.c6in.2xlarge|ml.c6in.4xlarge|ml.c6in.8xlarge|ml.c6in.12xlarge|ml.c6in.16xlarge|ml.c6in.24xlarge|ml.c6in.32xlarge|ml.p6-b200.48xlarge|ml.p6-b300.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge',
'ManagedInstanceScaling' => [
'MaxInstanceCount' => ,
'MinInstanceCount' => ,
'ScaleInPolicy' => [
'CooldownInMinutes' => ,
'MaximumStepSize' => ,
'Strategy' => 'IDLE_RELEASE|CONSOLIDATION',
],
'Status' => 'ENABLED|DISABLED',
],
'RoutingConfig' => [
'PrefixAwareRoutingConfig' => [
'ConcurrencyThreshold' => ,
'PrefixLength' => ,
],
'RoutingStrategy' => 'LEAST_OUTSTANDING_REQUESTS|RANDOM|PREFIX_AWARE',
],
'VariantName' => '',
'VariantStatus' => [
[
'StartTime' => ,
'Status' => 'Creating|Updating|Deleting|ActivatingTraffic|Baking',
'StatusMessage' => '',
],
// ...
],
],
// ...
],
'ShadowProductionVariants' => [
[
'AcceleratorType' => 'ml.eia1.medium|ml.eia1.large|ml.eia1.xlarge|ml.eia2.medium|ml.eia2.large|ml.eia2.xlarge',
'CurrentInstanceCount' => ,
'CurrentServerlessConfig' => [
'MaxConcurrency' => ,
'MemorySizeInMB' => ,
'ProvisionedConcurrency' => ,
],
'CurrentWeight' => ,
'DeployedImages' => [
[
'ResolutionTime' => ,
'ResolvedImage' => '',
'SpecifiedImage' => '',
],
// ...
],
'DesiredInstanceCount' => ,
'DesiredServerlessConfig' => [
'MaxConcurrency' => ,
'MemorySizeInMB' => ,
'ProvisionedConcurrency' => ,
],
'DesiredWeight' => ,
'InstancePools' => [
[
'CurrentInstanceCount' => ,
'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.12xlarge|ml.m5d.24xlarge|ml.c4.large|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.large|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.12xlarge|ml.r5.24xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.12xlarge|ml.r5d.24xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.dl1.24xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.r8g.medium|ml.r8g.large|ml.r8g.xlarge|ml.r8g.2xlarge|ml.r8g.4xlarge|ml.r8g.8xlarge|ml.r8g.12xlarge|ml.r8g.16xlarge|ml.r8g.24xlarge|ml.r8g.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.p4d.24xlarge|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m6gd.large|ml.m6gd.xlarge|ml.m6gd.2xlarge|ml.m6gd.4xlarge|ml.m6gd.8xlarge|ml.m6gd.12xlarge|ml.m6gd.16xlarge|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c6gd.large|ml.c6gd.xlarge|ml.c6gd.2xlarge|ml.c6gd.4xlarge|ml.c6gd.8xlarge|ml.c6gd.12xlarge|ml.c6gd.16xlarge|ml.c6gn.large|ml.c6gn.xlarge|ml.c6gn.2xlarge|ml.c6gn.4xlarge|ml.c6gn.8xlarge|ml.c6gn.12xlarge|ml.c6gn.16xlarge|ml.r6g.large|ml.r6g.xlarge|ml.r6g.2xlarge|ml.r6g.4xlarge|ml.r6g.8xlarge|ml.r6g.12xlarge|ml.r6g.16xlarge|ml.r6gd.large|ml.r6gd.xlarge|ml.r6gd.2xlarge|ml.r6gd.4xlarge|ml.r6gd.8xlarge|ml.r6gd.12xlarge|ml.r6gd.16xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.r7gd.medium|ml.r7gd.large|ml.r7gd.xlarge|ml.r7gd.2xlarge|ml.r7gd.4xlarge|ml.r7gd.8xlarge|ml.r7gd.12xlarge|ml.r7gd.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.c6in.large|ml.c6in.xlarge|ml.c6in.2xlarge|ml.c6in.4xlarge|ml.c6in.8xlarge|ml.c6in.12xlarge|ml.c6in.16xlarge|ml.c6in.24xlarge|ml.c6in.32xlarge|ml.p6-b200.48xlarge|ml.p6-b300.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge',
],
// ...
],
'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.12xlarge|ml.m5d.24xlarge|ml.c4.large|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.large|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.12xlarge|ml.r5.24xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.12xlarge|ml.r5d.24xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.dl1.24xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.r8g.medium|ml.r8g.large|ml.r8g.xlarge|ml.r8g.2xlarge|ml.r8g.4xlarge|ml.r8g.8xlarge|ml.r8g.12xlarge|ml.r8g.16xlarge|ml.r8g.24xlarge|ml.r8g.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.p4d.24xlarge|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m6gd.large|ml.m6gd.xlarge|ml.m6gd.2xlarge|ml.m6gd.4xlarge|ml.m6gd.8xlarge|ml.m6gd.12xlarge|ml.m6gd.16xlarge|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c6gd.large|ml.c6gd.xlarge|ml.c6gd.2xlarge|ml.c6gd.4xlarge|ml.c6gd.8xlarge|ml.c6gd.12xlarge|ml.c6gd.16xlarge|ml.c6gn.large|ml.c6gn.xlarge|ml.c6gn.2xlarge|ml.c6gn.4xlarge|ml.c6gn.8xlarge|ml.c6gn.12xlarge|ml.c6gn.16xlarge|ml.r6g.large|ml.r6g.xlarge|ml.r6g.2xlarge|ml.r6g.4xlarge|ml.r6g.8xlarge|ml.r6g.12xlarge|ml.r6g.16xlarge|ml.r6gd.large|ml.r6gd.xlarge|ml.r6gd.2xlarge|ml.r6gd.4xlarge|ml.r6gd.8xlarge|ml.r6gd.12xlarge|ml.r6gd.16xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.r7gd.medium|ml.r7gd.large|ml.r7gd.xlarge|ml.r7gd.2xlarge|ml.r7gd.4xlarge|ml.r7gd.8xlarge|ml.r7gd.12xlarge|ml.r7gd.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.c6in.large|ml.c6in.xlarge|ml.c6in.2xlarge|ml.c6in.4xlarge|ml.c6in.8xlarge|ml.c6in.12xlarge|ml.c6in.16xlarge|ml.c6in.24xlarge|ml.c6in.32xlarge|ml.p6-b200.48xlarge|ml.p6-b300.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge',
'ManagedInstanceScaling' => [
'MaxInstanceCount' => ,
'MinInstanceCount' => ,
'ScaleInPolicy' => [
'CooldownInMinutes' => ,
'MaximumStepSize' => ,
'Strategy' => 'IDLE_RELEASE|CONSOLIDATION',
],
'Status' => 'ENABLED|DISABLED',
],
'RoutingConfig' => [
'PrefixAwareRoutingConfig' => [
'ConcurrencyThreshold' => ,
'PrefixLength' => ,
],
'RoutingStrategy' => 'LEAST_OUTSTANDING_REQUESTS|RANDOM|PREFIX_AWARE',
],
'VariantName' => '',
'VariantStatus' => [
[
'StartTime' => ,
'Status' => 'Creating|Updating|Deleting|ActivatingTraffic|Baking',
'StatusMessage' => '',
],
// ...
],
],
// ...
],
'StartTime' => ,
],
'ProductionVariants' => [
[
'CapacityReservationConfig' => [
'AvailableInstanceCount' => ,
'CapacityReservationPreference' => 'capacity-reservations-only',
'Ec2CapacityReservations' => [
[
'AvailableInstanceCount' => ,
'Ec2CapacityReservationId' => '',
'TotalInstanceCount' => ,
'UsedByCurrentEndpoint' => ,
],
// ...
],
'MlReservationArn' => '',
'TotalInstanceCount' => ,
'UsedByCurrentEndpoint' => ,
],
'CurrentInstanceCount' => ,
'CurrentServerlessConfig' => [
'MaxConcurrency' => ,
'MemorySizeInMB' => ,
'ProvisionedConcurrency' => ,
],
'CurrentWeight' => ,
'DeployedImages' => [
[
'ResolutionTime' => ,
'ResolvedImage' => '',
'SpecifiedImage' => '',
],
// ...
],
'DesiredInstanceCount' => ,
'DesiredServerlessConfig' => [
'MaxConcurrency' => ,
'MemorySizeInMB' => ,
'ProvisionedConcurrency' => ,
],
'DesiredWeight' => ,
'InstancePools' => [
[
'CurrentInstanceCount' => ,
'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.12xlarge|ml.m5d.24xlarge|ml.c4.large|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.large|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.12xlarge|ml.r5.24xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.12xlarge|ml.r5d.24xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.dl1.24xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.r8g.medium|ml.r8g.large|ml.r8g.xlarge|ml.r8g.2xlarge|ml.r8g.4xlarge|ml.r8g.8xlarge|ml.r8g.12xlarge|ml.r8g.16xlarge|ml.r8g.24xlarge|ml.r8g.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.p4d.24xlarge|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m6gd.large|ml.m6gd.xlarge|ml.m6gd.2xlarge|ml.m6gd.4xlarge|ml.m6gd.8xlarge|ml.m6gd.12xlarge|ml.m6gd.16xlarge|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c6gd.large|ml.c6gd.xlarge|ml.c6gd.2xlarge|ml.c6gd.4xlarge|ml.c6gd.8xlarge|ml.c6gd.12xlarge|ml.c6gd.16xlarge|ml.c6gn.large|ml.c6gn.xlarge|ml.c6gn.2xlarge|ml.c6gn.4xlarge|ml.c6gn.8xlarge|ml.c6gn.12xlarge|ml.c6gn.16xlarge|ml.r6g.large|ml.r6g.xlarge|ml.r6g.2xlarge|ml.r6g.4xlarge|ml.r6g.8xlarge|ml.r6g.12xlarge|ml.r6g.16xlarge|ml.r6gd.large|ml.r6gd.xlarge|ml.r6gd.2xlarge|ml.r6gd.4xlarge|ml.r6gd.8xlarge|ml.r6gd.12xlarge|ml.r6gd.16xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.r7gd.medium|ml.r7gd.large|ml.r7gd.xlarge|ml.r7gd.2xlarge|ml.r7gd.4xlarge|ml.r7gd.8xlarge|ml.r7gd.12xlarge|ml.r7gd.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.c6in.large|ml.c6in.xlarge|ml.c6in.2xlarge|ml.c6in.4xlarge|ml.c6in.8xlarge|ml.c6in.12xlarge|ml.c6in.16xlarge|ml.c6in.24xlarge|ml.c6in.32xlarge|ml.p6-b200.48xlarge|ml.p6-b300.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge',
],
// ...
],
'ManagedInstanceScaling' => [
'MaxInstanceCount' => ,
'MinInstanceCount' => ,
'ScaleInPolicy' => [
'CooldownInMinutes' => ,
'MaximumStepSize' => ,
'Strategy' => 'IDLE_RELEASE|CONSOLIDATION',
],
'Status' => 'ENABLED|DISABLED',
],
'RoutingConfig' => [
'PrefixAwareRoutingConfig' => [
'ConcurrencyThreshold' => ,
'PrefixLength' => ,
],
'RoutingStrategy' => 'LEAST_OUTSTANDING_REQUESTS|RANDOM|PREFIX_AWARE',
],
'VariantName' => '',
'VariantStatus' => [
[
'StartTime' => ,
'Status' => 'Creating|Updating|Deleting|ActivatingTraffic|Baking',
'StatusMessage' => '',
],
// ...
],
],
// ...
],
'ShadowProductionVariants' => [
[
'CapacityReservationConfig' => [
'AvailableInstanceCount' => ,
'CapacityReservationPreference' => 'capacity-reservations-only',
'Ec2CapacityReservations' => [
[
'AvailableInstanceCount' => ,
'Ec2CapacityReservationId' => '',
'TotalInstanceCount' => ,
'UsedByCurrentEndpoint' => ,
],
// ...
],
'MlReservationArn' => '',
'TotalInstanceCount' => ,
'UsedByCurrentEndpoint' => ,
],
'CurrentInstanceCount' => ,
'CurrentServerlessConfig' => [
'MaxConcurrency' => ,
'MemorySizeInMB' => ,
'ProvisionedConcurrency' => ,
],
'CurrentWeight' => ,
'DeployedImages' => [
[
'ResolutionTime' => ,
'ResolvedImage' => '',
'SpecifiedImage' => '',
],
// ...
],
'DesiredInstanceCount' => ,
'DesiredServerlessConfig' => [
'MaxConcurrency' => ,
'MemorySizeInMB' => ,
'ProvisionedConcurrency' => ,
],
'DesiredWeight' => ,
'InstancePools' => [
[
'CurrentInstanceCount' => ,
'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.12xlarge|ml.m5d.24xlarge|ml.c4.large|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.large|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.12xlarge|ml.r5.24xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.12xlarge|ml.r5d.24xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.dl1.24xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.r8g.medium|ml.r8g.large|ml.r8g.xlarge|ml.r8g.2xlarge|ml.r8g.4xlarge|ml.r8g.8xlarge|ml.r8g.12xlarge|ml.r8g.16xlarge|ml.r8g.24xlarge|ml.r8g.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.p4d.24xlarge|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m6gd.large|ml.m6gd.xlarge|ml.m6gd.2xlarge|ml.m6gd.4xlarge|ml.m6gd.8xlarge|ml.m6gd.12xlarge|ml.m6gd.16xlarge|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c6gd.large|ml.c6gd.xlarge|ml.c6gd.2xlarge|ml.c6gd.4xlarge|ml.c6gd.8xlarge|ml.c6gd.12xlarge|ml.c6gd.16xlarge|ml.c6gn.large|ml.c6gn.xlarge|ml.c6gn.2xlarge|ml.c6gn.4xlarge|ml.c6gn.8xlarge|ml.c6gn.12xlarge|ml.c6gn.16xlarge|ml.r6g.large|ml.r6g.xlarge|ml.r6g.2xlarge|ml.r6g.4xlarge|ml.r6g.8xlarge|ml.r6g.12xlarge|ml.r6g.16xlarge|ml.r6gd.large|ml.r6gd.xlarge|ml.r6gd.2xlarge|ml.r6gd.4xlarge|ml.r6gd.8xlarge|ml.r6gd.12xlarge|ml.r6gd.16xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.r7gd.medium|ml.r7gd.large|ml.r7gd.xlarge|ml.r7gd.2xlarge|ml.r7gd.4xlarge|ml.r7gd.8xlarge|ml.r7gd.12xlarge|ml.r7gd.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.c6in.large|ml.c6in.xlarge|ml.c6in.2xlarge|ml.c6in.4xlarge|ml.c6in.8xlarge|ml.c6in.12xlarge|ml.c6in.16xlarge|ml.c6in.24xlarge|ml.c6in.32xlarge|ml.p6-b200.48xlarge|ml.p6-b300.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge',
],
// ...
],
'ManagedInstanceScaling' => [
'MaxInstanceCount' => ,
'MinInstanceCount' => ,
'ScaleInPolicy' => [
'CooldownInMinutes' => ,
'MaximumStepSize' => ,
'Strategy' => 'IDLE_RELEASE|CONSOLIDATION',
],
'Status' => 'ENABLED|DISABLED',
],
'RoutingConfig' => [
'PrefixAwareRoutingConfig' => [
'ConcurrencyThreshold' => ,
'PrefixLength' => ,
],
'RoutingStrategy' => 'LEAST_OUTSTANDING_REQUESTS|RANDOM|PREFIX_AWARE',
],
'VariantName' => '',
'VariantStatus' => [
[
'StartTime' => ,
'Status' => 'Creating|Updating|Deleting|ActivatingTraffic|Baking',
'StatusMessage' => '',
],
// ...
],
],
// ...
],
]
Result Details
Members
- AsyncInferenceConfig
-
- Type: AsyncInferenceConfig structure
Returns the description of an endpoint configuration created using the
CreateEndpointConfigAPI. - CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that shows when the endpoint was created.
- DataCaptureConfig
-
- Type: DataCaptureConfigSummary structure
The currently active data capture configuration used by your Endpoint.
- EndpointArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the endpoint.
- EndpointConfigName
-
- Type: string
The name of the endpoint configuration associated with this endpoint.
- EndpointName
-
- Required: Yes
- Type: string
Name of the endpoint.
- EndpointStatus
-
- Required: Yes
- Type: string
The status of the endpoint.
-
OutOfService: Endpoint is not available to take incoming requests. -
Creating: CreateEndpoint is executing. -
Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing. -
SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count. -
RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to anInServicestatus. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly. -
InService: Endpoint is available to process incoming requests. -
Deleting: DeleteEndpoint is executing. -
Failed: Endpoint could not be created, updated, or re-scaled. Use theFailureReasonvalue returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint. -
UpdateRollbackFailed: Both the rolling deployment and auto-rollback failed. Your endpoint is in service with a mix of the old and new endpoint configurations. For information about how to remedy this issue and restore the endpoint's status toInService, see Rolling Deployments.
- ExplainerConfig
-
- Type: ExplainerConfig structure
The configuration parameters for an explainer.
- FailureReason
-
- Type: string
If the status of the endpoint is
Failed, the reason why it failed. - LastDeploymentConfig
-
- Type: DeploymentConfig structure
The most recent deployment configuration for the endpoint.
- LastModifiedTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that shows when the endpoint was last modified.
- MetricsConfig
-
- Type: MetricsConfig structure
The configuration parameters for utilization metrics.
- PendingDeploymentSummary
-
- Type: PendingDeploymentSummary structure
Returns the summary of an in-progress deployment. This field is only returned when the endpoint is creating or updating with a new endpoint configuration.
- ProductionVariants
-
- Type: Array of ProductionVariantSummary structures
An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
- ShadowProductionVariants
-
- Type: Array of ProductionVariantSummary structures
An array of ProductionVariantSummary objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on
ProductionVariants.
Errors
There are no errors described for this operation.
DescribeEndpointConfig
$result = $client->describeEndpointConfig([/* ... */]); $promise = $client->describeEndpointConfigAsync([/* ... */]);
Returns the description of an endpoint configuration created using the CreateEndpointConfig API.
Parameter Syntax
$result = $client->describeEndpointConfig([
'EndpointConfigName' => '', // REQUIRED
]);
Parameter Details
Members
- EndpointConfigName
-
- Required: Yes
- Type: string
The name of the endpoint configuration.
Result Syntax
[
'AsyncInferenceConfig' => [
'ClientConfig' => [
'MaxConcurrentInvocationsPerInstance' => ,
],
'OutputConfig' => [
'KmsKeyId' => '',
'NotificationConfig' => [
'ErrorTopic' => '',
'IncludeInferenceResponseIn' => ['', ...],
'SuccessTopic' => '',
],
'S3FailurePath' => '',
'S3OutputPath' => '',
],
],
'CreationTime' => ,
'DataCaptureConfig' => [
'CaptureContentTypeHeader' => [
'CsvContentTypes' => ['', ...],
'JsonContentTypes' => ['', ...],
],
'CaptureOptions' => [
[
'CaptureMode' => 'Input|Output|InputAndOutput',
],
// ...
],
'DestinationS3Uri' => '',
'EnableCapture' => true || false,
'InitialSamplingPercentage' => ,
'KmsKeyId' => '',
],
'EnableNetworkIsolation' => true || false,
'EndpointConfigArn' => '',
'EndpointConfigName' => '',
'ExecutionRoleArn' => '',
'ExplainerConfig' => [
'ClarifyExplainerConfig' => [
'EnableExplanations' => '',
'InferenceConfig' => [
'ContentTemplate' => '',
'FeatureHeaders' => ['', ...],
'FeatureTypes' => ['', ...],
'FeaturesAttribute' => '',
'LabelAttribute' => '',
'LabelHeaders' => ['', ...],
'LabelIndex' => ,
'MaxPayloadInMB' => ,
'MaxRecordCount' => ,
'ProbabilityAttribute' => '',
'ProbabilityIndex' => ,
],
'ShapConfig' => [
'NumberOfSamples' => ,
'Seed' => ,
'ShapBaselineConfig' => [
'MimeType' => '',
'ShapBaseline' => '',
'ShapBaselineUri' => '',
],
'TextConfig' => [
'Granularity' => 'token|sentence|paragraph',
'Language' => 'af|sq|ar|hy|eu|bn|bg|ca|zh|hr|cs|da|nl|en|et|fi|fr|de|el|gu|he|hi|hu|is|id|ga|it|kn|ky|lv|lt|lb|mk|ml|mr|ne|nb|fa|pl|pt|ro|ru|sa|sr|tn|si|sk|sl|es|sv|tl|ta|tt|te|tr|uk|ur|yo|lij|xx',
],
'UseLogit' => true || false,
],
],
],
'KmsKeyId' => '',
'MetricsConfig' => [
'EnableDetailedObservability' => true || false,
'EnableEnhancedMetrics' => true || false,
'MetricPublishFrequencyInSeconds' => ,
],
'ProductionVariants' => [
[
'AcceleratorType' => 'ml.eia1.medium|ml.eia1.large|ml.eia1.xlarge|ml.eia2.medium|ml.eia2.large|ml.eia2.xlarge',
'CapacityReservationConfig' => [
'CapacityReservationPreference' => 'capacity-reservations-only',
'MlReservationArn' => '',
],
'ContainerStartupHealthCheckTimeoutInSeconds' => ,
'CoreDumpConfig' => [
'DestinationS3Uri' => '',
'KmsKeyId' => '',
],
'EnableSSMAccess' => true || false,
'InferenceAmiVersion' => 'al2-ami-sagemaker-inference-gpu-2|al2-ami-sagemaker-inference-gpu-2-1|al2-ami-sagemaker-inference-gpu-3-1|al2-ami-sagemaker-inference-neuron-2|al2023-ami-sagemaker-inference-gpu-4-1',
'InitialInstanceCount' => ,
'InitialVariantWeight' => ,
'InstancePools' => [
[
'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.12xlarge|ml.m5d.24xlarge|ml.c4.large|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.large|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.12xlarge|ml.r5.24xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.12xlarge|ml.r5d.24xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.dl1.24xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.r8g.medium|ml.r8g.large|ml.r8g.xlarge|ml.r8g.2xlarge|ml.r8g.4xlarge|ml.r8g.8xlarge|ml.r8g.12xlarge|ml.r8g.16xlarge|ml.r8g.24xlarge|ml.r8g.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.p4d.24xlarge|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m6gd.large|ml.m6gd.xlarge|ml.m6gd.2xlarge|ml.m6gd.4xlarge|ml.m6gd.8xlarge|ml.m6gd.12xlarge|ml.m6gd.16xlarge|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c6gd.large|ml.c6gd.xlarge|ml.c6gd.2xlarge|ml.c6gd.4xlarge|ml.c6gd.8xlarge|ml.c6gd.12xlarge|ml.c6gd.16xlarge|ml.c6gn.large|ml.c6gn.xlarge|ml.c6gn.2xlarge|ml.c6gn.4xlarge|ml.c6gn.8xlarge|ml.c6gn.12xlarge|ml.c6gn.16xlarge|ml.r6g.large|ml.r6g.xlarge|ml.r6g.2xlarge|ml.r6g.4xlarge|ml.r6g.8xlarge|ml.r6g.12xlarge|ml.r6g.16xlarge|ml.r6gd.large|ml.r6gd.xlarge|ml.r6gd.2xlarge|ml.r6gd.4xlarge|ml.r6gd.8xlarge|ml.r6gd.12xlarge|ml.r6gd.16xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.r7gd.medium|ml.r7gd.large|ml.r7gd.xlarge|ml.r7gd.2xlarge|ml.r7gd.4xlarge|ml.r7gd.8xlarge|ml.r7gd.12xlarge|ml.r7gd.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.c6in.large|ml.c6in.xlarge|ml.c6in.2xlarge|ml.c6in.4xlarge|ml.c6in.8xlarge|ml.c6in.12xlarge|ml.c6in.16xlarge|ml.c6in.24xlarge|ml.c6in.32xlarge|ml.p6-b200.48xlarge|ml.p6-b300.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge',
'ModelNameOverride' => '',
'Priority' => ,
],
// ...
],
'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.12xlarge|ml.m5d.24xlarge|ml.c4.large|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.large|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.12xlarge|ml.r5.24xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.12xlarge|ml.r5d.24xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.dl1.24xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.r8g.medium|ml.r8g.large|ml.r8g.xlarge|ml.r8g.2xlarge|ml.r8g.4xlarge|ml.r8g.8xlarge|ml.r8g.12xlarge|ml.r8g.16xlarge|ml.r8g.24xlarge|ml.r8g.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.p4d.24xlarge|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m6gd.large|ml.m6gd.xlarge|ml.m6gd.2xlarge|ml.m6gd.4xlarge|ml.m6gd.8xlarge|ml.m6gd.12xlarge|ml.m6gd.16xlarge|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c6gd.large|ml.c6gd.xlarge|ml.c6gd.2xlarge|ml.c6gd.4xlarge|ml.c6gd.8xlarge|ml.c6gd.12xlarge|ml.c6gd.16xlarge|ml.c6gn.large|ml.c6gn.xlarge|ml.c6gn.2xlarge|ml.c6gn.4xlarge|ml.c6gn.8xlarge|ml.c6gn.12xlarge|ml.c6gn.16xlarge|ml.r6g.large|ml.r6g.xlarge|ml.r6g.2xlarge|ml.r6g.4xlarge|ml.r6g.8xlarge|ml.r6g.12xlarge|ml.r6g.16xlarge|ml.r6gd.large|ml.r6gd.xlarge|ml.r6gd.2xlarge|ml.r6gd.4xlarge|ml.r6gd.8xlarge|ml.r6gd.12xlarge|ml.r6gd.16xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.r7gd.medium|ml.r7gd.large|ml.r7gd.xlarge|ml.r7gd.2xlarge|ml.r7gd.4xlarge|ml.r7gd.8xlarge|ml.r7gd.12xlarge|ml.r7gd.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.c6in.large|ml.c6in.xlarge|ml.c6in.2xlarge|ml.c6in.4xlarge|ml.c6in.8xlarge|ml.c6in.12xlarge|ml.c6in.16xlarge|ml.c6in.24xlarge|ml.c6in.32xlarge|ml.p6-b200.48xlarge|ml.p6-b300.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge',
'ManagedInstanceScaling' => [
'MaxInstanceCount' => ,
'MinInstanceCount' => ,
'ScaleInPolicy' => [
'CooldownInMinutes' => ,
'MaximumStepSize' => ,
'Strategy' => 'IDLE_RELEASE|CONSOLIDATION',
],
'Status' => 'ENABLED|DISABLED',
],
'ModelDataDownloadTimeoutInSeconds' => ,
'ModelName' => '',
'RoutingConfig' => [
'PrefixAwareRoutingConfig' => [
'ConcurrencyThreshold' => ,
'PrefixLength' => ,
],
'RoutingStrategy' => 'LEAST_OUTSTANDING_REQUESTS|RANDOM|PREFIX_AWARE',
],
'ServerlessConfig' => [
'MaxConcurrency' => ,
'MemorySizeInMB' => ,
'ProvisionedConcurrency' => ,
],
'VariantInstanceProvisionTimeoutInSeconds' => ,
'VariantName' => '',
'VolumeSizeInGB' => ,
],
// ...
],
'ShadowProductionVariants' => [
[
'AcceleratorType' => 'ml.eia1.medium|ml.eia1.large|ml.eia1.xlarge|ml.eia2.medium|ml.eia2.large|ml.eia2.xlarge',
'CapacityReservationConfig' => [
'CapacityReservationPreference' => 'capacity-reservations-only',
'MlReservationArn' => '',
],
'ContainerStartupHealthCheckTimeoutInSeconds' => ,
'CoreDumpConfig' => [
'DestinationS3Uri' => '',
'KmsKeyId' => '',
],
'EnableSSMAccess' => true || false,
'InferenceAmiVersion' => 'al2-ami-sagemaker-inference-gpu-2|al2-ami-sagemaker-inference-gpu-2-1|al2-ami-sagemaker-inference-gpu-3-1|al2-ami-sagemaker-inference-neuron-2|al2023-ami-sagemaker-inference-gpu-4-1',
'InitialInstanceCount' => ,
'InitialVariantWeight' => ,
'InstancePools' => [
[
'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.12xlarge|ml.m5d.24xlarge|ml.c4.large|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.large|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.12xlarge|ml.r5.24xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.12xlarge|ml.r5d.24xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.dl1.24xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.r8g.medium|ml.r8g.large|ml.r8g.xlarge|ml.r8g.2xlarge|ml.r8g.4xlarge|ml.r8g.8xlarge|ml.r8g.12xlarge|ml.r8g.16xlarge|ml.r8g.24xlarge|ml.r8g.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.p4d.24xlarge|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m6gd.large|ml.m6gd.xlarge|ml.m6gd.2xlarge|ml.m6gd.4xlarge|ml.m6gd.8xlarge|ml.m6gd.12xlarge|ml.m6gd.16xlarge|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c6gd.large|ml.c6gd.xlarge|ml.c6gd.2xlarge|ml.c6gd.4xlarge|ml.c6gd.8xlarge|ml.c6gd.12xlarge|ml.c6gd.16xlarge|ml.c6gn.large|ml.c6gn.xlarge|ml.c6gn.2xlarge|ml.c6gn.4xlarge|ml.c6gn.8xlarge|ml.c6gn.12xlarge|ml.c6gn.16xlarge|ml.r6g.large|ml.r6g.xlarge|ml.r6g.2xlarge|ml.r6g.4xlarge|ml.r6g.8xlarge|ml.r6g.12xlarge|ml.r6g.16xlarge|ml.r6gd.large|ml.r6gd.xlarge|ml.r6gd.2xlarge|ml.r6gd.4xlarge|ml.r6gd.8xlarge|ml.r6gd.12xlarge|ml.r6gd.16xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.r7gd.medium|ml.r7gd.large|ml.r7gd.xlarge|ml.r7gd.2xlarge|ml.r7gd.4xlarge|ml.r7gd.8xlarge|ml.r7gd.12xlarge|ml.r7gd.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.c6in.large|ml.c6in.xlarge|ml.c6in.2xlarge|ml.c6in.4xlarge|ml.c6in.8xlarge|ml.c6in.12xlarge|ml.c6in.16xlarge|ml.c6in.24xlarge|ml.c6in.32xlarge|ml.p6-b200.48xlarge|ml.p6-b300.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge',
'ModelNameOverride' => '',
'Priority' => ,
],
// ...
],
'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.12xlarge|ml.m5d.24xlarge|ml.c4.large|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.large|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.12xlarge|ml.r5.24xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.12xlarge|ml.r5d.24xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.dl1.24xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.r8g.medium|ml.r8g.large|ml.r8g.xlarge|ml.r8g.2xlarge|ml.r8g.4xlarge|ml.r8g.8xlarge|ml.r8g.12xlarge|ml.r8g.16xlarge|ml.r8g.24xlarge|ml.r8g.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.p4d.24xlarge|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m6gd.large|ml.m6gd.xlarge|ml.m6gd.2xlarge|ml.m6gd.4xlarge|ml.m6gd.8xlarge|ml.m6gd.12xlarge|ml.m6gd.16xlarge|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c6gd.large|ml.c6gd.xlarge|ml.c6gd.2xlarge|ml.c6gd.4xlarge|ml.c6gd.8xlarge|ml.c6gd.12xlarge|ml.c6gd.16xlarge|ml.c6gn.large|ml.c6gn.xlarge|ml.c6gn.2xlarge|ml.c6gn.4xlarge|ml.c6gn.8xlarge|ml.c6gn.12xlarge|ml.c6gn.16xlarge|ml.r6g.large|ml.r6g.xlarge|ml.r6g.2xlarge|ml.r6g.4xlarge|ml.r6g.8xlarge|ml.r6g.12xlarge|ml.r6g.16xlarge|ml.r6gd.large|ml.r6gd.xlarge|ml.r6gd.2xlarge|ml.r6gd.4xlarge|ml.r6gd.8xlarge|ml.r6gd.12xlarge|ml.r6gd.16xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.r7gd.medium|ml.r7gd.large|ml.r7gd.xlarge|ml.r7gd.2xlarge|ml.r7gd.4xlarge|ml.r7gd.8xlarge|ml.r7gd.12xlarge|ml.r7gd.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.c6in.large|ml.c6in.xlarge|ml.c6in.2xlarge|ml.c6in.4xlarge|ml.c6in.8xlarge|ml.c6in.12xlarge|ml.c6in.16xlarge|ml.c6in.24xlarge|ml.c6in.32xlarge|ml.p6-b200.48xlarge|ml.p6-b300.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge',
'ManagedInstanceScaling' => [
'MaxInstanceCount' => ,
'MinInstanceCount' => ,
'ScaleInPolicy' => [
'CooldownInMinutes' => ,
'MaximumStepSize' => ,
'Strategy' => 'IDLE_RELEASE|CONSOLIDATION',
],
'Status' => 'ENABLED|DISABLED',
],
'ModelDataDownloadTimeoutInSeconds' => ,
'ModelName' => '',
'RoutingConfig' => [
'PrefixAwareRoutingConfig' => [
'ConcurrencyThreshold' => ,
'PrefixLength' => ,
],
'RoutingStrategy' => 'LEAST_OUTSTANDING_REQUESTS|RANDOM|PREFIX_AWARE',
],
'ServerlessConfig' => [
'MaxConcurrency' => ,
'MemorySizeInMB' => ,
'ProvisionedConcurrency' => ,
],
'VariantInstanceProvisionTimeoutInSeconds' => ,
'VariantName' => '',
'VolumeSizeInGB' => ,
],
// ...
],
'VpcConfig' => [
'SecurityGroupIds' => ['', ...],
'Subnets' => ['', ...],
],
]
Result Details
Members
- AsyncInferenceConfig
-
- Type: AsyncInferenceConfig structure
Returns the description of an endpoint configuration created using the
CreateEndpointConfigAPI. - CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that shows when the endpoint configuration was created.
- DataCaptureConfig
-
- Type: DataCaptureConfig structure
Configuration to control how SageMaker AI captures inference data.
- EnableNetworkIsolation
-
- Type: boolean
Indicates whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound network calls can be made to or from the model containers.
- EndpointConfigArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the endpoint configuration.
- EndpointConfigName
-
- Required: Yes
- Type: string
Name of the SageMaker endpoint configuration.
- ExecutionRoleArn
-
- Type: string
The Amazon Resource Name (ARN) of the IAM role that you assigned to the endpoint configuration.
- ExplainerConfig
-
- Type: ExplainerConfig structure
The configuration parameters for an explainer.
- KmsKeyId
-
- Type: string
Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
- MetricsConfig
-
- Type: MetricsConfig structure
The configuration parameters for utilization metrics.
- ProductionVariants
-
- Required: Yes
- Type: Array of ProductionVariant structures
An array of
ProductionVariantobjects, one for each model that you want to host at this endpoint. - ShadowProductionVariants
-
- Type: Array of ProductionVariant structures
An array of
ProductionVariantobjects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified onProductionVariants. - VpcConfig
-
- Type: VpcConfig structure
Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.
Errors
There are no errors described for this operation.
DescribeExperiment
$result = $client->describeExperiment([/* ... */]); $promise = $client->describeExperimentAsync([/* ... */]);
Provides a list of an experiment's properties.
Parameter Syntax
$result = $client->describeExperiment([
'ExperimentName' => '', // REQUIRED
]);
Parameter Details
Members
- ExperimentName
-
- Required: Yes
- Type: string
The name of the experiment to describe.
Result Syntax
[
'CreatedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'CreationTime' => ,
'Description' => '',
'DisplayName' => '',
'ExperimentArn' => '',
'ExperimentName' => '',
'LastModifiedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'LastModifiedTime' => ,
'Source' => [
'SourceArn' => '',
'SourceType' => '',
],
]
Result Details
Members
- CreatedBy
-
- Type: UserContext structure
Who created the experiment.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the experiment was created.
- Description
-
- Type: string
The description of the experiment.
- DisplayName
-
- Type: string
The name of the experiment as displayed. If
DisplayNameisn't specified,ExperimentNameis displayed. - ExperimentArn
-
- Type: string
The Amazon Resource Name (ARN) of the experiment.
- ExperimentName
-
- Type: string
The name of the experiment.
- LastModifiedBy
-
- Type: UserContext structure
Who last modified the experiment.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the experiment was last modified.
- Source
-
- Type: ExperimentSource structure
The Amazon Resource Name (ARN) of the source and, optionally, the type.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeFeatureGroup
$result = $client->describeFeatureGroup([/* ... */]); $promise = $client->describeFeatureGroupAsync([/* ... */]);
Use this operation to describe a FeatureGroup. The response includes information on the creation time, FeatureGroup name, the unique identifier for each FeatureGroup, and more.
Parameter Syntax
$result = $client->describeFeatureGroup([
'FeatureGroupName' => '', // REQUIRED
'NextToken' => '',
]);
Parameter Details
Members
- FeatureGroupName
-
- Required: Yes
- Type: string
The name or Amazon Resource Name (ARN) of the
FeatureGroupyou want described. - NextToken
-
- Type: string
A token to resume pagination of the list of
Features(FeatureDefinitions). 2,500Featuresare returned by default.
Result Syntax
[
'CreationTime' => ,
'Description' => '',
'EventTimeFeatureName' => '',
'FailureReason' => '',
'FeatureDefinitions' => [
[
'CollectionConfig' => [
'VectorConfig' => [
'Dimension' => ,
],
],
'CollectionType' => 'List|Set|Vector',
'FeatureName' => '',
'FeatureType' => 'Integral|Fractional|String',
],
// ...
],
'FeatureGroupArn' => '',
'FeatureGroupName' => '',
'FeatureGroupStatus' => 'Creating|Created|CreateFailed|Deleting|DeleteFailed',
'LastModifiedTime' => ,
'LastUpdateStatus' => [
'FailureReason' => '',
'Status' => 'Successful|Failed|InProgress',
],
'NextToken' => '',
'OfflineStoreConfig' => [
'DataCatalogConfig' => [
'Catalog' => '',
'Database' => '',
'TableName' => '',
],
'DisableGlueTableCreation' => true || false,
'S3StorageConfig' => [
'KmsKeyId' => '',
'ResolvedOutputS3Uri' => '',
'S3Uri' => '',
],
'TableFormat' => 'Default|Glue|Iceberg',
],
'OfflineStoreStatus' => [
'BlockedReason' => '',
'Status' => 'Active|Blocked|Disabled',
],
'OnlineStoreConfig' => [
'EnableOnlineStore' => true || false,
'SecurityConfig' => [
'KmsKeyId' => '',
],
'StorageType' => 'Standard|Standard_V2|InMemory',
'TtlDuration' => [
'Unit' => 'Seconds|Minutes|Hours|Days|Weeks',
'Value' => ,
],
],
'OnlineStoreTotalSizeBytes' => ,
'RecordIdentifierFeatureName' => '',
'RoleArn' => '',
'ThroughputConfig' => [
'ProvisionedReadCapacityUnits' => ,
'ProvisionedWriteCapacityUnits' => ,
'ThroughputMode' => 'OnDemand|Provisioned',
],
]
Result Details
Members
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp indicating when SageMaker created the
FeatureGroup. - Description
-
- Type: string
A free form description of the feature group.
- EventTimeFeatureName
-
- Required: Yes
- Type: string
The name of the feature that stores the
EventTimeof a Record in aFeatureGroup.An
EventTimeis a point in time when a new event occurs that corresponds to the creation or update of aRecordin aFeatureGroup. AllRecordsin theFeatureGrouphave a correspondingEventTime. - FailureReason
-
- Type: string
The reason that the
FeatureGroupfailed to be replicated in theOfflineStore. This is failure can occur because:-
The
FeatureGroupcould not be created in theOfflineStore. -
The
FeatureGroupcould not be deleted from theOfflineStore.
- FeatureDefinitions
-
- Required: Yes
- Type: Array of FeatureDefinition structures
A list of the
Featuresin theFeatureGroup. Each feature is defined by aFeatureNameandFeatureType. - FeatureGroupArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the
FeatureGroup. - FeatureGroupName
-
- Required: Yes
- Type: string
he name of the
FeatureGroup. - FeatureGroupStatus
-
- Type: string
The status of the feature group.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp indicating when the feature group was last updated.
- LastUpdateStatus
-
- Type: LastUpdateStatus structure
A value indicating whether the update made to the feature group was successful.
- NextToken
-
- Required: Yes
- Type: string
A token to resume pagination of the list of
Features(FeatureDefinitions). - OfflineStoreConfig
-
- Type: OfflineStoreConfig structure
The configuration of the offline store. It includes the following configurations:
-
Amazon S3 location of the offline store.
-
Configuration of the Glue data catalog.
-
Table format of the offline store.
-
Option to disable the automatic creation of a Glue table for the offline store.
-
Encryption configuration.
- OfflineStoreStatus
-
- Type: OfflineStoreStatus structure
The status of the
OfflineStore. Notifies you if replicating data into theOfflineStorehas failed. Returns either:ActiveorBlocked - OnlineStoreConfig
-
- Type: OnlineStoreConfig structure
The configuration for the
OnlineStore. - OnlineStoreTotalSizeBytes
-
- Type: long (int|float)
The size of the
OnlineStorein bytes. - RecordIdentifierFeatureName
-
- Required: Yes
- Type: string
The name of the
Featureused forRecordIdentifier, whose value uniquely identifies a record stored in the feature store. - RoleArn
-
- Type: string
The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.
- ThroughputConfig
-
- Type: ThroughputConfigDescription structure
Active throughput configuration of the feature group. There are two modes:
ON_DEMANDandPROVISIONED. With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.Note:
PROVISIONEDthroughput mode is supported only for feature groups that are offline-only, or use theStandardtier online store.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeFeatureMetadata
$result = $client->describeFeatureMetadata([/* ... */]); $promise = $client->describeFeatureMetadataAsync([/* ... */]);
Shows the metadata for a feature within a feature group.
Parameter Syntax
$result = $client->describeFeatureMetadata([
'FeatureGroupName' => '', // REQUIRED
'FeatureName' => '', // REQUIRED
]);
Parameter Details
Members
- FeatureGroupName
-
- Required: Yes
- Type: string
The name or Amazon Resource Name (ARN) of the feature group containing the feature.
- FeatureName
-
- Required: Yes
- Type: string
The name of the feature.
Result Syntax
[
'CreationTime' => ,
'Description' => '',
'FeatureGroupArn' => '',
'FeatureGroupName' => '',
'FeatureName' => '',
'FeatureType' => 'Integral|Fractional|String',
'LastModifiedTime' => ,
'Parameters' => [
[
'Key' => '',
'Value' => '',
],
// ...
],
]
Result Details
Members
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp indicating when the feature was created.
- Description
-
- Type: string
The description you added to describe the feature.
- FeatureGroupArn
-
- Required: Yes
- Type: string
The Amazon Resource Number (ARN) of the feature group that contains the feature.
- FeatureGroupName
-
- Required: Yes
- Type: string
The name of the feature group that you've specified.
- FeatureName
-
- Required: Yes
- Type: string
The name of the feature that you've specified.
- FeatureType
-
- Required: Yes
- Type: string
The data type of the feature.
- LastModifiedTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp indicating when the metadata for the feature group was modified. For example, if you add a parameter describing the feature, the timestamp changes to reflect the last time you
- Parameters
-
- Type: Array of FeatureParameter structures
The key-value pairs that you added to describe the feature.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeFlowDefinition
$result = $client->describeFlowDefinition([/* ... */]); $promise = $client->describeFlowDefinitionAsync([/* ... */]);
Returns information about the specified flow definition.
Parameter Syntax
$result = $client->describeFlowDefinition([
'FlowDefinitionName' => '', // REQUIRED
]);
Parameter Details
Members
- FlowDefinitionName
-
- Required: Yes
- Type: string
The name of the flow definition.
Result Syntax
[
'CreationTime' => ,
'FailureReason' => '',
'FlowDefinitionArn' => '',
'FlowDefinitionName' => '',
'FlowDefinitionStatus' => 'Initializing|Active|Failed|Deleting',
'HumanLoopActivationConfig' => [
'HumanLoopActivationConditionsConfig' => [
'HumanLoopActivationConditions' => '',
],
],
'HumanLoopConfig' => [
'HumanTaskUiArn' => '',
'PublicWorkforceTaskPrice' => [
'AmountInUsd' => [
'Cents' => ,
'Dollars' => ,
'TenthFractionsOfACent' => ,
],
],
'TaskAvailabilityLifetimeInSeconds' => ,
'TaskCount' => ,
'TaskDescription' => '',
'TaskKeywords' => ['', ...],
'TaskTimeLimitInSeconds' => ,
'TaskTitle' => '',
'WorkteamArn' => '',
],
'HumanLoopRequestSource' => [
'AwsManagedHumanLoopRequestSource' => 'AWS/Rekognition/DetectModerationLabels/Image/V3|AWS/Textract/AnalyzeDocument/Forms/V1',
],
'OutputConfig' => [
'KmsKeyId' => '',
'S3OutputPath' => '',
],
'RoleArn' => '',
]
Result Details
Members
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the flow definition was created.
- FailureReason
-
- Type: string
The reason your flow definition failed.
- FlowDefinitionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the flow defintion.
- FlowDefinitionName
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the flow definition.
- FlowDefinitionStatus
-
- Required: Yes
- Type: string
The status of the flow definition. Valid values are listed below.
- HumanLoopActivationConfig
-
- Type: HumanLoopActivationConfig structure
An object containing information about what triggers a human review workflow.
- HumanLoopConfig
-
- Type: HumanLoopConfig structure
An object containing information about who works on the task, the workforce task price, and other task details.
- HumanLoopRequestSource
-
- Type: HumanLoopRequestSource structure
Container for configuring the source of human task requests. Used to specify if Amazon Rekognition or Amazon Textract is used as an integration source.
- OutputConfig
-
- Required: Yes
- Type: FlowDefinitionOutputConfig structure
An object containing information about the output file.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeHub
$result = $client->describeHub([/* ... */]); $promise = $client->describeHubAsync([/* ... */]);
Describes a hub.
Parameter Syntax
$result = $client->describeHub([
'HubName' => '', // REQUIRED
]);
Parameter Details
Members
- HubName
-
- Required: Yes
- Type: string
The name of the hub to describe.
Result Syntax
[
'CreationTime' => ,
'FailureReason' => '',
'HubArn' => '',
'HubDescription' => '',
'HubDisplayName' => '',
'HubName' => '',
'HubSearchKeywords' => ['', ...],
'HubStatus' => 'InService|Creating|Updating|Deleting|CreateFailed|UpdateFailed|DeleteFailed',
'LastModifiedTime' => ,
'S3StorageConfig' => [
'S3OutputPath' => '',
],
]
Result Details
Members
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the hub was created.
- FailureReason
-
- Type: string
The failure reason if importing hub content failed.
- HubArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the hub.
- HubDescription
-
- Type: string
A description of the hub.
- HubDisplayName
-
- Type: string
The display name of the hub.
- HubName
-
- Required: Yes
- Type: string
The name of the hub.
- HubSearchKeywords
-
- Type: Array of strings
The searchable keywords for the hub.
- HubStatus
-
- Required: Yes
- Type: string
The status of the hub.
- LastModifiedTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the hub was last modified.
- S3StorageConfig
-
- Type: HubS3StorageConfig structure
The Amazon S3 storage configuration for the hub.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeHubContent
$result = $client->describeHubContent([/* ... */]); $promise = $client->describeHubContentAsync([/* ... */]);
Describe the content of a hub.
Parameter Syntax
$result = $client->describeHubContent([
'HubContentName' => '', // REQUIRED
'HubContentType' => 'Model|Notebook|ModelReference|DataSet|JsonDoc', // REQUIRED
'HubContentVersion' => '',
'HubName' => '', // REQUIRED
]);
Parameter Details
Members
- HubContentName
-
- Required: Yes
- Type: string
The name of the content to describe.
- HubContentType
-
- Required: Yes
- Type: string
The type of content in the hub.
- HubContentVersion
-
- Type: string
The version of the content to describe.
- HubName
-
- Required: Yes
- Type: string
The name of the hub that contains the content to describe.
Result Syntax
[
'CreationTime' => ,
'DocumentSchemaVersion' => '',
'FailureReason' => '',
'HubArn' => '',
'HubContentArn' => '',
'HubContentDependencies' => [
[
'DependencyCopyPath' => '',
'DependencyOriginPath' => '',
],
// ...
],
'HubContentDescription' => '',
'HubContentDisplayName' => '',
'HubContentDocument' => '',
'HubContentMarkdown' => '',
'HubContentName' => '',
'HubContentSearchKeywords' => ['', ...],
'HubContentStatus' => 'Available|Importing|Deleting|ImportFailed|DeleteFailed|PendingImport|PendingDelete',
'HubContentType' => 'Model|Notebook|ModelReference|DataSet|JsonDoc',
'HubContentVersion' => '',
'HubName' => '',
'LastModifiedTime' => ,
'ReferenceMinVersion' => '',
'SageMakerPublicHubContentArn' => '',
'SupportStatus' => 'Supported|Deprecated|Restricted',
]
Result Details
Members
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that hub content was created.
- DocumentSchemaVersion
-
- Required: Yes
- Type: string
The document schema version for the hub content.
- FailureReason
-
- Type: string
The failure reason if importing hub content failed.
- HubArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the hub that contains the content.
- HubContentArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the hub content.
- HubContentDependencies
-
- Type: Array of HubContentDependency structures
The location of any dependencies that the hub content has, such as scripts, model artifacts, datasets, or notebooks.
- HubContentDescription
-
- Type: string
A description of the hub content.
- HubContentDisplayName
-
- Type: string
The display name of the hub content.
- HubContentDocument
-
- Required: Yes
- Type: string
The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.
- HubContentMarkdown
-
- Type: string
A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.
- HubContentName
-
- Required: Yes
- Type: string
The name of the hub content.
- HubContentSearchKeywords
-
- Type: Array of strings
The searchable keywords for the hub content.
- HubContentStatus
-
- Required: Yes
- Type: string
The status of the hub content.
- HubContentType
-
- Required: Yes
- Type: string
The type of hub content.
- HubContentVersion
-
- Required: Yes
- Type: string
The version of the hub content.
- HubName
-
- Required: Yes
- Type: string
The name of the hub that contains the content.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last modified time of the hub content.
- ReferenceMinVersion
-
- Type: string
The minimum version of the hub content.
- SageMakerPublicHubContentArn
-
- Type: string
The ARN of the public hub content.
- SupportStatus
-
- Type: string
The support status of the hub content.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeHumanTaskUi
$result = $client->describeHumanTaskUi([/* ... */]); $promise = $client->describeHumanTaskUiAsync([/* ... */]);
Returns information about the requested human task user interface (worker task template).
Parameter Syntax
$result = $client->describeHumanTaskUi([
'HumanTaskUiName' => '', // REQUIRED
]);
Parameter Details
Members
- HumanTaskUiName
-
- Required: Yes
- Type: string
The name of the human task user interface (worker task template) you want information about.
Result Syntax
[
'CreationTime' => ,
'HumanTaskUiArn' => '',
'HumanTaskUiName' => '',
'HumanTaskUiStatus' => 'Active|Deleting',
'UiTemplate' => [
'ContentSha256' => '',
'Url' => '',
],
]
Result Details
Members
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the human task user interface was created.
- HumanTaskUiArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the human task user interface (worker task template).
- HumanTaskUiName
-
- Required: Yes
- Type: string
The name of the human task user interface (worker task template).
- HumanTaskUiStatus
-
- Type: string
The status of the human task user interface (worker task template). Valid values are listed below.
- UiTemplate
-
- Required: Yes
- Type: UiTemplateInfo structure
Container for user interface template information.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeHyperParameterTuningJob
$result = $client->describeHyperParameterTuningJob([/* ... */]); $promise = $client->describeHyperParameterTuningJobAsync([/* ... */]);
Returns a description of a hyperparameter tuning job, depending on the fields selected. These fields can include the name, Amazon Resource Name (ARN), job status of your tuning job and more.
Parameter Syntax
$result = $client->describeHyperParameterTuningJob([
'HyperParameterTuningJobName' => '', // REQUIRED
]);
Parameter Details
Members
- HyperParameterTuningJobName
-
- Required: Yes
- Type: string
The name of the tuning job.
Result Syntax
[
'Autotune' => [
'Mode' => 'Enabled',
],
'BestTrainingJob' => [
'CreationTime' => ,
'FailureReason' => '',
'FinalHyperParameterTuningJobObjectiveMetric' => [
'MetricName' => '',
'Type' => 'Maximize|Minimize',
'Value' => ,
],
'ObjectiveStatus' => 'Succeeded|Pending|Failed',
'TrainingEndTime' => ,
'TrainingJobArn' => '',
'TrainingJobDefinitionName' => '',
'TrainingJobName' => '',
'TrainingJobStatus' => 'InProgress|Completed|Failed|Stopping|Stopped|Deleting',
'TrainingStartTime' => ,
'TunedHyperParameters' => ['', ...],
'TuningJobName' => '',
],
'ConsumedResources' => [
'RuntimeInSeconds' => ,
],
'CreationTime' => ,
'FailureReason' => '',
'HyperParameterTuningEndTime' => ,
'HyperParameterTuningJobArn' => '',
'HyperParameterTuningJobConfig' => [
'HyperParameterTuningJobObjective' => [
'MetricName' => '',
'Type' => 'Maximize|Minimize',
],
'ParameterRanges' => [
'AutoParameters' => [
[
'Name' => '',
'ValueHint' => '',
],
// ...
],
'CategoricalParameterRanges' => [
[
'Name' => '',
'Values' => ['', ...],
],
// ...
],
'ContinuousParameterRanges' => [
[
'MaxValue' => '',
'MinValue' => '',
'Name' => '',
'ScalingType' => 'Auto|Linear|Logarithmic|ReverseLogarithmic',
],
// ...
],
'IntegerParameterRanges' => [
[
'MaxValue' => '',
'MinValue' => '',
'Name' => '',
'ScalingType' => 'Auto|Linear|Logarithmic|ReverseLogarithmic',
],
// ...
],
],
'RandomSeed' => ,
'ResourceLimits' => [
'MaxNumberOfTrainingJobs' => ,
'MaxParallelTrainingJobs' => ,
'MaxRuntimeInSeconds' => ,
],
'Strategy' => 'Bayesian|Random|Hyperband|Grid',
'StrategyConfig' => [
'HyperbandStrategyConfig' => [
'MaxResource' => ,
'MinResource' => ,
],
],
'TrainingJobEarlyStoppingType' => 'Off|Auto',
'TuningJobCompletionCriteria' => [
'BestObjectiveNotImproving' => [
'MaxNumberOfTrainingJobsNotImproving' => ,
],
'ConvergenceDetected' => [
'CompleteOnConvergence' => 'Disabled|Enabled',
],
'TargetObjectiveMetricValue' => ,
],
],
'HyperParameterTuningJobName' => '',
'HyperParameterTuningJobStatus' => 'Completed|InProgress|Failed|Stopped|Stopping|Deleting|DeleteFailed',
'LastModifiedTime' => ,
'ObjectiveStatusCounters' => [
'Failed' => ,
'Pending' => ,
'Succeeded' => ,
],
'OverallBestTrainingJob' => [
'CreationTime' => ,
'FailureReason' => '',
'FinalHyperParameterTuningJobObjectiveMetric' => [
'MetricName' => '',
'Type' => 'Maximize|Minimize',
'Value' => ,
],
'ObjectiveStatus' => 'Succeeded|Pending|Failed',
'TrainingEndTime' => ,
'TrainingJobArn' => '',
'TrainingJobDefinitionName' => '',
'TrainingJobName' => '',
'TrainingJobStatus' => 'InProgress|Completed|Failed|Stopping|Stopped|Deleting',
'TrainingStartTime' => ,
'TunedHyperParameters' => ['', ...],
'TuningJobName' => '',
],
'TrainingJobDefinition' => [
'AlgorithmSpecification' => [
'AlgorithmName' => '',
'MetricDefinitions' => [
[
'Name' => '',
'Regex' => '',
],
// ...
],
'TrainingImage' => '',
'TrainingInputMode' => 'Pipe|File|FastFile',
],
'CheckpointConfig' => [
'LocalPath' => '',
'S3Uri' => '',
],
'DefinitionName' => '',
'EnableInterContainerTrafficEncryption' => true || false,
'EnableManagedSpotTraining' => true || false,
'EnableNetworkIsolation' => true || false,
'Environment' => ['', ...],
'HyperParameterRanges' => [
'AutoParameters' => [
[
'Name' => '',
'ValueHint' => '',
],
// ...
],
'CategoricalParameterRanges' => [
[
'Name' => '',
'Values' => ['', ...],
],
// ...
],
'ContinuousParameterRanges' => [
[
'MaxValue' => '',
'MinValue' => '',
'Name' => '',
'ScalingType' => 'Auto|Linear|Logarithmic|ReverseLogarithmic',
],
// ...
],
'IntegerParameterRanges' => [
[
'MaxValue' => '',
'MinValue' => '',
'Name' => '',
'ScalingType' => 'Auto|Linear|Logarithmic|ReverseLogarithmic',
],
// ...
],
],
'HyperParameterTuningResourceConfig' => [
'AllocationStrategy' => 'Prioritized',
'InstanceConfigs' => [
[
'InstanceCount' => ,
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'VolumeSizeInGB' => ,
],
// ...
],
'InstanceCount' => ,
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'VolumeKmsKeyId' => '',
'VolumeSizeInGB' => ,
],
'InputDataConfig' => [
[
'ChannelName' => '',
'CompressionType' => 'None|Gzip',
'ContentType' => '',
'DataSource' => [
'DatasetSource' => [
'DatasetArn' => '',
],
'FileSystemDataSource' => [
'DirectoryPath' => '',
'FileSystemAccessMode' => 'rw|ro',
'FileSystemId' => '',
'FileSystemType' => 'EFS|FSxLustre',
],
'S3DataSource' => [
'AttributeNames' => ['', ...],
'HubAccessConfig' => [
'HubContentArn' => '',
],
'InstanceGroupNames' => ['', ...],
'ModelAccessConfig' => [
'AcceptEula' => true || false,
],
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile|Converse',
'S3Uri' => '',
],
],
'InputMode' => 'Pipe|File|FastFile',
'RecordWrapperType' => 'None|RecordIO',
'ShuffleConfig' => [
'Seed' => ,
],
],
// ...
],
'OutputDataConfig' => [
'CompressionType' => 'GZIP|NONE',
'KmsKeyId' => '',
'S3OutputPath' => '',
],
'ResourceConfig' => [
'InstanceCount' => ,
'InstanceGroups' => [
[
'InstanceCount' => ,
'InstanceGroupName' => '',
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
],
// ...
],
'InstancePlacementConfig' => [
'EnableMultipleJobs' => true || false,
'PlacementSpecifications' => [
[
'InstanceCount' => ,
'UltraServerId' => '',
],
// ...
],
],
'InstancePreferences' => [
[
'InstanceCount' => ,
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'TrainingPlanArns' => ['', ...],
],
// ...
],
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'KeepAlivePeriodInSeconds' => ,
'SelectedInstanceCount' => ,
'SelectedInstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'TrainingPlanArn' => '',
'VolumeKmsKeyId' => '',
'VolumeSizeInGB' => ,
],
'RetryStrategy' => [
'MaximumRetryAttempts' => ,
],
'RoleArn' => '',
'StaticHyperParameters' => ['', ...],
'StoppingCondition' => [
'MaxPendingTimeInSeconds' => ,
'MaxRuntimeInSeconds' => ,
'MaxWaitTimeInSeconds' => ,
],
'TuningObjective' => [
'MetricName' => '',
'Type' => 'Maximize|Minimize',
],
'VpcConfig' => [
'SecurityGroupIds' => ['', ...],
'Subnets' => ['', ...],
],
],
'TrainingJobDefinitions' => [
[
'AlgorithmSpecification' => [
'AlgorithmName' => '',
'MetricDefinitions' => [
[
'Name' => '',
'Regex' => '',
],
// ...
],
'TrainingImage' => '',
'TrainingInputMode' => 'Pipe|File|FastFile',
],
'CheckpointConfig' => [
'LocalPath' => '',
'S3Uri' => '',
],
'DefinitionName' => '',
'EnableInterContainerTrafficEncryption' => true || false,
'EnableManagedSpotTraining' => true || false,
'EnableNetworkIsolation' => true || false,
'Environment' => ['', ...],
'HyperParameterRanges' => [
'AutoParameters' => [
[
'Name' => '',
'ValueHint' => '',
],
// ...
],
'CategoricalParameterRanges' => [
[
'Name' => '',
'Values' => ['', ...],
],
// ...
],
'ContinuousParameterRanges' => [
[
'MaxValue' => '',
'MinValue' => '',
'Name' => '',
'ScalingType' => 'Auto|Linear|Logarithmic|ReverseLogarithmic',
],
// ...
],
'IntegerParameterRanges' => [
[
'MaxValue' => '',
'MinValue' => '',
'Name' => '',
'ScalingType' => 'Auto|Linear|Logarithmic|ReverseLogarithmic',
],
// ...
],
],
'HyperParameterTuningResourceConfig' => [
'AllocationStrategy' => 'Prioritized',
'InstanceConfigs' => [
[
'InstanceCount' => ,
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'VolumeSizeInGB' => ,
],
// ...
],
'InstanceCount' => ,
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'VolumeKmsKeyId' => '',
'VolumeSizeInGB' => ,
],
'InputDataConfig' => [
[
'ChannelName' => '',
'CompressionType' => 'None|Gzip',
'ContentType' => '',
'DataSource' => [
'DatasetSource' => [
'DatasetArn' => '',
],
'FileSystemDataSource' => [
'DirectoryPath' => '',
'FileSystemAccessMode' => 'rw|ro',
'FileSystemId' => '',
'FileSystemType' => 'EFS|FSxLustre',
],
'S3DataSource' => [
'AttributeNames' => ['', ...],
'HubAccessConfig' => [
'HubContentArn' => '',
],
'InstanceGroupNames' => ['', ...],
'ModelAccessConfig' => [
'AcceptEula' => true || false,
],
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile|Converse',
'S3Uri' => '',
],
],
'InputMode' => 'Pipe|File|FastFile',
'RecordWrapperType' => 'None|RecordIO',
'ShuffleConfig' => [
'Seed' => ,
],
],
// ...
],
'OutputDataConfig' => [
'CompressionType' => 'GZIP|NONE',
'KmsKeyId' => '',
'S3OutputPath' => '',
],
'ResourceConfig' => [
'InstanceCount' => ,
'InstanceGroups' => [
[
'InstanceCount' => ,
'InstanceGroupName' => '',
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
],
// ...
],
'InstancePlacementConfig' => [
'EnableMultipleJobs' => true || false,
'PlacementSpecifications' => [
[
'InstanceCount' => ,
'UltraServerId' => '',
],
// ...
],
],
'InstancePreferences' => [
[
'InstanceCount' => ,
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'TrainingPlanArns' => ['', ...],
],
// ...
],
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'KeepAlivePeriodInSeconds' => ,
'SelectedInstanceCount' => ,
'SelectedInstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'TrainingPlanArn' => '',
'VolumeKmsKeyId' => '',
'VolumeSizeInGB' => ,
],
'RetryStrategy' => [
'MaximumRetryAttempts' => ,
],
'RoleArn' => '',
'StaticHyperParameters' => ['', ...],
'StoppingCondition' => [
'MaxPendingTimeInSeconds' => ,
'MaxRuntimeInSeconds' => ,
'MaxWaitTimeInSeconds' => ,
],
'TuningObjective' => [
'MetricName' => '',
'Type' => 'Maximize|Minimize',
],
'VpcConfig' => [
'SecurityGroupIds' => ['', ...],
'Subnets' => ['', ...],
],
],
// ...
],
'TrainingJobStatusCounters' => [
'Completed' => ,
'InProgress' => ,
'NonRetryableError' => ,
'RetryableError' => ,
'Stopped' => ,
],
'TuningJobCompletionDetails' => [
'ConvergenceDetectedTime' => ,
'NumberOfTrainingJobsObjectiveNotImproving' => ,
],
'WarmStartConfig' => [
'ParentHyperParameterTuningJobs' => [
[
'HyperParameterTuningJobName' => '',
],
// ...
],
'WarmStartType' => 'IdenticalDataAndAlgorithm|TransferLearning',
],
]
Result Details
Members
- Autotune
-
- Type: Autotune structure
A flag to indicate if autotune is enabled for the hyperparameter tuning job.
- BestTrainingJob
-
- Type: HyperParameterTrainingJobSummary structure
A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.
- ConsumedResources
-
- Type: HyperParameterTuningJobConsumedResources structure
The total resources consumed by your hyperparameter tuning job.
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the tuning job started.
- FailureReason
-
- Type: string
If the tuning job failed, the reason it failed.
- HyperParameterTuningEndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the tuning job ended.
- HyperParameterTuningJobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the tuning job.
- HyperParameterTuningJobConfig
-
- Required: Yes
- Type: HyperParameterTuningJobConfig structure
The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.
- HyperParameterTuningJobName
-
- Required: Yes
- Type: string
The name of the hyperparameter tuning job.
- HyperParameterTuningJobStatus
-
- Required: Yes
- Type: string
The status of the tuning job.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the status of the tuning job was modified.
- ObjectiveStatusCounters
-
- Required: Yes
- Type: ObjectiveStatusCounters structure
The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.
- OverallBestTrainingJob
-
- Type: HyperParameterTrainingJobSummary structure
If the hyperparameter tuning job is an warm start tuning job with a
WarmStartTypeofIDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job. - TrainingJobDefinition
-
- Type: HyperParameterTrainingJobDefinition structure
The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.
- TrainingJobDefinitions
-
- Type: Array of HyperParameterTrainingJobDefinition structures
A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
- TrainingJobStatusCounters
-
- Required: Yes
- Type: TrainingJobStatusCounters structure
The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.
- TuningJobCompletionDetails
-
- Type: HyperParameterTuningJobCompletionDetails structure
Tuning job completion information returned as the response from a hyperparameter tuning job. This information tells if your tuning job has or has not converged. It also includes the number of training jobs that have not improved model performance as evaluated against the objective function.
- WarmStartConfig
-
- Type: HyperParameterTuningJobWarmStartConfig structure
The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeImage
$result = $client->describeImage([/* ... */]); $promise = $client->describeImageAsync([/* ... */]);
Describes a SageMaker AI image.
Parameter Syntax
$result = $client->describeImage([
'ImageName' => '', // REQUIRED
]);
Parameter Details
Members
- ImageName
-
- Required: Yes
- Type: string
The name of the image to describe.
Result Syntax
[
'CreationTime' => ,
'Description' => '',
'DisplayName' => '',
'FailureReason' => '',
'ImageArn' => '',
'ImageName' => '',
'ImageStatus' => 'CREATING|CREATED|CREATE_FAILED|UPDATING|UPDATE_FAILED|DELETING|DELETE_FAILED',
'LastModifiedTime' => ,
'RoleArn' => '',
]
Result Details
Members
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the image was created.
- Description
-
- Type: string
The description of the image.
- DisplayName
-
- Type: string
The name of the image as displayed.
- FailureReason
-
- Type: string
When a create, update, or delete operation fails, the reason for the failure.
- ImageArn
-
- Type: string
The ARN of the image.
- ImageName
-
- Type: string
The name of the image.
- ImageStatus
-
- Type: string
The status of the image.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the image was last modified.
- RoleArn
-
- Type: string
The ARN of the IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeImageVersion
$result = $client->describeImageVersion([/* ... */]); $promise = $client->describeImageVersionAsync([/* ... */]);
Describes a version of a SageMaker AI image.
Parameter Syntax
$result = $client->describeImageVersion([
'Alias' => '',
'ImageName' => '', // REQUIRED
'Version' => ,
]);
Parameter Details
Members
- Alias
-
- Type: string
The alias of the image version.
- ImageName
-
- Required: Yes
- Type: string
The name of the image.
- Version
-
- Type: int
The version of the image. If not specified, the latest version is described.
Result Syntax
[
'BaseImage' => '',
'ContainerImage' => '',
'CreationTime' => ,
'FailureReason' => '',
'Horovod' => true || false,
'ImageArn' => '',
'ImageVersionArn' => '',
'ImageVersionStatus' => 'CREATING|CREATED|CREATE_FAILED|DELETING|DELETE_FAILED',
'JobType' => 'TRAINING|INFERENCE|NOTEBOOK_KERNEL',
'LastModifiedTime' => ,
'MLFramework' => '',
'Processor' => 'CPU|GPU',
'ProgrammingLang' => '',
'ReleaseNotes' => '',
'VendorGuidance' => 'NOT_PROVIDED|STABLE|TO_BE_ARCHIVED|ARCHIVED',
'Version' => ,
]
Result Details
Members
- BaseImage
-
- Type: string
The registry path of the container image on which this image version is based.
- ContainerImage
-
- Type: string
The registry path of the container image that contains this image version.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the version was created.
- FailureReason
-
- Type: string
When a create or delete operation fails, the reason for the failure.
- Horovod
-
- Type: boolean
Indicates Horovod compatibility.
- ImageArn
-
- Type: string
The ARN of the image the version is based on.
- ImageVersionArn
-
- Type: string
The ARN of the version.
- ImageVersionStatus
-
- Type: string
The status of the version.
- JobType
-
- Type: string
Indicates SageMaker AI job type compatibility.
-
TRAINING: The image version is compatible with SageMaker AI training jobs. -
INFERENCE: The image version is compatible with SageMaker AI inference jobs. -
NOTEBOOK_KERNEL: The image version is compatible with SageMaker AI notebook kernels.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the version was last modified.
- MLFramework
-
- Type: string
The machine learning framework vended in the image version.
- Processor
-
- Type: string
Indicates CPU or GPU compatibility.
-
CPU: The image version is compatible with CPU. -
GPU: The image version is compatible with GPU.
- ProgrammingLang
-
- Type: string
The supported programming language and its version.
- ReleaseNotes
-
- Type: string
The maintainer description of the image version.
- VendorGuidance
-
- Type: string
The stability of the image version specified by the maintainer.
-
NOT_PROVIDED: The maintainers did not provide a status for image version stability. -
STABLE: The image version is stable. -
TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months. -
ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.
- Version
-
- Type: int
The version number.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeInferenceComponent
$result = $client->describeInferenceComponent([/* ... */]); $promise = $client->describeInferenceComponentAsync([/* ... */]);
Returns information about an inference component.
Parameter Syntax
$result = $client->describeInferenceComponent([
'InferenceComponentName' => '', // REQUIRED
]);
Parameter Details
Members
- InferenceComponentName
-
- Required: Yes
- Type: string
The name of the inference component.
Result Syntax
[
'CreationTime' => ,
'EndpointArn' => '',
'EndpointName' => '',
'FailureReason' => '',
'InferenceComponentArn' => '',
'InferenceComponentName' => '',
'InferenceComponentStatus' => 'InService|Creating|Updating|Failed|Deleting',
'LastDeploymentConfig' => [
'AutoRollbackConfiguration' => [
'Alarms' => [
[
'AlarmName' => '',
],
// ...
],
],
'RollingUpdatePolicy' => [
'MaximumBatchSize' => [
'Type' => 'COPY_COUNT|CAPACITY_PERCENT',
'Value' => ,
],
'MaximumExecutionTimeoutInSeconds' => ,
'RollbackMaximumBatchSize' => [
'Type' => 'COPY_COUNT|CAPACITY_PERCENT',
'Value' => ,
],
'WaitIntervalInSeconds' => ,
],
],
'LastModifiedTime' => ,
'RuntimeConfig' => [
'CurrentCopyCount' => ,
'DesiredCopyCount' => ,
'PlacementStatus' => [
[
'CurrentCopyCount' => ,
'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.12xlarge|ml.m5d.24xlarge|ml.c4.large|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.large|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.12xlarge|ml.r5.24xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.12xlarge|ml.r5d.24xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.dl1.24xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.r8g.medium|ml.r8g.large|ml.r8g.xlarge|ml.r8g.2xlarge|ml.r8g.4xlarge|ml.r8g.8xlarge|ml.r8g.12xlarge|ml.r8g.16xlarge|ml.r8g.24xlarge|ml.r8g.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.p4d.24xlarge|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m6gd.large|ml.m6gd.xlarge|ml.m6gd.2xlarge|ml.m6gd.4xlarge|ml.m6gd.8xlarge|ml.m6gd.12xlarge|ml.m6gd.16xlarge|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c6gd.large|ml.c6gd.xlarge|ml.c6gd.2xlarge|ml.c6gd.4xlarge|ml.c6gd.8xlarge|ml.c6gd.12xlarge|ml.c6gd.16xlarge|ml.c6gn.large|ml.c6gn.xlarge|ml.c6gn.2xlarge|ml.c6gn.4xlarge|ml.c6gn.8xlarge|ml.c6gn.12xlarge|ml.c6gn.16xlarge|ml.r6g.large|ml.r6g.xlarge|ml.r6g.2xlarge|ml.r6g.4xlarge|ml.r6g.8xlarge|ml.r6g.12xlarge|ml.r6g.16xlarge|ml.r6gd.large|ml.r6gd.xlarge|ml.r6gd.2xlarge|ml.r6gd.4xlarge|ml.r6gd.8xlarge|ml.r6gd.12xlarge|ml.r6gd.16xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.r7gd.medium|ml.r7gd.large|ml.r7gd.xlarge|ml.r7gd.2xlarge|ml.r7gd.4xlarge|ml.r7gd.8xlarge|ml.r7gd.12xlarge|ml.r7gd.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.c6in.large|ml.c6in.xlarge|ml.c6in.2xlarge|ml.c6in.4xlarge|ml.c6in.8xlarge|ml.c6in.12xlarge|ml.c6in.16xlarge|ml.c6in.24xlarge|ml.c6in.32xlarge|ml.p6-b200.48xlarge|ml.p6-b300.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge',
],
// ...
],
],
'Specification' => [
'BaseInferenceComponentName' => '',
'ComputeResourceRequirements' => [
'MaxMemoryRequiredInMb' => ,
'MinMemoryRequiredInMb' => ,
'NumberOfAcceleratorDevicesRequired' => ,
'NumberOfCpuCoresRequired' => ,
],
'Container' => [
'ArtifactUrl' => '',
'ContainerMetricsConfig' => [
'MetricsEndpoints' => [
[
'MetricPublishFrequencyInSeconds' => ,
'MetricsEndpointPath' => '',
],
// ...
],
],
'DeployedImage' => [
'ResolutionTime' => ,
'ResolvedImage' => '',
'SpecifiedImage' => '',
],
'Environment' => ['', ...],
],
'DataCacheConfig' => [
'EnableCaching' => true || false,
],
'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.12xlarge|ml.m5d.24xlarge|ml.c4.large|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.large|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.12xlarge|ml.r5.24xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.12xlarge|ml.r5d.24xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.dl1.24xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.r8g.medium|ml.r8g.large|ml.r8g.xlarge|ml.r8g.2xlarge|ml.r8g.4xlarge|ml.r8g.8xlarge|ml.r8g.12xlarge|ml.r8g.16xlarge|ml.r8g.24xlarge|ml.r8g.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.p4d.24xlarge|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m6gd.large|ml.m6gd.xlarge|ml.m6gd.2xlarge|ml.m6gd.4xlarge|ml.m6gd.8xlarge|ml.m6gd.12xlarge|ml.m6gd.16xlarge|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c6gd.large|ml.c6gd.xlarge|ml.c6gd.2xlarge|ml.c6gd.4xlarge|ml.c6gd.8xlarge|ml.c6gd.12xlarge|ml.c6gd.16xlarge|ml.c6gn.large|ml.c6gn.xlarge|ml.c6gn.2xlarge|ml.c6gn.4xlarge|ml.c6gn.8xlarge|ml.c6gn.12xlarge|ml.c6gn.16xlarge|ml.r6g.large|ml.r6g.xlarge|ml.r6g.2xlarge|ml.r6g.4xlarge|ml.r6g.8xlarge|ml.r6g.12xlarge|ml.r6g.16xlarge|ml.r6gd.large|ml.r6gd.xlarge|ml.r6gd.2xlarge|ml.r6gd.4xlarge|ml.r6gd.8xlarge|ml.r6gd.12xlarge|ml.r6gd.16xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.r7gd.medium|ml.r7gd.large|ml.r7gd.xlarge|ml.r7gd.2xlarge|ml.r7gd.4xlarge|ml.r7gd.8xlarge|ml.r7gd.12xlarge|ml.r7gd.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.c6in.large|ml.c6in.xlarge|ml.c6in.2xlarge|ml.c6in.4xlarge|ml.c6in.8xlarge|ml.c6in.12xlarge|ml.c6in.16xlarge|ml.c6in.24xlarge|ml.c6in.32xlarge|ml.p6-b200.48xlarge|ml.p6-b300.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge',
'ModelName' => '',
'SchedulingConfig' => [
'AvailabilityZoneBalance' => [
'EnforcementMode' => 'PERMISSIVE',
'MaxImbalance' => ,
],
'PlacementStrategy' => 'SPREAD|BINPACK',
],
'StartupParameters' => [
'ContainerStartupHealthCheckTimeoutInSeconds' => ,
'ModelDataDownloadTimeoutInSeconds' => ,
],
],
'Specifications' => [
[
'BaseInferenceComponentName' => '',
'ComputeResourceRequirements' => [
'MaxMemoryRequiredInMb' => ,
'MinMemoryRequiredInMb' => ,
'NumberOfAcceleratorDevicesRequired' => ,
'NumberOfCpuCoresRequired' => ,
],
'Container' => [
'ArtifactUrl' => '',
'ContainerMetricsConfig' => [
'MetricsEndpoints' => [
[
'MetricPublishFrequencyInSeconds' => ,
'MetricsEndpointPath' => '',
],
// ...
],
],
'DeployedImage' => [
'ResolutionTime' => ,
'ResolvedImage' => '',
'SpecifiedImage' => '',
],
'Environment' => ['', ...],
],
'DataCacheConfig' => [
'EnableCaching' => true || false,
],
'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.12xlarge|ml.m5d.24xlarge|ml.c4.large|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.large|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.12xlarge|ml.r5.24xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.12xlarge|ml.r5d.24xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.dl1.24xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.r8g.medium|ml.r8g.large|ml.r8g.xlarge|ml.r8g.2xlarge|ml.r8g.4xlarge|ml.r8g.8xlarge|ml.r8g.12xlarge|ml.r8g.16xlarge|ml.r8g.24xlarge|ml.r8g.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.p4d.24xlarge|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m6gd.large|ml.m6gd.xlarge|ml.m6gd.2xlarge|ml.m6gd.4xlarge|ml.m6gd.8xlarge|ml.m6gd.12xlarge|ml.m6gd.16xlarge|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c6gd.large|ml.c6gd.xlarge|ml.c6gd.2xlarge|ml.c6gd.4xlarge|ml.c6gd.8xlarge|ml.c6gd.12xlarge|ml.c6gd.16xlarge|ml.c6gn.large|ml.c6gn.xlarge|ml.c6gn.2xlarge|ml.c6gn.4xlarge|ml.c6gn.8xlarge|ml.c6gn.12xlarge|ml.c6gn.16xlarge|ml.r6g.large|ml.r6g.xlarge|ml.r6g.2xlarge|ml.r6g.4xlarge|ml.r6g.8xlarge|ml.r6g.12xlarge|ml.r6g.16xlarge|ml.r6gd.large|ml.r6gd.xlarge|ml.r6gd.2xlarge|ml.r6gd.4xlarge|ml.r6gd.8xlarge|ml.r6gd.12xlarge|ml.r6gd.16xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.r7gd.medium|ml.r7gd.large|ml.r7gd.xlarge|ml.r7gd.2xlarge|ml.r7gd.4xlarge|ml.r7gd.8xlarge|ml.r7gd.12xlarge|ml.r7gd.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.c6in.large|ml.c6in.xlarge|ml.c6in.2xlarge|ml.c6in.4xlarge|ml.c6in.8xlarge|ml.c6in.12xlarge|ml.c6in.16xlarge|ml.c6in.24xlarge|ml.c6in.32xlarge|ml.p6-b200.48xlarge|ml.p6-b300.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge',
'ModelName' => '',
'SchedulingConfig' => [
'AvailabilityZoneBalance' => [
'EnforcementMode' => 'PERMISSIVE',
'MaxImbalance' => ,
],
'PlacementStrategy' => 'SPREAD|BINPACK',
],
'StartupParameters' => [
'ContainerStartupHealthCheckTimeoutInSeconds' => ,
'ModelDataDownloadTimeoutInSeconds' => ,
],
],
// ...
],
'VariantName' => '',
]
Result Details
Members
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the inference component was created.
- EndpointArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.
- EndpointName
-
- Required: Yes
- Type: string
The name of the endpoint that hosts the inference component.
- FailureReason
-
- Type: string
If the inference component status is
Failed, the reason for the failure. - InferenceComponentArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the inference component.
- InferenceComponentName
-
- Required: Yes
- Type: string
The name of the inference component.
- InferenceComponentStatus
-
- Type: string
The status of the inference component.
- LastDeploymentConfig
-
- Type: InferenceComponentDeploymentConfig structure
The deployment and rollback settings that you assigned to the inference component.
- LastModifiedTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the inference component was last updated.
- RuntimeConfig
-
- Type: InferenceComponentRuntimeConfigSummary structure
Details about the runtime settings for the model that is deployed with the inference component.
- Specification
-
- Type: InferenceComponentSpecificationSummary structure
Details about the resources that are deployed with this inference component.
- Specifications
-
- Type: Array of InferenceComponentSpecificationSummary structures
A list of specification summaries for the inference component, one per instance type. This parameter is populated when the inference component was created with multiple specifications. When this parameter is populated, the singular
Specificationparameter is not returned. - VariantName
-
- Type: string
The name of the production variant that hosts the inference component.
Errors
There are no errors described for this operation.
DescribeInferenceExperiment
$result = $client->describeInferenceExperiment([/* ... */]); $promise = $client->describeInferenceExperimentAsync([/* ... */]);
Returns details about an inference experiment.
Parameter Syntax
$result = $client->describeInferenceExperiment([
'Name' => '', // REQUIRED
]);
Parameter Details
Members
- Name
-
- Required: Yes
- Type: string
The name of the inference experiment to describe.
Result Syntax
[
'Arn' => '',
'CompletionTime' => ,
'CreationTime' => ,
'DataStorageConfig' => [
'ContentType' => [
'CsvContentTypes' => ['', ...],
'JsonContentTypes' => ['', ...],
],
'Destination' => '',
'KmsKey' => '',
],
'Description' => '',
'EndpointMetadata' => [
'EndpointConfigName' => '',
'EndpointName' => '',
'EndpointStatus' => 'OutOfService|Creating|Updating|SystemUpdating|RollingBack|InService|Deleting|Failed|UpdateRollbackFailed',
'FailureReason' => '',
],
'KmsKey' => '',
'LastModifiedTime' => ,
'ModelVariants' => [
[
'InfrastructureConfig' => [
'InfrastructureType' => 'RealTimeInference',
'RealTimeInferenceConfig' => [
'InstanceCount' => ,
'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.12xlarge|ml.m5d.24xlarge|ml.c4.large|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.large|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.12xlarge|ml.r5.24xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.12xlarge|ml.r5d.24xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.dl1.24xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.r8g.medium|ml.r8g.large|ml.r8g.xlarge|ml.r8g.2xlarge|ml.r8g.4xlarge|ml.r8g.8xlarge|ml.r8g.12xlarge|ml.r8g.16xlarge|ml.r8g.24xlarge|ml.r8g.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.p4d.24xlarge|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m6gd.large|ml.m6gd.xlarge|ml.m6gd.2xlarge|ml.m6gd.4xlarge|ml.m6gd.8xlarge|ml.m6gd.12xlarge|ml.m6gd.16xlarge|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c6gd.large|ml.c6gd.xlarge|ml.c6gd.2xlarge|ml.c6gd.4xlarge|ml.c6gd.8xlarge|ml.c6gd.12xlarge|ml.c6gd.16xlarge|ml.c6gn.large|ml.c6gn.xlarge|ml.c6gn.2xlarge|ml.c6gn.4xlarge|ml.c6gn.8xlarge|ml.c6gn.12xlarge|ml.c6gn.16xlarge|ml.r6g.large|ml.r6g.xlarge|ml.r6g.2xlarge|ml.r6g.4xlarge|ml.r6g.8xlarge|ml.r6g.12xlarge|ml.r6g.16xlarge|ml.r6gd.large|ml.r6gd.xlarge|ml.r6gd.2xlarge|ml.r6gd.4xlarge|ml.r6gd.8xlarge|ml.r6gd.12xlarge|ml.r6gd.16xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.r7gd.medium|ml.r7gd.large|ml.r7gd.xlarge|ml.r7gd.2xlarge|ml.r7gd.4xlarge|ml.r7gd.8xlarge|ml.r7gd.12xlarge|ml.r7gd.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.c6in.large|ml.c6in.xlarge|ml.c6in.2xlarge|ml.c6in.4xlarge|ml.c6in.8xlarge|ml.c6in.12xlarge|ml.c6in.16xlarge|ml.c6in.24xlarge|ml.c6in.32xlarge|ml.p6-b200.48xlarge|ml.p6-b300.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge',
],
],
'ModelName' => '',
'Status' => 'Creating|Updating|InService|Deleting|Deleted',
'VariantName' => '',
],
// ...
],
'Name' => '',
'RoleArn' => '',
'Schedule' => [
'EndTime' => ,
'StartTime' => ,
],
'ShadowModeConfig' => [
'ShadowModelVariants' => [
[
'SamplingPercentage' => ,
'ShadowModelVariantName' => '',
],
// ...
],
'SourceModelVariantName' => '',
],
'Status' => 'Creating|Created|Updating|Running|Starting|Stopping|Completed|Cancelled',
'StatusReason' => '',
'Type' => 'ShadowMode',
]
Result Details
Members
- Arn
-
- Required: Yes
- Type: string
The ARN of the inference experiment being described.
- CompletionTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp at which the inference experiment was completed.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp at which you created the inference experiment.
- DataStorageConfig
-
- Type: InferenceExperimentDataStorageConfig structure
The Amazon S3 location and configuration for storing inference request and response data.
- Description
-
- Type: string
The description of the inference experiment.
- EndpointMetadata
-
- Required: Yes
- Type: EndpointMetadata structure
The metadata of the endpoint on which the inference experiment ran.
- KmsKey
-
- Type: string
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see CreateInferenceExperiment.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp at which you last modified the inference experiment.
- ModelVariants
-
- Required: Yes
- Type: Array of ModelVariantConfigSummary structures
An array of
ModelVariantConfigSummaryobjects. There is one for each variant in the inference experiment. EachModelVariantConfigSummaryobject in the array describes the infrastructure configuration for deploying the corresponding variant. - Name
-
- Required: Yes
- Type: string
The name of the inference experiment.
- RoleArn
-
- Type: string
The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.
- Schedule
-
- Type: InferenceExperimentSchedule structure
The duration for which the inference experiment ran or will run.
- ShadowModeConfig
-
- Type: ShadowModeConfig structure
The configuration of
ShadowModeinference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates. - Status
-
- Required: Yes
- Type: string
The status of the inference experiment. The following are the possible statuses for an inference experiment:
-
Creating- Amazon SageMaker is creating your experiment. -
Created- Amazon SageMaker has finished the creation of your experiment and will begin the experiment at the scheduled time. -
Updating- When you make changes to your experiment, your experiment shows as updating. -
Starting- Amazon SageMaker is beginning your experiment. -
Running- Your experiment is in progress. -
Stopping- Amazon SageMaker is stopping your experiment. -
Completed- Your experiment has completed. -
Cancelled- When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows as cancelled.
- StatusReason
-
- Type: string
The error message or client-specified
Reasonfrom the StopInferenceExperiment API, that explains the status of the inference experiment. - Type
-
- Required: Yes
- Type: string
The type of the inference experiment.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeInferenceRecommendationsJob
$result = $client->describeInferenceRecommendationsJob([/* ... */]); $promise = $client->describeInferenceRecommendationsJobAsync([/* ... */]);
Provides the results of the Inference Recommender job. One or more recommendation jobs are returned.
Parameter Syntax
$result = $client->describeInferenceRecommendationsJob([
'JobName' => '', // REQUIRED
]);
Parameter Details
Members
- JobName
-
- Required: Yes
- Type: string
The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
Result Syntax
[
'CompletionTime' => ,
'CreationTime' => ,
'EndpointPerformances' => [
[
'EndpointInfo' => [
'EndpointName' => '',
],
'Metrics' => [
'MaxInvocations' => ,
'ModelLatency' => ,
],
],
// ...
],
'FailureReason' => '',
'InferenceRecommendations' => [
[
'EndpointConfiguration' => [
'EndpointName' => '',
'InitialInstanceCount' => ,
'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.12xlarge|ml.m5d.24xlarge|ml.c4.large|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.large|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.12xlarge|ml.r5.24xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.12xlarge|ml.r5d.24xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.dl1.24xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.r8g.medium|ml.r8g.large|ml.r8g.xlarge|ml.r8g.2xlarge|ml.r8g.4xlarge|ml.r8g.8xlarge|ml.r8g.12xlarge|ml.r8g.16xlarge|ml.r8g.24xlarge|ml.r8g.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.p4d.24xlarge|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m6gd.large|ml.m6gd.xlarge|ml.m6gd.2xlarge|ml.m6gd.4xlarge|ml.m6gd.8xlarge|ml.m6gd.12xlarge|ml.m6gd.16xlarge|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c6gd.large|ml.c6gd.xlarge|ml.c6gd.2xlarge|ml.c6gd.4xlarge|ml.c6gd.8xlarge|ml.c6gd.12xlarge|ml.c6gd.16xlarge|ml.c6gn.large|ml.c6gn.xlarge|ml.c6gn.2xlarge|ml.c6gn.4xlarge|ml.c6gn.8xlarge|ml.c6gn.12xlarge|ml.c6gn.16xlarge|ml.r6g.large|ml.r6g.xlarge|ml.r6g.2xlarge|ml.r6g.4xlarge|ml.r6g.8xlarge|ml.r6g.12xlarge|ml.r6g.16xlarge|ml.r6gd.large|ml.r6gd.xlarge|ml.r6gd.2xlarge|ml.r6gd.4xlarge|ml.r6gd.8xlarge|ml.r6gd.12xlarge|ml.r6gd.16xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.r7gd.medium|ml.r7gd.large|ml.r7gd.xlarge|ml.r7gd.2xlarge|ml.r7gd.4xlarge|ml.r7gd.8xlarge|ml.r7gd.12xlarge|ml.r7gd.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.c6in.large|ml.c6in.xlarge|ml.c6in.2xlarge|ml.c6in.4xlarge|ml.c6in.8xlarge|ml.c6in.12xlarge|ml.c6in.16xlarge|ml.c6in.24xlarge|ml.c6in.32xlarge|ml.p6-b200.48xlarge|ml.p6-b300.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge',
'ServerlessConfig' => [
'MaxConcurrency' => ,
'MemorySizeInMB' => ,
'ProvisionedConcurrency' => ,
],
'VariantName' => '',
],
'InvocationEndTime' => ,
'InvocationStartTime' => ,
'Metrics' => [
'CostPerHour' => ,
'CostPerInference' => ,
'CpuUtilization' => ,
'MaxInvocations' => ,
'MemoryUtilization' => ,
'ModelLatency' => ,
'ModelSetupTime' => ,
],
'ModelConfiguration' => [
'CompilationJobName' => '',
'EnvironmentParameters' => [
[
'Key' => '',
'Value' => '',
'ValueType' => '',
],
// ...
],
'InferenceSpecificationName' => '',
],
'RecommendationId' => '',
],
// ...
],
'InputConfig' => [
'ContainerConfig' => [
'DataInputConfig' => '',
'Domain' => '',
'Framework' => '',
'FrameworkVersion' => '',
'NearestModelName' => '',
'PayloadConfig' => [
'SamplePayloadUrl' => '',
'SupportedContentTypes' => ['', ...],
],
'SupportedEndpointType' => 'RealTime|Serverless',
'SupportedInstanceTypes' => ['', ...],
'SupportedResponseMIMETypes' => ['', ...],
'Task' => '',
],
'EndpointConfigurations' => [
[
'EnvironmentParameterRanges' => [
'CategoricalParameterRanges' => [
[
'Name' => '',
'Value' => ['', ...],
],
// ...
],
],
'InferenceSpecificationName' => '',
'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.12xlarge|ml.m5d.24xlarge|ml.c4.large|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.large|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.12xlarge|ml.r5.24xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.12xlarge|ml.r5d.24xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.dl1.24xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.r8g.medium|ml.r8g.large|ml.r8g.xlarge|ml.r8g.2xlarge|ml.r8g.4xlarge|ml.r8g.8xlarge|ml.r8g.12xlarge|ml.r8g.16xlarge|ml.r8g.24xlarge|ml.r8g.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.p4d.24xlarge|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m6gd.large|ml.m6gd.xlarge|ml.m6gd.2xlarge|ml.m6gd.4xlarge|ml.m6gd.8xlarge|ml.m6gd.12xlarge|ml.m6gd.16xlarge|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c6gd.large|ml.c6gd.xlarge|ml.c6gd.2xlarge|ml.c6gd.4xlarge|ml.c6gd.8xlarge|ml.c6gd.12xlarge|ml.c6gd.16xlarge|ml.c6gn.large|ml.c6gn.xlarge|ml.c6gn.2xlarge|ml.c6gn.4xlarge|ml.c6gn.8xlarge|ml.c6gn.12xlarge|ml.c6gn.16xlarge|ml.r6g.large|ml.r6g.xlarge|ml.r6g.2xlarge|ml.r6g.4xlarge|ml.r6g.8xlarge|ml.r6g.12xlarge|ml.r6g.16xlarge|ml.r6gd.large|ml.r6gd.xlarge|ml.r6gd.2xlarge|ml.r6gd.4xlarge|ml.r6gd.8xlarge|ml.r6gd.12xlarge|ml.r6gd.16xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.r7gd.medium|ml.r7gd.large|ml.r7gd.xlarge|ml.r7gd.2xlarge|ml.r7gd.4xlarge|ml.r7gd.8xlarge|ml.r7gd.12xlarge|ml.r7gd.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.c6in.large|ml.c6in.xlarge|ml.c6in.2xlarge|ml.c6in.4xlarge|ml.c6in.8xlarge|ml.c6in.12xlarge|ml.c6in.16xlarge|ml.c6in.24xlarge|ml.c6in.32xlarge|ml.p6-b200.48xlarge|ml.p6-b300.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge',
'ServerlessConfig' => [
'MaxConcurrency' => ,
'MemorySizeInMB' => ,
'ProvisionedConcurrency' => ,
],
],
// ...
],
'Endpoints' => [
[
'EndpointName' => '',
],
// ...
],
'JobDurationInSeconds' => ,
'ModelName' => '',
'ModelPackageVersionArn' => '',
'ResourceLimit' => [
'MaxNumberOfTests' => ,
'MaxParallelOfTests' => ,
],
'TrafficPattern' => [
'Phases' => [
[
'DurationInSeconds' => ,
'InitialNumberOfUsers' => ,
'SpawnRate' => ,
],
// ...
],
'Stairs' => [
'DurationInSeconds' => ,
'NumberOfSteps' => ,
'UsersPerStep' => ,
],
'TrafficType' => 'PHASES|STAIRS',
],
'VolumeKmsKeyId' => '',
'VpcConfig' => [
'SecurityGroupIds' => ['', ...],
'Subnets' => ['', ...],
],
],
'JobArn' => '',
'JobDescription' => '',
'JobName' => '',
'JobType' => 'Default|Advanced',
'LastModifiedTime' => ,
'RoleArn' => '',
'Status' => 'PENDING|IN_PROGRESS|COMPLETED|FAILED|STOPPING|STOPPED|DELETING|DELETED',
'StoppingConditions' => [
'FlatInvocations' => 'Continue|Stop',
'MaxInvocations' => ,
'ModelLatencyThresholds' => [
[
'Percentile' => '',
'ValueInMilliseconds' => ,
],
// ...
],
],
]
Result Details
Members
- CompletionTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that shows when the job completed.
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that shows when the job was created.
- EndpointPerformances
-
- Type: Array of EndpointPerformance structures
The performance results from running an Inference Recommender job on an existing endpoint.
- FailureReason
-
- Type: string
If the job fails, provides information why the job failed.
- InferenceRecommendations
-
- Type: Array of InferenceRecommendation structures
The recommendations made by Inference Recommender.
- InputConfig
-
- Required: Yes
- Type: RecommendationJobInputConfig structure
Returns information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations you provided when you initiated the job.
- JobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the job.
- JobDescription
-
- Type: string
The job description that you provided when you initiated the job.
- JobName
-
- Required: Yes
- Type: string
The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
- JobType
-
- Required: Yes
- Type: string
The job type that you provided when you initiated the job.
- LastModifiedTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that shows when the job was last modified.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role you provided when you initiated the job.
- Status
-
- Required: Yes
- Type: string
The status of the job.
- StoppingConditions
-
- Type: RecommendationJobStoppingConditions structure
The stopping conditions that you provided when you initiated the job.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeJob
$result = $client->describeJob([/* ... */]); $promise = $client->describeJobAsync([/* ... */]);
Returns detailed information about a job, including its current status, secondary status, configuration, and timestamps. Use SecondaryStatus for granular progress tracking and SecondaryStatusTransitions to see the full history of status changes with timestamps.
The following operations are related to DescribeJob:
-
CreateJob -
ListJobs -
StopJob -
DeleteJob
Parameter Syntax
$result = $client->describeJob([
'JobCategory' => 'AgentRFT|AgentRFTEvaluation', // REQUIRED
'JobName' => '', // REQUIRED
]);
Parameter Details
Members
- JobCategory
-
- Required: Yes
- Type: string
The category of the job.
- JobName
-
- Required: Yes
- Type: string
The name of the job to describe.
Result Syntax
[
'CreationTime' => ,
'EndTime' => ,
'FailureReason' => '',
'JobArn' => '',
'JobCategory' => 'AgentRFT|AgentRFTEvaluation',
'JobConfigDocument' => '',
'JobConfigSchemaVersion' => '',
'JobName' => '',
'JobStatus' => 'InProgress|Completed|Failed|Stopping|Stopped|Deleting|DeleteFailed',
'LastModifiedTime' => ,
'RoleArn' => '',
'SecondaryStatus' => 'Starting|Downloading|Training|Uploading|Stopping|Stopped|MaxRuntimeExceeded|Interrupted|Failed|Completed|Restarting|Pending|Evaluating|Deleting|DeleteFailed',
'SecondaryStatusTransitions' => [
[
'EndTime' => ,
'StartTime' => ,
'Status' => 'Starting|Downloading|Training|Uploading|Stopping|Stopped|MaxRuntimeExceeded|Interrupted|Failed|Completed|Restarting|Pending|Evaluating|Deleting|DeleteFailed',
'StatusMessage' => '',
],
// ...
],
'Tags' => [
[
'Key' => '',
'Value' => '',
],
// ...
],
]
Result Details
Members
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the job was created.
- EndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the job ended.
- FailureReason
-
- Type: string
If the job failed, the reason it failed.
- JobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the job.
- JobCategory
-
- Required: Yes
- Type: string
The category of the job.
- JobConfigDocument
-
- Type: string
The JSON configuration document for the job.
- JobConfigSchemaVersion
-
- Required: Yes
- Type: string
The schema version used for the job configuration document.
- JobName
-
- Required: Yes
- Type: string
The name of the job.
- JobStatus
-
- Required: Yes
- Type: string
The current status of the job.
- LastModifiedTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the job was last modified.
- RoleArn
-
- Required: Yes
- Type: string
The ARN of the IAM role associated with the job.
- SecondaryStatus
-
- Required: Yes
- Type: string
The detailed secondary status of the job, providing more granular information about the job's progress. Secondary statuses may change between releases.
- SecondaryStatusTransitions
-
- Required: Yes
- Type: Array of JobSecondaryStatusTransition structures
A list of secondary status transitions for the job, with timestamps and optional status messages.
- Tags
-
- Type: Array of Tag structures
The tags associated with the job.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeJobSchemaVersion
$result = $client->describeJobSchemaVersion([/* ... */]); $promise = $client->describeJobSchemaVersionAsync([/* ... */]);
Returns the JSON schema for a specified job category and schema version. Use this schema to validate your JobConfigDocument before calling CreateJob. If you don't specify a schema version, the latest version is returned. The schema defines required fields, allowed values, and constraints for the job configuration.
The following operations are related to DescribeJobSchemaVersion:
-
ListJobSchemaVersions -
CreateJob
Parameter Syntax
$result = $client->describeJobSchemaVersion([
'JobCategory' => 'AgentRFT|AgentRFTEvaluation', // REQUIRED
'JobConfigSchemaVersion' => '',
]);
Parameter Details
Members
- JobCategory
-
- Required: Yes
- Type: string
The category of the job schema to describe.
- JobConfigSchemaVersion
-
- Type: string
The version of the schema to retrieve. If not specified, the latest version is returned.
Result Syntax
[
'JobCategory' => 'AgentRFT|AgentRFTEvaluation',
'JobConfigSchema' => '',
'JobConfigSchemaVersion' => '',
]
Result Details
Members
- JobCategory
-
- Required: Yes
- Type: string
The category of the job schema.
- JobConfigSchema
-
- Required: Yes
- Type: string
The JSON schema document that defines the structure of the job configuration.
- JobConfigSchemaVersion
-
- Required: Yes
- Type: string
The version of the schema.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeLabelingJob
$result = $client->describeLabelingJob([/* ... */]); $promise = $client->describeLabelingJobAsync([/* ... */]);
Gets information about a labeling job.
Parameter Syntax
$result = $client->describeLabelingJob([
'LabelingJobName' => '', // REQUIRED
]);
Parameter Details
Members
- LabelingJobName
-
- Required: Yes
- Type: string
The name of the labeling job to return information for.
Result Syntax
[
'CreationTime' => ,
'FailureReason' => '',
'HumanTaskConfig' => [
'AnnotationConsolidationConfig' => [
'AnnotationConsolidationLambdaArn' => '',
],
'MaxConcurrentTaskCount' => ,
'NumberOfHumanWorkersPerDataObject' => ,
'PreHumanTaskLambdaArn' => '',
'PublicWorkforceTaskPrice' => [
'AmountInUsd' => [
'Cents' => ,
'Dollars' => ,
'TenthFractionsOfACent' => ,
],
],
'TaskAvailabilityLifetimeInSeconds' => ,
'TaskDescription' => '',
'TaskKeywords' => ['', ...],
'TaskTimeLimitInSeconds' => ,
'TaskTitle' => '',
'UiConfig' => [
'HumanTaskUiArn' => '',
'UiTemplateS3Uri' => '',
],
'WorkteamArn' => '',
],
'InputConfig' => [
'DataAttributes' => [
'ContentClassifiers' => ['', ...],
],
'DataSource' => [
'S3DataSource' => [
'ManifestS3Uri' => '',
],
'SnsDataSource' => [
'SnsTopicArn' => '',
],
],
],
'JobReferenceCode' => '',
'LabelAttributeName' => '',
'LabelCategoryConfigS3Uri' => '',
'LabelCounters' => [
'FailedNonRetryableError' => ,
'HumanLabeled' => ,
'MachineLabeled' => ,
'TotalLabeled' => ,
'Unlabeled' => ,
],
'LabelingJobAlgorithmsConfig' => [
'InitialActiveLearningModelArn' => '',
'LabelingJobAlgorithmSpecificationArn' => '',
'LabelingJobResourceConfig' => [
'VolumeKmsKeyId' => '',
'VpcConfig' => [
'SecurityGroupIds' => ['', ...],
'Subnets' => ['', ...],
],
],
],
'LabelingJobArn' => '',
'LabelingJobName' => '',
'LabelingJobOutput' => [
'FinalActiveLearningModelArn' => '',
'OutputDatasetS3Uri' => '',
],
'LabelingJobStatus' => 'Initializing|InProgress|Completed|Failed|Stopping|Stopped',
'LastModifiedTime' => ,
'OutputConfig' => [
'KmsKeyId' => '',
'S3OutputPath' => '',
'SnsTopicArn' => '',
],
'RoleArn' => '',
'StoppingConditions' => [
'MaxHumanLabeledObjectCount' => ,
'MaxPercentageOfInputDatasetLabeled' => ,
],
'Tags' => [
[
'Key' => '',
'Value' => '',
],
// ...
],
]
Result Details
Members
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the labeling job was created.
- FailureReason
-
- Type: string
If the job failed, the reason that it failed.
- HumanTaskConfig
-
- Required: Yes
- Type: HumanTaskConfig structure
Configuration information required for human workers to complete a labeling task.
- InputConfig
-
- Required: Yes
- Type: LabelingJobInputConfig structure
Input configuration information for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.
- JobReferenceCode
-
- Required: Yes
- Type: string
A unique identifier for work done as part of a labeling job.
- LabelAttributeName
-
- Type: string
The attribute used as the label in the output manifest file.
- LabelCategoryConfigS3Uri
-
- Type: string
The S3 location of the JSON file that defines the categories used to label data objects. Please note the following label-category limits:
-
Semantic segmentation labeling jobs using automated labeling: 20 labels
-
Box bounding labeling jobs (all): 10 labels
The file is a JSON structure in the following format:
{"document-version": "2018-11-28""labels": [{"label": "label 1"},{"label": "label 2"},...{"label": "label n"}]} - LabelCounters
-
- Required: Yes
- Type: LabelCounters structure
Provides a breakdown of the number of data objects labeled by humans, the number of objects labeled by machine, the number of objects than couldn't be labeled, and the total number of objects labeled.
- LabelingJobAlgorithmsConfig
-
- Type: LabelingJobAlgorithmsConfig structure
Configuration information for automated data labeling.
- LabelingJobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the labeling job.
- LabelingJobName
-
- Required: Yes
- Type: string
The name assigned to the labeling job when it was created.
- LabelingJobOutput
-
- Type: LabelingJobOutput structure
The location of the output produced by the labeling job.
- LabelingJobStatus
-
- Required: Yes
- Type: string
The processing status of the labeling job.
- LastModifiedTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the labeling job was last updated.
- OutputConfig
-
- Required: Yes
- Type: LabelingJobOutputConfig structure
The location of the job's output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt the output data, if any.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during data labeling.
- StoppingConditions
-
- Type: LabelingJobStoppingConditions structure
A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped.
- Tags
-
- 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.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeLineageGroup
$result = $client->describeLineageGroup([/* ... */]); $promise = $client->describeLineageGroupAsync([/* ... */]);
Provides a list of properties for the requested lineage group. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.
Parameter Syntax
$result = $client->describeLineageGroup([
'LineageGroupName' => '', // REQUIRED
]);
Parameter Details
Members
- LineageGroupName
-
- Required: Yes
- Type: string
The name of the lineage group.
Result Syntax
[
'CreatedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'CreationTime' => ,
'Description' => '',
'DisplayName' => '',
'LastModifiedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'LastModifiedTime' => ,
'LineageGroupArn' => '',
'LineageGroupName' => '',
]
Result Details
Members
- CreatedBy
-
- Type: UserContext structure
Information about the user who created or modified a SageMaker resource.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation time of lineage group.
- Description
-
- Type: string
The description of the lineage group.
- DisplayName
-
- Type: string
The display name of the lineage group.
- LastModifiedBy
-
- Type: UserContext structure
Information about the user who created or modified a SageMaker resource.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last modified time of the lineage group.
- LineageGroupArn
-
- Type: string
The Amazon Resource Name (ARN) of the lineage group.
- LineageGroupName
-
- Type: string
The name of the lineage group.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeMlflowApp
$result = $client->describeMlflowApp([/* ... */]); $promise = $client->describeMlflowAppAsync([/* ... */]);
Returns information about an MLflow App.
Parameter Syntax
$result = $client->describeMlflowApp([
'Arn' => '', // REQUIRED
]);
Parameter Details
Members
- Arn
-
- Required: Yes
- Type: string
The ARN of the MLflow App for which to get information.
Result Syntax
[
'AccountDefaultStatus' => 'ENABLED|DISABLED',
'Arn' => '',
'ArtifactStoreUri' => '',
'CreatedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'CreationTime' => ,
'DefaultDomainIdList' => ['', ...],
'KmsKeyId' => '',
'LastModifiedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'LastModifiedTime' => ,
'MaintenanceStatus' => 'MaintenanceInProgress|MaintenanceComplete|MaintenanceFailed',
'MlflowVersion' => '',
'ModelRegistrationMode' => 'AutoModelRegistrationEnabled|AutoModelRegistrationDisabled',
'Name' => '',
'RoleArn' => '',
'Status' => 'Creating|Created|CreateFailed|Updating|Updated|UpdateFailed|Deleting|DeleteFailed|Deleted',
'WeeklyMaintenanceWindowStart' => '',
]
Result Details
Members
- AccountDefaultStatus
-
- Type: string
Indicates whether this MLflow app is the default for the entire account.
- Arn
-
- Type: string
The ARN of the MLflow App.
- ArtifactStoreUri
-
- Type: string
The S3 URI of the general purpose bucket used as the MLflow App artifact store.
- CreatedBy
-
- Type: UserContext structure
Information about the user who created or modified a SageMaker resource.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the MLflow App was created.
- DefaultDomainIdList
-
- Type: Array of strings
List of SageMaker Domain IDs for which this MLflow App is the default.
- KmsKeyId
-
- Type: string
The ID of the Amazon Web Services KMS key used to encrypt the data at rest associated with the MLflow App. This field is absent if the MLflow App is not encrypted with a customer-managed key.
- LastModifiedBy
-
- Type: UserContext structure
Information about the user who created or modified a SageMaker resource.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the MLflow App was last modified.
- MaintenanceStatus
-
- Type: string
Current maintenance status of the MLflow App.
- MlflowVersion
-
- Type: string
The MLflow version used.
- ModelRegistrationMode
-
- Type: string
Whether automatic registration of new MLflow models to the SageMaker Model Registry is enabled.
- Name
-
- Type: string
The name of the MLflow App.
- RoleArn
-
- Type: string
The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow App uses to access the artifact store in Amazon S3.
- Status
-
- Type: string
The current creation status of the described MLflow App.
- WeeklyMaintenanceWindowStart
-
- Type: string
The day and time of the week when weekly maintenance occurs.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeMlflowTrackingServer
$result = $client->describeMlflowTrackingServer([/* ... */]); $promise = $client->describeMlflowTrackingServerAsync([/* ... */]);
Returns information about an MLflow Tracking Server.
Parameter Syntax
$result = $client->describeMlflowTrackingServer([
'TrackingServerName' => '', // REQUIRED
]);
Parameter Details
Members
- TrackingServerName
-
- Required: Yes
- Type: string
The name of the MLflow Tracking Server to describe.
Result Syntax
[
'ArtifactStoreUri' => '',
'AutomaticModelRegistration' => true || false,
'CreatedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'CreationTime' => ,
'IsActive' => 'Active|Inactive',
'LastModifiedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'LastModifiedTime' => ,
'MlflowVersion' => '',
'RoleArn' => '',
'S3BucketOwnerAccountId' => '',
'S3BucketOwnerVerification' => true || false,
'TrackingServerArn' => '',
'TrackingServerMaintenanceStatus' => 'MaintenanceInProgress|MaintenanceComplete|MaintenanceFailed',
'TrackingServerName' => '',
'TrackingServerSize' => 'Small|Medium|Large',
'TrackingServerStatus' => 'Creating|Created|CreateFailed|Updating|Updated|UpdateFailed|Deleting|DeleteFailed|Stopping|Stopped|StopFailed|Starting|Started|StartFailed|MaintenanceInProgress|MaintenanceComplete|MaintenanceFailed',
'TrackingServerUrl' => '',
'WeeklyMaintenanceWindowStart' => '',
]
Result Details
Members
- ArtifactStoreUri
-
- Type: string
The S3 URI of the general purpose bucket used as the MLflow Tracking Server artifact store.
- AutomaticModelRegistration
-
- Type: boolean
Whether automatic registration of new MLflow models to the SageMaker Model Registry is enabled.
- CreatedBy
-
- Type: UserContext structure
Information about the user who created or modified a SageMaker resource.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the described MLflow Tracking Server was created.
- IsActive
-
- Type: string
Whether the described MLflow Tracking Server is currently active.
- LastModifiedBy
-
- Type: UserContext structure
Information about the user who created or modified a SageMaker resource.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the described MLflow Tracking Server was last modified.
- MlflowVersion
-
- Type: string
The MLflow version used for the described tracking server.
- RoleArn
-
- Type: string
The Amazon Resource Name (ARN) for an IAM role in your account that the described MLflow Tracking Server uses to access the artifact store in Amazon S3.
- S3BucketOwnerAccountId
-
- Type: string
Expected Amazon Web Services account ID that owns the Amazon S3 bucket for artifact storage.
- S3BucketOwnerVerification
-
- Type: boolean
Whether Amazon S3 Bucket Ownership checks are enabled whenever the tracking server interacts with Amazon Amazon S3.
- TrackingServerArn
-
- Type: string
The ARN of the described tracking server.
- TrackingServerMaintenanceStatus
-
- Type: string
The current maintenance status of the described MLflow Tracking Server.
- TrackingServerName
-
- Type: string
The name of the described tracking server.
- TrackingServerSize
-
- Type: string
The size of the described tracking server.
- TrackingServerStatus
-
- Type: string
The current creation status of the described MLflow Tracking Server.
- TrackingServerUrl
-
- Type: string
The URL to connect to the MLflow user interface for the described tracking server.
- WeeklyMaintenanceWindowStart
-
- Type: string
The day and time of the week when weekly maintenance occurs on the described tracking server.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeModel
$result = $client->describeModel([/* ... */]); $promise = $client->describeModelAsync([/* ... */]);
Describes a model that you created using the CreateModel API.
Parameter Syntax
$result = $client->describeModel([
'ModelName' => '', // REQUIRED
]);
Parameter Details
Members
- ModelName
-
- Required: Yes
- Type: string
The name of the model.
Result Syntax
[
'Containers' => [
[
'AdditionalModelDataSources' => [
[
'ChannelName' => '',
'S3DataSource' => [
'CompressionType' => 'None|Gzip',
'ETag' => '',
'HubAccessConfig' => [
'HubContentArn' => '',
],
'ManifestEtag' => '',
'ManifestS3Uri' => '',
'ModelAccessConfig' => [
'AcceptEula' => true || false,
],
'S3DataType' => 'S3Prefix|S3Object',
'S3Uri' => '',
],
],
// ...
],
'ContainerHostname' => '',
'ContainerMetricsConfig' => [
'MetricsEndpoints' => [
[
'MetricPublishFrequencyInSeconds' => ,
'MetricsEndpointPath' => '',
],
// ...
],
],
'Environment' => ['', ...],
'Image' => '',
'ImageConfig' => [
'RepositoryAccessMode' => 'Platform|Vpc',
'RepositoryAuthConfig' => [
'RepositoryCredentialsProviderArn' => '',
],
],
'InferenceSpecificationName' => '',
'Mode' => 'SingleModel|MultiModel',
'ModelDataSource' => [
'S3DataSource' => [
'CompressionType' => 'None|Gzip',
'ETag' => '',
'HubAccessConfig' => [
'HubContentArn' => '',
],
'ManifestEtag' => '',
'ManifestS3Uri' => '',
'ModelAccessConfig' => [
'AcceptEula' => true || false,
],
'S3DataType' => 'S3Prefix|S3Object',
'S3Uri' => '',
],
],
'ModelDataUrl' => '',
'ModelPackageName' => '',
'MultiModelConfig' => [
'ModelCacheSetting' => 'Enabled|Disabled',
],
],
// ...
],
'CreationTime' => ,
'DeploymentRecommendation' => [
'RealTimeInferenceRecommendations' => [
[
'Environment' => ['', ...],
'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.12xlarge|ml.m5d.24xlarge|ml.c4.large|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.large|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.12xlarge|ml.r5.24xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.12xlarge|ml.r5d.24xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.dl1.24xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.r8g.medium|ml.r8g.large|ml.r8g.xlarge|ml.r8g.2xlarge|ml.r8g.4xlarge|ml.r8g.8xlarge|ml.r8g.12xlarge|ml.r8g.16xlarge|ml.r8g.24xlarge|ml.r8g.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.p4d.24xlarge|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m6gd.large|ml.m6gd.xlarge|ml.m6gd.2xlarge|ml.m6gd.4xlarge|ml.m6gd.8xlarge|ml.m6gd.12xlarge|ml.m6gd.16xlarge|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c6gd.large|ml.c6gd.xlarge|ml.c6gd.2xlarge|ml.c6gd.4xlarge|ml.c6gd.8xlarge|ml.c6gd.12xlarge|ml.c6gd.16xlarge|ml.c6gn.large|ml.c6gn.xlarge|ml.c6gn.2xlarge|ml.c6gn.4xlarge|ml.c6gn.8xlarge|ml.c6gn.12xlarge|ml.c6gn.16xlarge|ml.r6g.large|ml.r6g.xlarge|ml.r6g.2xlarge|ml.r6g.4xlarge|ml.r6g.8xlarge|ml.r6g.12xlarge|ml.r6g.16xlarge|ml.r6gd.large|ml.r6gd.xlarge|ml.r6gd.2xlarge|ml.r6gd.4xlarge|ml.r6gd.8xlarge|ml.r6gd.12xlarge|ml.r6gd.16xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.r7gd.medium|ml.r7gd.large|ml.r7gd.xlarge|ml.r7gd.2xlarge|ml.r7gd.4xlarge|ml.r7gd.8xlarge|ml.r7gd.12xlarge|ml.r7gd.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.c6in.large|ml.c6in.xlarge|ml.c6in.2xlarge|ml.c6in.4xlarge|ml.c6in.8xlarge|ml.c6in.12xlarge|ml.c6in.16xlarge|ml.c6in.24xlarge|ml.c6in.32xlarge|ml.p6-b200.48xlarge|ml.p6-b300.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge',
'RecommendationId' => '',
],
// ...
],
'RecommendationStatus' => 'IN_PROGRESS|COMPLETED|FAILED|NOT_APPLICABLE',
],
'EnableNetworkIsolation' => true || false,
'ExecutionRoleArn' => '',
'InferenceExecutionConfig' => [
'Mode' => 'Serial|Direct',
],
'ModelArn' => '',
'ModelName' => '',
'PrimaryContainer' => [
'AdditionalModelDataSources' => [
[
'ChannelName' => '',
'S3DataSource' => [
'CompressionType' => 'None|Gzip',
'ETag' => '',
'HubAccessConfig' => [
'HubContentArn' => '',
],
'ManifestEtag' => '',
'ManifestS3Uri' => '',
'ModelAccessConfig' => [
'AcceptEula' => true || false,
],
'S3DataType' => 'S3Prefix|S3Object',
'S3Uri' => '',
],
],
// ...
],
'ContainerHostname' => '',
'ContainerMetricsConfig' => [
'MetricsEndpoints' => [
[
'MetricPublishFrequencyInSeconds' => ,
'MetricsEndpointPath' => '',
],
// ...
],
],
'Environment' => ['', ...],
'Image' => '',
'ImageConfig' => [
'RepositoryAccessMode' => 'Platform|Vpc',
'RepositoryAuthConfig' => [
'RepositoryCredentialsProviderArn' => '',
],
],
'InferenceSpecificationName' => '',
'Mode' => 'SingleModel|MultiModel',
'ModelDataSource' => [
'S3DataSource' => [
'CompressionType' => 'None|Gzip',
'ETag' => '',
'HubAccessConfig' => [
'HubContentArn' => '',
],
'ManifestEtag' => '',
'ManifestS3Uri' => '',
'ModelAccessConfig' => [
'AcceptEula' => true || false,
],
'S3DataType' => 'S3Prefix|S3Object',
'S3Uri' => '',
],
],
'ModelDataUrl' => '',
'ModelPackageName' => '',
'MultiModelConfig' => [
'ModelCacheSetting' => 'Enabled|Disabled',
],
],
'VpcConfig' => [
'SecurityGroupIds' => ['', ...],
'Subnets' => ['', ...],
],
]
Result Details
Members
- Containers
-
- Type: Array of ContainerDefinition structures
The containers in the inference pipeline.
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that shows when the model was created.
- DeploymentRecommendation
-
- Type: DeploymentRecommendation structure
A set of recommended deployment configurations for the model.
- EnableNetworkIsolation
-
- Type: boolean
If
True, no inbound or outbound network calls can be made to or from the model container. - ExecutionRoleArn
-
- Type: string
The Amazon Resource Name (ARN) of the IAM role that you specified for the model.
- InferenceExecutionConfig
-
- Type: InferenceExecutionConfig structure
Specifies details of how containers in a multi-container endpoint are called.
- ModelArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the model.
- ModelName
-
- Required: Yes
- Type: string
Name of the SageMaker model.
- PrimaryContainer
-
- Type: ContainerDefinition structure
The location of the primary inference code, associated artifacts, and custom environment map that the inference code uses when it is deployed in production.
- VpcConfig
-
- Type: VpcConfig structure
A VpcConfig object that specifies the VPC that this model has access to. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud
Errors
There are no errors described for this operation.
DescribeModelBiasJobDefinition
$result = $client->describeModelBiasJobDefinition([/* ... */]); $promise = $client->describeModelBiasJobDefinitionAsync([/* ... */]);
Returns a description of a model bias job definition.
Parameter Syntax
$result = $client->describeModelBiasJobDefinition([
'JobDefinitionName' => '', // REQUIRED
]);
Parameter Details
Members
- JobDefinitionName
-
- Required: Yes
- Type: string
The name of the model bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
Result Syntax
[
'CreationTime' => ,
'JobDefinitionArn' => '',
'JobDefinitionName' => '',
'JobResources' => [
'ClusterConfig' => [
'InstanceCount' => ,
'InstanceType' => 'ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p5.4xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'VolumeKmsKeyId' => '',
'VolumeSizeInGB' => ,
],
],
'ModelBiasAppSpecification' => [
'ConfigUri' => '',
'Environment' => ['', ...],
'ImageUri' => '',
],
'ModelBiasBaselineConfig' => [
'BaseliningJobName' => '',
'ConstraintsResource' => [
'S3Uri' => '',
],
],
'ModelBiasJobInput' => [
'BatchTransformInput' => [
'DataCapturedDestinationS3Uri' => '',
'DatasetFormat' => [
'Csv' => [
'Header' => true || false,
],
'Json' => [
'Line' => true || false,
],
'Parquet' => [
],
],
'EndTimeOffset' => '',
'ExcludeFeaturesAttribute' => '',
'FeaturesAttribute' => '',
'InferenceAttribute' => '',
'LocalPath' => '',
'ProbabilityAttribute' => '',
'ProbabilityThresholdAttribute' => ,
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3InputMode' => 'Pipe|File',
'StartTimeOffset' => '',
],
'EndpointInput' => [
'EndTimeOffset' => '',
'EndpointName' => '',
'ExcludeFeaturesAttribute' => '',
'FeaturesAttribute' => '',
'InferenceAttribute' => '',
'LocalPath' => '',
'ProbabilityAttribute' => '',
'ProbabilityThresholdAttribute' => ,
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3InputMode' => 'Pipe|File',
'StartTimeOffset' => '',
],
'GroundTruthS3Input' => [
'S3Uri' => '',
],
],
'ModelBiasJobOutputConfig' => [
'KmsKeyId' => '',
'MonitoringOutputs' => [
[
'S3Output' => [
'LocalPath' => '',
'S3UploadMode' => 'Continuous|EndOfJob',
'S3Uri' => '',
],
],
// ...
],
],
'NetworkConfig' => [
'EnableInterContainerTrafficEncryption' => true || false,
'EnableNetworkIsolation' => true || false,
'VpcConfig' => [
'SecurityGroupIds' => ['', ...],
'Subnets' => ['', ...],
],
],
'RoleArn' => '',
'StoppingCondition' => [
'MaxRuntimeInSeconds' => ,
],
]
Result Details
Members
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the model bias job was created.
- JobDefinitionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the model bias job.
- JobDefinitionName
-
- Required: Yes
- Type: string
The name of the bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
- JobResources
-
- Required: Yes
- Type: MonitoringResources structure
Identifies the resources to deploy for a monitoring job.
- ModelBiasAppSpecification
-
- Required: Yes
- Type: ModelBiasAppSpecification structure
Configures the model bias job to run a specified Docker container image.
- ModelBiasBaselineConfig
-
- Type: ModelBiasBaselineConfig structure
The baseline configuration for a model bias job.
- ModelBiasJobInput
-
- Required: Yes
- Type: ModelBiasJobInput structure
Inputs for the model bias job.
- ModelBiasJobOutputConfig
-
- Required: Yes
- Type: MonitoringOutputConfig structure
The output configuration for monitoring jobs.
- NetworkConfig
-
- Type: MonitoringNetworkConfig structure
Networking options for a model bias job.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.
- StoppingCondition
-
- Type: MonitoringStoppingCondition structure
A time limit for how long the monitoring job is allowed to run before stopping.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeModelCard
$result = $client->describeModelCard([/* ... */]); $promise = $client->describeModelCardAsync([/* ... */]);
Describes the content, creation time, and security configuration of an Amazon SageMaker Model Card.
To retrieve only metadata about a model card without requiring kms:Decrypt permission on the associated customer-managed Amazon Web Services KMS key, set IncludedData to MetadataOnly. The default is AllData, which returns the full model card Content and requires kms:Decrypt permission when a customer-managed key is configured.
Parameter Syntax
$result = $client->describeModelCard([
'IncludedData' => 'AllData|MetadataOnly',
'ModelCardName' => '', // REQUIRED
'ModelCardVersion' => ,
]);
Parameter Details
Members
- IncludedData
-
- Type: string
Specifies the level of model card data to include in the response. Use this parameter to call
DescribeModelCardwithout requiringkms:Decryptpermission on the customer-managed Amazon Web Services KMS key.-
AllData: Returns the full model cardContent. This option requireskms:Decryptpermission on the customer-managed key, if one is associated with the model card. This is the default. -
MetadataOnly: Returns the model card with sanitizedContentthat includes only a small set of unencrypted metadata fields. This option does not requirekms:Decryptpermission. For the list of fields preserved in the response, seeContent.
If you don't specify a value, SageMaker returns
AllData. - ModelCardName
-
- Required: Yes
- Type: string
The name or Amazon Resource Name (ARN) of the model card to describe.
- ModelCardVersion
-
- Type: int
The version of the model card to describe. If a version is not provided, then the latest version of the model card is described.
Result Syntax
[
'Content' => '',
'CreatedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'CreationTime' => ,
'LastModifiedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'LastModifiedTime' => ,
'ModelCardArn' => '',
'ModelCardName' => '',
'ModelCardProcessingStatus' => 'DeleteInProgress|DeletePending|ContentDeleted|ExportJobsDeleted|DeleteCompleted|DeleteFailed',
'ModelCardStatus' => 'Draft|PendingReview|Approved|Archived',
'ModelCardVersion' => ,
'SecurityConfig' => [
'KmsKeyId' => '',
],
]
Result Details
Members
- Content
-
- Required: Yes
- Type: string
The content of the model card. Content is provided as a string in the model card JSON schema.
When you set
IncludedDatatoMetadataOnlyin the request, SageMaker returns a sanitized version ofContentthat includes only the following JSON paths, when present in the model card:-
model_overview.model_id -
model_overview.model_name -
intended_uses.risk_rating -
model_package_details.model_package_group_name -
model_package_details.model_package_arn
All other fields are removed from
ContentwhenIncludedDataisMetadataOnly, including model description, training details, evaluation details, business details, and additional information. To retrieve the completeContent, setIncludedDatatoAllDataor omit the parameter. - CreatedBy
-
- Required: Yes
- Type: UserContext structure
Information about the user who created or modified a SageMaker resource.
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time the model card was created.
- LastModifiedBy
-
- Type: UserContext structure
Information about the user who created or modified a SageMaker resource.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time the model card was last modified.
- ModelCardArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the model card.
- ModelCardName
-
- Required: Yes
- Type: string
The name of the model card.
- ModelCardProcessingStatus
-
- Type: string
The processing status of model card deletion. The
ModelCardProcessingStatusupdates throughout the different deletion steps.-
DeletePending: Model card deletion request received. -
DeleteInProgress: Model card deletion is in progress. -
ContentDeleted: Deleted model card content. -
ExportJobsDeleted: Deleted all export jobs associated with the model card. -
DeleteCompleted: Successfully deleted the model card. -
DeleteFailed: The model card failed to delete.
- ModelCardStatus
-
- Required: Yes
- Type: string
The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
-
Draft: The model card is a work in progress. -
PendingReview: The model card is pending review. -
Approved: The model card is approved. -
Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.
- ModelCardVersion
-
- Required: Yes
- Type: int
The version of the model card.
- SecurityConfig
-
- Type: ModelCardSecurityConfig structure
The security configuration used to protect model card content.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeModelCardExportJob
$result = $client->describeModelCardExportJob([/* ... */]); $promise = $client->describeModelCardExportJobAsync([/* ... */]);
Describes an Amazon SageMaker Model Card export job.
Parameter Syntax
$result = $client->describeModelCardExportJob([
'ModelCardExportJobArn' => '', // REQUIRED
]);
Parameter Details
Members
- ModelCardExportJobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the model card export job to describe.
Result Syntax
[
'CreatedAt' => ,
'ExportArtifacts' => [
'S3ExportArtifacts' => '',
],
'FailureReason' => '',
'LastModifiedAt' => ,
'ModelCardExportJobArn' => '',
'ModelCardExportJobName' => '',
'ModelCardName' => '',
'ModelCardVersion' => ,
'OutputConfig' => [
'S3OutputPath' => '',
],
'Status' => 'InProgress|Completed|Failed',
]
Result Details
Members
- CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the model export job was created.
- ExportArtifacts
-
- Type: ModelCardExportArtifacts structure
The exported model card artifacts.
- FailureReason
-
- Type: string
The failure reason if the model export job fails.
- LastModifiedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the model export job was last modified.
- ModelCardExportJobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the model card export job.
- ModelCardExportJobName
-
- Required: Yes
- Type: string
The name of the model card export job to describe.
- ModelCardName
-
- Required: Yes
- Type: string
The name or Amazon Resource Name (ARN) of the model card that the model export job exports.
- ModelCardVersion
-
- Required: Yes
- Type: int
The version of the model card that the model export job exports.
- OutputConfig
-
- Required: Yes
- Type: ModelCardExportOutputConfig structure
The export output details for the model card.
- Status
-
- Required: Yes
- Type: string
The completion status of the model card export job.
-
InProgress: The model card export job is in progress. -
Completed: The model card export job is complete. -
Failed: The model card export job failed. To see the reason for the failure, see theFailureReasonfield in the response to aDescribeModelCardExportJobcall.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeModelExplainabilityJobDefinition
$result = $client->describeModelExplainabilityJobDefinition([/* ... */]); $promise = $client->describeModelExplainabilityJobDefinitionAsync([/* ... */]);
Returns a description of a model explainability job definition.
Parameter Syntax
$result = $client->describeModelExplainabilityJobDefinition([
'JobDefinitionName' => '', // REQUIRED
]);
Parameter Details
Members
- JobDefinitionName
-
- Required: Yes
- Type: string
The name of the model explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
Result Syntax
[
'CreationTime' => ,
'JobDefinitionArn' => '',
'JobDefinitionName' => '',
'JobResources' => [
'ClusterConfig' => [
'InstanceCount' => ,
'InstanceType' => 'ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p5.4xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'VolumeKmsKeyId' => '',
'VolumeSizeInGB' => ,
],
],
'ModelExplainabilityAppSpecification' => [
'ConfigUri' => '',
'Environment' => ['', ...],
'ImageUri' => '',
],
'ModelExplainabilityBaselineConfig' => [
'BaseliningJobName' => '',
'ConstraintsResource' => [
'S3Uri' => '',
],
],
'ModelExplainabilityJobInput' => [
'BatchTransformInput' => [
'DataCapturedDestinationS3Uri' => '',
'DatasetFormat' => [
'Csv' => [
'Header' => true || false,
],
'Json' => [
'Line' => true || false,
],
'Parquet' => [
],
],
'EndTimeOffset' => '',
'ExcludeFeaturesAttribute' => '',
'FeaturesAttribute' => '',
'InferenceAttribute' => '',
'LocalPath' => '',
'ProbabilityAttribute' => '',
'ProbabilityThresholdAttribute' => ,
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3InputMode' => 'Pipe|File',
'StartTimeOffset' => '',
],
'EndpointInput' => [
'EndTimeOffset' => '',
'EndpointName' => '',
'ExcludeFeaturesAttribute' => '',
'FeaturesAttribute' => '',
'InferenceAttribute' => '',
'LocalPath' => '',
'ProbabilityAttribute' => '',
'ProbabilityThresholdAttribute' => ,
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3InputMode' => 'Pipe|File',
'StartTimeOffset' => '',
],
],
'ModelExplainabilityJobOutputConfig' => [
'KmsKeyId' => '',
'MonitoringOutputs' => [
[
'S3Output' => [
'LocalPath' => '',
'S3UploadMode' => 'Continuous|EndOfJob',
'S3Uri' => '',
],
],
// ...
],
],
'NetworkConfig' => [
'EnableInterContainerTrafficEncryption' => true || false,
'EnableNetworkIsolation' => true || false,
'VpcConfig' => [
'SecurityGroupIds' => ['', ...],
'Subnets' => ['', ...],
],
],
'RoleArn' => '',
'StoppingCondition' => [
'MaxRuntimeInSeconds' => ,
],
]
Result Details
Members
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the model explainability job was created.
- JobDefinitionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the model explainability job.
- JobDefinitionName
-
- Required: Yes
- Type: string
The name of the explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
- JobResources
-
- Required: Yes
- Type: MonitoringResources structure
Identifies the resources to deploy for a monitoring job.
- ModelExplainabilityAppSpecification
-
- Required: Yes
- Type: ModelExplainabilityAppSpecification structure
Configures the model explainability job to run a specified Docker container image.
- ModelExplainabilityBaselineConfig
-
- Type: ModelExplainabilityBaselineConfig structure
The baseline configuration for a model explainability job.
- ModelExplainabilityJobInput
-
- Required: Yes
- Type: ModelExplainabilityJobInput structure
Inputs for the model explainability job.
- ModelExplainabilityJobOutputConfig
-
- Required: Yes
- Type: MonitoringOutputConfig structure
The output configuration for monitoring jobs.
- NetworkConfig
-
- Type: MonitoringNetworkConfig structure
Networking options for a model explainability job.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.
- StoppingCondition
-
- Type: MonitoringStoppingCondition structure
A time limit for how long the monitoring job is allowed to run before stopping.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeModelPackage
$result = $client->describeModelPackage([/* ... */]); $promise = $client->describeModelPackageAsync([/* ... */]);
Returns a description of the specified model package, which is used to create SageMaker models or list them on Amazon Web Services Marketplace.
If you provided a KMS Key ID when you created your model package, you will see the KMS Decrypt API call in your CloudTrail logs when you use this API. To call this operation without requiring kms:Decrypt permission on the customer-managed key, set IncludedData to MetadataOnly; the response is returned with the embedded ModelCard.ModelCardContent field sanitized.
To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services Marketplace.
Parameter Syntax
$result = $client->describeModelPackage([
'IncludedData' => 'AllData|MetadataOnly',
'ModelPackageName' => '', // REQUIRED
]);
Parameter Details
Members
- IncludedData
-
- Type: string
Specifies the level of model package data to include in the response. Use this parameter to call
DescribeModelPackageon a model package that has an associated model card without requiringkms:Decryptpermission on the customer-managed KMS key associated with the embedded model card.-
AllData: Returns the full model package response, including the unredactedModelCard.ModelCardContent. This option requireskms:Decryptpermission on the customer-managed key, if one is associated with the embedded model card. This is the default. -
MetadataOnly: Returns the full model package response, but with the embeddedModelCard.ModelCardContentsanitized to include only a small set of unencrypted metadata fields. This option does not requirekms:Decryptpermission. All other top-level response fields, includingInferenceSpecification,ModelMetrics,DriftCheckBaselines, andSecurityConfig, are returned unchanged. For the list of fields preserved withinModelCardContent, see ModelCard.
If you don't specify a value, SageMaker returns
AllData. - ModelPackageName
-
- Required: Yes
- Type: string
The name or Amazon Resource Name (ARN) of the model package to describe.
When you specify a name, the name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
Result Syntax
[
'AdditionalInferenceSpecifications' => [
[
'Containers' => [
[
'AdditionalModelDataSources' => [
[
'ChannelName' => '',
'S3DataSource' => [
'CompressionType' => 'None|Gzip',
'ETag' => '',
'HubAccessConfig' => [
'HubContentArn' => '',
],
'ManifestEtag' => '',
'ManifestS3Uri' => '',
'ModelAccessConfig' => [
'AcceptEula' => true || false,
],
'S3DataType' => 'S3Prefix|S3Object',
'S3Uri' => '',
],
],
// ...
],
'AdditionalS3DataSource' => [
'CompressionType' => 'None|Gzip',
'ETag' => '',
'S3DataType' => 'S3Object|S3Prefix',
'S3Uri' => '',
],
'BaseModel' => [
'HubContentName' => '',
'HubContentVersion' => '',
'RecipeName' => '',
],
'ContainerHostname' => '',
'Environment' => ['', ...],
'Framework' => '',
'FrameworkVersion' => '',
'Image' => '',
'ImageDigest' => '',
'IsCheckpoint' => true || false,
'ModelDataETag' => '',
'ModelDataSource' => [
'S3DataSource' => [
'CompressionType' => 'None|Gzip',
'ETag' => '',
'HubAccessConfig' => [
'HubContentArn' => '',
],
'ManifestEtag' => '',
'ManifestS3Uri' => '',
'ModelAccessConfig' => [
'AcceptEula' => true || false,
],
'S3DataType' => 'S3Prefix|S3Object',
'S3Uri' => '',
],
],
'ModelDataUrl' => '',
'ModelInput' => [
'DataInputConfig' => '',
],
'NearestModelName' => '',
'ProductId' => '',
],
// ...
],
'Description' => '',
'Name' => '',
'SupportedContentTypes' => ['', ...],
'SupportedRealtimeInferenceInstanceTypes' => ['', ...],
'SupportedResponseMIMETypes' => ['', ...],
'SupportedTransformInstanceTypes' => ['', ...],
],
// ...
],
'ApprovalDescription' => '',
'CertifyForMarketplace' => true || false,
'CreatedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'CreationTime' => ,
'CustomerMetadataProperties' => ['', ...],
'Domain' => '',
'DriftCheckBaselines' => [
'Bias' => [
'ConfigFile' => [
'ContentDigest' => '',
'ContentType' => '',
'S3Uri' => '',
],
'PostTrainingConstraints' => [
'ContentDigest' => '',
'ContentType' => '',
'S3Uri' => '',
],
'PreTrainingConstraints' => [
'ContentDigest' => '',
'ContentType' => '',
'S3Uri' => '',
],
],
'Explainability' => [
'ConfigFile' => [
'ContentDigest' => '',
'ContentType' => '',
'S3Uri' => '',
],
'Constraints' => [
'ContentDigest' => '',
'ContentType' => '',
'S3Uri' => '',
],
],
'ModelDataQuality' => [
'Constraints' => [
'ContentDigest' => '',
'ContentType' => '',
'S3Uri' => '',
],
'Statistics' => [
'ContentDigest' => '',
'ContentType' => '',
'S3Uri' => '',
],
],
'ModelQuality' => [
'Constraints' => [
'ContentDigest' => '',
'ContentType' => '',
'S3Uri' => '',
],
'Statistics' => [
'ContentDigest' => '',
'ContentType' => '',
'S3Uri' => '',
],
],
],
'InferenceSpecification' => [
'Containers' => [
[
'AdditionalModelDataSources' => [
[
'ChannelName' => '',
'S3DataSource' => [
'CompressionType' => 'None|Gzip',
'ETag' => '',
'HubAccessConfig' => [
'HubContentArn' => '',
],
'ManifestEtag' => '',
'ManifestS3Uri' => '',
'ModelAccessConfig' => [
'AcceptEula' => true || false,
],
'S3DataType' => 'S3Prefix|S3Object',
'S3Uri' => '',
],
],
// ...
],
'AdditionalS3DataSource' => [
'CompressionType' => 'None|Gzip',
'ETag' => '',
'S3DataType' => 'S3Object|S3Prefix',
'S3Uri' => '',
],
'BaseModel' => [
'HubContentName' => '',
'HubContentVersion' => '',
'RecipeName' => '',
],
'ContainerHostname' => '',
'Environment' => ['', ...],
'Framework' => '',
'FrameworkVersion' => '',
'Image' => '',
'ImageDigest' => '',
'IsCheckpoint' => true || false,
'ModelDataETag' => '',
'ModelDataSource' => [
'S3DataSource' => [
'CompressionType' => 'None|Gzip',
'ETag' => '',
'HubAccessConfig' => [
'HubContentArn' => '',
],
'ManifestEtag' => '',
'ManifestS3Uri' => '',
'ModelAccessConfig' => [
'AcceptEula' => true || false,
],
'S3DataType' => 'S3Prefix|S3Object',
'S3Uri' => '',
],
],
'ModelDataUrl' => '',
'ModelInput' => [
'DataInputConfig' => '',
],
'NearestModelName' => '',
'ProductId' => '',
],
// ...
],
'SupportedContentTypes' => ['', ...],
'SupportedRealtimeInferenceInstanceTypes' => ['', ...],
'SupportedResponseMIMETypes' => ['', ...],
'SupportedTransformInstanceTypes' => ['', ...],
],
'LastModifiedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'LastModifiedTime' => ,
'ManagedStorageType' => 'Restricted',
'MetadataProperties' => [
'CommitId' => '',
'GeneratedBy' => '',
'ProjectId' => '',
'Repository' => '',
],
'ModelApprovalStatus' => 'Approved|Rejected|PendingManualApproval',
'ModelCard' => [
'ModelCardContent' => '',
'ModelCardStatus' => 'Draft|PendingReview|Approved|Archived',
],
'ModelLifeCycle' => [
'Stage' => '',
'StageDescription' => '',
'StageStatus' => '',
],
'ModelMetrics' => [
'Bias' => [
'PostTrainingReport' => [
'ContentDigest' => '',
'ContentType' => '',
'S3Uri' => '',
],
'PreTrainingReport' => [
'ContentDigest' => '',
'ContentType' => '',
'S3Uri' => '',
],
'Report' => [
'ContentDigest' => '',
'ContentType' => '',
'S3Uri' => '',
],
],
'Explainability' => [
'Report' => [
'ContentDigest' => '',
'ContentType' => '',
'S3Uri' => '',
],
],
'ModelDataQuality' => [
'Constraints' => [
'ContentDigest' => '',
'ContentType' => '',
'S3Uri' => '',
],
'Statistics' => [
'ContentDigest' => '',
'ContentType' => '',
'S3Uri' => '',
],
],
'ModelQuality' => [
'Constraints' => [
'ContentDigest' => '',
'ContentType' => '',
'S3Uri' => '',
],
'Statistics' => [
'ContentDigest' => '',
'ContentType' => '',
'S3Uri' => '',
],
],
],
'ModelPackageArn' => '',
'ModelPackageDescription' => '',
'ModelPackageGroupName' => '',
'ModelPackageName' => '',
'ModelPackageRegistrationType' => 'Logged|Registered',
'ModelPackageStatus' => 'Pending|InProgress|Completed|Failed|Deleting',
'ModelPackageStatusDetails' => [
'ImageScanStatuses' => [
[
'FailureReason' => '',
'Name' => '',
'Status' => 'NotStarted|InProgress|Completed|Failed',
],
// ...
],
'ValidationStatuses' => [
[
'FailureReason' => '',
'Name' => '',
'Status' => 'NotStarted|InProgress|Completed|Failed',
],
// ...
],
],
'ModelPackageVersion' => ,
'SamplePayloadUrl' => '',
'SecurityConfig' => [
'KmsKeyId' => '',
],
'SkipModelValidation' => 'All|None',
'SourceAlgorithmSpecification' => [
'SourceAlgorithms' => [
[
'AlgorithmName' => '',
'ModelDataETag' => '',
'ModelDataSource' => [
'S3DataSource' => [
'CompressionType' => 'None|Gzip',
'ETag' => '',
'HubAccessConfig' => [
'HubContentArn' => '',
],
'ManifestEtag' => '',
'ManifestS3Uri' => '',
'ModelAccessConfig' => [
'AcceptEula' => true || false,
],
'S3DataType' => 'S3Prefix|S3Object',
'S3Uri' => '',
],
],
'ModelDataUrl' => '',
],
// ...
],
],
'SourceUri' => '',
'Task' => '',
'ValidationSpecification' => [
'ValidationProfiles' => [
[
'ProfileName' => '',
'TransformJobDefinition' => [
'BatchStrategy' => 'MultiRecord|SingleRecord',
'Environment' => ['', ...],
'MaxConcurrentTransforms' => ,
'MaxPayloadInMB' => ,
'TransformInput' => [
'CompressionType' => 'None|Gzip',
'ContentType' => '',
'DataSource' => [
'S3DataSource' => [
'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile|Converse',
'S3Uri' => '',
],
],
'SplitType' => 'None|Line|RecordIO|TFRecord',
],
'TransformOutput' => [
'Accept' => '',
'AssembleWith' => 'None|Line',
'KmsKeyId' => '',
'S3OutputPath' => '',
],
'TransformResources' => [
'InstanceCount' => ,
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge',
'TransformAmiVersion' => '',
'VolumeKmsKeyId' => '',
],
],
],
// ...
],
'ValidationRole' => '',
],
]
Result Details
Members
- AdditionalInferenceSpecifications
-
- Type: Array of AdditionalInferenceSpecificationDefinition structures
An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.
- ApprovalDescription
-
- Type: string
A description provided for the model approval.
- CertifyForMarketplace
-
- Type: boolean
Whether the model package is certified for listing on Amazon Web Services Marketplace.
- CreatedBy
-
- Type: UserContext structure
Information about the user who created or modified a SageMaker resource.
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp specifying when the model package was created.
- CustomerMetadataProperties
-
- Type: Associative array of custom strings keys (CustomerMetadataKey) to strings
The metadata properties associated with the model package versions.
- Domain
-
- Type: string
The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.
- DriftCheckBaselines
-
- Type: DriftCheckBaselines structure
Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.
- InferenceSpecification
-
- Type: InferenceSpecification structure
Details about inference jobs that you can run with models based on this model package.
- LastModifiedBy
-
- Type: UserContext structure
Information about the user who created or modified a SageMaker resource.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time that the model package was modified.
- ManagedStorageType
-
- Type: string
The storage type of the model package.
- MetadataProperties
-
- Type: MetadataProperties structure
Metadata properties of the tracking entity, trial, or trial component.
- ModelApprovalStatus
-
- Type: string
The approval status of the model package.
- ModelCard
-
- Type: ModelPackageModelCard structure
The model card associated with the model package. Since
ModelPackageModelCardis tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema ofModelCard. TheModelPackageModelCardschema does not includemodel_package_details, andmodel_overviewis composed of themodel_creatorandmodel_artifactproperties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.When you set
IncludedDatatoMetadataOnlyin the request,ModelCardStatusis preserved andModelCardContentis sanitized to include only the following JSON paths, when present in the model card:-
model_overview.model_id -
model_overview.model_name -
intended_uses.risk_rating -
model_package_details.model_package_group_name -
model_package_details.model_package_arn
Because the
ModelPackageModelCardschema does not includemodel_package_detailsand limitsmodel_overviewtomodel_creatorandmodel_artifact, the sanitizedModelCardContentfor a model package typically contains onlyintended_uses.risk_ratingif it was provided when the model card was created. To retrieve the completeModelCardContent, setIncludedDatatoAllDataor omit the parameter. - ModelLifeCycle
-
- Type: ModelLifeCycle structure
A structure describing the current state of the model in its life cycle.
- ModelMetrics
-
- Type: ModelMetrics structure
Metrics for the model.
- ModelPackageArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the model package.
- ModelPackageDescription
-
- Type: string
A brief summary of the model package.
- ModelPackageGroupName
-
- Type: string
If the model is a versioned model, the name of the model group that the versioned model belongs to.
- ModelPackageName
-
- Required: Yes
- Type: string
The name of the model package being described.
- ModelPackageRegistrationType
-
- Type: string
The package registration type of the model package output.
- ModelPackageStatus
-
- Required: Yes
- Type: string
The current status of the model package.
- ModelPackageStatusDetails
-
- Required: Yes
- Type: ModelPackageStatusDetails structure
Details about the current status of the model package.
- ModelPackageVersion
-
- Type: int
The version of the model package.
- SamplePayloadUrl
-
- Type: string
The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single gzip compressed tar archive (.tar.gz suffix).
- SecurityConfig
-
- Type: ModelPackageSecurityConfig structure
The KMS Key ID (
KMSKeyId) used for encryption of model package information. - SkipModelValidation
-
- Type: string
Indicates if you want to skip model validation.
- SourceAlgorithmSpecification
-
- Type: SourceAlgorithmSpecification structure
Details about the algorithm that was used to create the model package.
- SourceUri
-
- Type: string
The URI of the source for the model package.
- Task
-
- Type: string
The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.
- ValidationSpecification
-
- Type: ModelPackageValidationSpecification structure
Configurations for one or more transform jobs that SageMaker runs to test the model package.
Errors
There are no errors described for this operation.
DescribeModelPackageGroup
$result = $client->describeModelPackageGroup([/* ... */]); $promise = $client->describeModelPackageGroupAsync([/* ... */]);
Gets a description for the specified model group.
Parameter Syntax
$result = $client->describeModelPackageGroup([
'ModelPackageGroupName' => '', // REQUIRED
]);
Parameter Details
Members
- ModelPackageGroupName
-
- Required: Yes
- Type: string
The name of the model group to describe.
Result Syntax
[
'CreatedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'CreationTime' => ,
'ManagedConfiguration' => [
'ManagedStorageType' => 'Restricted',
],
'ModelPackageGroupArn' => '',
'ModelPackageGroupDescription' => '',
'ModelPackageGroupName' => '',
'ModelPackageGroupStatus' => 'Pending|InProgress|Completed|Failed|Deleting|DeleteFailed',
]
Result Details
Members
- CreatedBy
-
- Required: Yes
- Type: UserContext structure
Information about the user who created or modified a SageMaker resource.
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the model group was created.
- ManagedConfiguration
-
- Type: ManagedConfiguration structure
The managed configuration of the model package group.
- ModelPackageGroupArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the model group.
- ModelPackageGroupDescription
-
- Type: string
A description of the model group.
- ModelPackageGroupName
-
- Required: Yes
- Type: string
The name of the model group.
- ModelPackageGroupStatus
-
- Required: Yes
- Type: string
The status of the model group.
Errors
There are no errors described for this operation.
DescribeModelQualityJobDefinition
$result = $client->describeModelQualityJobDefinition([/* ... */]); $promise = $client->describeModelQualityJobDefinitionAsync([/* ... */]);
Returns a description of a model quality job definition.
Parameter Syntax
$result = $client->describeModelQualityJobDefinition([
'JobDefinitionName' => '', // REQUIRED
]);
Parameter Details
Members
- JobDefinitionName
-
- Required: Yes
- Type: string
The name of the model quality job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
Result Syntax
[
'CreationTime' => ,
'JobDefinitionArn' => '',
'JobDefinitionName' => '',
'JobResources' => [
'ClusterConfig' => [
'InstanceCount' => ,
'InstanceType' => 'ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p5.4xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'VolumeKmsKeyId' => '',
'VolumeSizeInGB' => ,
],
],
'ModelQualityAppSpecification' => [
'ContainerArguments' => ['', ...],
'ContainerEntrypoint' => ['', ...],
'Environment' => ['', ...],
'ImageUri' => '',
'PostAnalyticsProcessorSourceUri' => '',
'ProblemType' => 'BinaryClassification|MulticlassClassification|Regression',
'RecordPreprocessorSourceUri' => '',
],
'ModelQualityBaselineConfig' => [
'BaseliningJobName' => '',
'ConstraintsResource' => [
'S3Uri' => '',
],
],
'ModelQualityJobInput' => [
'BatchTransformInput' => [
'DataCapturedDestinationS3Uri' => '',
'DatasetFormat' => [
'Csv' => [
'Header' => true || false,
],
'Json' => [
'Line' => true || false,
],
'Parquet' => [
],
],
'EndTimeOffset' => '',
'ExcludeFeaturesAttribute' => '',
'FeaturesAttribute' => '',
'InferenceAttribute' => '',
'LocalPath' => '',
'ProbabilityAttribute' => '',
'ProbabilityThresholdAttribute' => ,
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3InputMode' => 'Pipe|File',
'StartTimeOffset' => '',
],
'EndpointInput' => [
'EndTimeOffset' => '',
'EndpointName' => '',
'ExcludeFeaturesAttribute' => '',
'FeaturesAttribute' => '',
'InferenceAttribute' => '',
'LocalPath' => '',
'ProbabilityAttribute' => '',
'ProbabilityThresholdAttribute' => ,
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3InputMode' => 'Pipe|File',
'StartTimeOffset' => '',
],
'GroundTruthS3Input' => [
'S3Uri' => '',
],
],
'ModelQualityJobOutputConfig' => [
'KmsKeyId' => '',
'MonitoringOutputs' => [
[
'S3Output' => [
'LocalPath' => '',
'S3UploadMode' => 'Continuous|EndOfJob',
'S3Uri' => '',
],
],
// ...
],
],
'NetworkConfig' => [
'EnableInterContainerTrafficEncryption' => true || false,
'EnableNetworkIsolation' => true || false,
'VpcConfig' => [
'SecurityGroupIds' => ['', ...],
'Subnets' => ['', ...],
],
],
'RoleArn' => '',
'StoppingCondition' => [
'MaxRuntimeInSeconds' => ,
],
]
Result Details
Members
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the model quality job was created.
- JobDefinitionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the model quality job.
- JobDefinitionName
-
- Required: Yes
- Type: string
The name of the quality job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
- JobResources
-
- Required: Yes
- Type: MonitoringResources structure
Identifies the resources to deploy for a monitoring job.
- ModelQualityAppSpecification
-
- Required: Yes
- Type: ModelQualityAppSpecification structure
Configures the model quality job to run a specified Docker container image.
- ModelQualityBaselineConfig
-
- Type: ModelQualityBaselineConfig structure
The baseline configuration for a model quality job.
- ModelQualityJobInput
-
- Required: Yes
- Type: ModelQualityJobInput structure
Inputs for the model quality job.
- ModelQualityJobOutputConfig
-
- Required: Yes
- Type: MonitoringOutputConfig structure
The output configuration for monitoring jobs.
- NetworkConfig
-
- Type: MonitoringNetworkConfig structure
Networking options for a model quality job.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.
- StoppingCondition
-
- Type: MonitoringStoppingCondition structure
A time limit for how long the monitoring job is allowed to run before stopping.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeMonitoringSchedule
$result = $client->describeMonitoringSchedule([/* ... */]); $promise = $client->describeMonitoringScheduleAsync([/* ... */]);
Describes the schedule for a monitoring job.
Parameter Syntax
$result = $client->describeMonitoringSchedule([
'MonitoringScheduleName' => '', // REQUIRED
]);
Parameter Details
Members
- MonitoringScheduleName
-
- Required: Yes
- Type: string
Name of a previously created monitoring schedule.
Result Syntax
[
'CreationTime' => ,
'EndpointName' => '',
'FailureReason' => '',
'LastModifiedTime' => ,
'LastMonitoringExecutionSummary' => [
'CreationTime' => ,
'EndpointName' => '',
'FailureReason' => '',
'LastModifiedTime' => ,
'MonitoringExecutionStatus' => 'Pending|Completed|CompletedWithViolations|InProgress|Failed|Stopping|Stopped',
'MonitoringJobDefinitionName' => '',
'MonitoringScheduleName' => '',
'MonitoringType' => 'DataQuality|ModelQuality|ModelBias|ModelExplainability',
'ProcessingJobArn' => '',
'ScheduledTime' => ,
],
'MonitoringScheduleArn' => '',
'MonitoringScheduleConfig' => [
'MonitoringJobDefinition' => [
'BaselineConfig' => [
'BaseliningJobName' => '',
'ConstraintsResource' => [
'S3Uri' => '',
],
'StatisticsResource' => [
'S3Uri' => '',
],
],
'Environment' => ['', ...],
'MonitoringAppSpecification' => [
'ContainerArguments' => ['', ...],
'ContainerEntrypoint' => ['', ...],
'ImageUri' => '',
'PostAnalyticsProcessorSourceUri' => '',
'RecordPreprocessorSourceUri' => '',
],
'MonitoringInputs' => [
[
'BatchTransformInput' => [
'DataCapturedDestinationS3Uri' => '',
'DatasetFormat' => [
'Csv' => [
'Header' => true || false,
],
'Json' => [
'Line' => true || false,
],
'Parquet' => [
],
],
'EndTimeOffset' => '',
'ExcludeFeaturesAttribute' => '',
'FeaturesAttribute' => '',
'InferenceAttribute' => '',
'LocalPath' => '',
'ProbabilityAttribute' => '',
'ProbabilityThresholdAttribute' => ,
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3InputMode' => 'Pipe|File',
'StartTimeOffset' => '',
],
'EndpointInput' => [
'EndTimeOffset' => '',
'EndpointName' => '',
'ExcludeFeaturesAttribute' => '',
'FeaturesAttribute' => '',
'InferenceAttribute' => '',
'LocalPath' => '',
'ProbabilityAttribute' => '',
'ProbabilityThresholdAttribute' => ,
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3InputMode' => 'Pipe|File',
'StartTimeOffset' => '',
],
],
// ...
],
'MonitoringOutputConfig' => [
'KmsKeyId' => '',
'MonitoringOutputs' => [
[
'S3Output' => [
'LocalPath' => '',
'S3UploadMode' => 'Continuous|EndOfJob',
'S3Uri' => '',
],
],
// ...
],
],
'MonitoringResources' => [
'ClusterConfig' => [
'InstanceCount' => ,
'InstanceType' => 'ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p5.4xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'VolumeKmsKeyId' => '',
'VolumeSizeInGB' => ,
],
],
'NetworkConfig' => [
'EnableInterContainerTrafficEncryption' => true || false,
'EnableNetworkIsolation' => true || false,
'VpcConfig' => [
'SecurityGroupIds' => ['', ...],
'Subnets' => ['', ...],
],
],
'RoleArn' => '',
'StoppingCondition' => [
'MaxRuntimeInSeconds' => ,
],
],
'MonitoringJobDefinitionName' => '',
'MonitoringType' => 'DataQuality|ModelQuality|ModelBias|ModelExplainability',
'ScheduleConfig' => [
'DataAnalysisEndTime' => '',
'DataAnalysisStartTime' => '',
'ScheduleExpression' => '',
],
],
'MonitoringScheduleName' => '',
'MonitoringScheduleStatus' => 'Pending|Failed|Scheduled|Stopped',
'MonitoringType' => 'DataQuality|ModelQuality|ModelBias|ModelExplainability',
]
Result Details
Members
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the monitoring job was created.
- EndpointName
-
- Type: string
The name of the endpoint for the monitoring job.
- FailureReason
-
- Type: string
A string, up to one KB in size, that contains the reason a monitoring job failed, if it failed.
- LastModifiedTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the monitoring job was last modified.
- LastMonitoringExecutionSummary
-
- Type: MonitoringExecutionSummary structure
Describes metadata on the last execution to run, if there was one.
- MonitoringScheduleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the monitoring schedule.
- MonitoringScheduleConfig
-
- Required: Yes
- Type: MonitoringScheduleConfig structure
The configuration object that specifies the monitoring schedule and defines the monitoring job.
- MonitoringScheduleName
-
- Required: Yes
- Type: string
Name of the monitoring schedule.
- MonitoringScheduleStatus
-
- Required: Yes
- Type: string
The status of an monitoring job.
- MonitoringType
-
- Type: string
The type of the monitoring job that this schedule runs. This is one of the following values.
-
DATA_QUALITY- The schedule is for a data quality monitoring job. -
MODEL_QUALITY- The schedule is for a model quality monitoring job. -
MODEL_BIAS- The schedule is for a bias monitoring job. -
MODEL_EXPLAINABILITY- The schedule is for an explainability monitoring job.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeNotebookInstance
$result = $client->describeNotebookInstance([/* ... */]); $promise = $client->describeNotebookInstanceAsync([/* ... */]);
Returns information about a notebook instance.
Parameter Syntax
$result = $client->describeNotebookInstance([
'NotebookInstanceName' => '', // REQUIRED
]);
Parameter Details
Members
- NotebookInstanceName
-
- Required: Yes
- Type: string
The name of the notebook instance that you want information about.
Result Syntax
[
'AcceleratorTypes' => ['', ...],
'AdditionalCodeRepositories' => ['', ...],
'CreationTime' => ,
'DefaultCodeRepository' => '',
'DirectInternetAccess' => 'Enabled|Disabled',
'FailureReason' => '',
'InstanceMetadataServiceConfiguration' => [
'MinimumInstanceMetadataServiceVersion' => '',
],
'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.p5.4xlarge|ml.p5en.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge',
'IpAddressType' => 'ipv4|dualstack',
'KmsKeyId' => '',
'LastModifiedTime' => ,
'NetworkInterfaceId' => '',
'NotebookInstanceArn' => '',
'NotebookInstanceLifecycleConfigName' => '',
'NotebookInstanceName' => '',
'NotebookInstanceStatus' => 'Pending|InService|Stopping|Stopped|Failed|Deleting|Updating|PendingMaintenance|InMaintenance',
'PlatformIdentifier' => '',
'RoleArn' => '',
'RootAccess' => 'Enabled|Disabled',
'SecurityGroups' => ['', ...],
'SubnetId' => '',
'Url' => '',
'VolumeSizeInGB' => ,
]
Result Details
Members
- AcceleratorTypes
-
- Type: Array of strings
This parameter is no longer supported. Elastic Inference (EI) is no longer available.
This parameter was used to specify a list of the EI instance types associated with this notebook instance.
- AdditionalCodeRepositories
-
- Type: Array of strings
An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp. Use this parameter to return the time when the notebook instance was created
- DefaultCodeRepository
-
- Type: string
The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.
- DirectInternetAccess
-
- Type: string
Describes whether SageMaker AI provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to SageMaker AI training and endpoint services.
For more information, see Notebook Instances Are Internet-Enabled by Default.
- FailureReason
-
- Type: string
If status is
Failed, the reason it failed. - InstanceMetadataServiceConfiguration
-
- Type: InstanceMetadataServiceConfiguration structure
Information on the IMDS configuration of the notebook instance
- InstanceType
-
- Type: string
The type of ML compute instance running on the notebook instance.
- IpAddressType
-
- Type: string
The IP address type configured for the notebook instance. Returns
ipv4for IPv4-only connectivity ordualstackfor both IPv4 and IPv6 connectivity. - KmsKeyId
-
- Type: string
The Amazon Web Services KMS key ID SageMaker AI uses to encrypt data when storing it on the ML storage volume attached to the instance.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.
- NetworkInterfaceId
-
- Type: string
The network interface IDs that SageMaker AI created at the time of creating the instance.
- NotebookInstanceArn
-
- Type: string
The Amazon Resource Name (ARN) of the notebook instance.
- NotebookInstanceLifecycleConfigName
-
- Type: string
Returns the name of a notebook instance lifecycle configuration.
For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance
- NotebookInstanceName
-
- Type: string
The name of the SageMaker AI notebook instance.
- NotebookInstanceStatus
-
- Type: string
The status of the notebook instance.
- PlatformIdentifier
-
- Type: string
The platform identifier of the notebook instance runtime environment.
- RoleArn
-
- Type: string
The Amazon Resource Name (ARN) of the IAM role associated with the instance.
- RootAccess
-
- Type: string
Whether root access is enabled or disabled for users of the notebook instance.
Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.
- SecurityGroups
-
- Type: Array of strings
The IDs of the VPC security groups.
- SubnetId
-
- Type: string
The ID of the VPC subnet.
- Url
-
- Type: string
The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
- VolumeSizeInGB
-
- Type: int
The size, in GB, of the ML storage volume attached to the notebook instance.
Errors
There are no errors described for this operation.
DescribeNotebookInstanceLifecycleConfig
$result = $client->describeNotebookInstanceLifecycleConfig([/* ... */]); $promise = $client->describeNotebookInstanceLifecycleConfigAsync([/* ... */]);
Returns a description of a notebook instance lifecycle configuration.
For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.
Parameter Syntax
$result = $client->describeNotebookInstanceLifecycleConfig([
'NotebookInstanceLifecycleConfigName' => '', // REQUIRED
]);
Parameter Details
Members
- NotebookInstanceLifecycleConfigName
-
- Required: Yes
- Type: string
The name of the lifecycle configuration to describe.
Result Syntax
[
'CreationTime' => ,
'LastModifiedTime' => ,
'NotebookInstanceLifecycleConfigArn' => '',
'NotebookInstanceLifecycleConfigName' => '',
'OnCreate' => [
[
'Content' => '',
],
// ...
],
'OnStart' => [
[
'Content' => '',
],
// ...
],
]
Result Details
Members
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that tells when the lifecycle configuration was created.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that tells when the lifecycle configuration was last modified.
- NotebookInstanceLifecycleConfigArn
-
- Type: string
The Amazon Resource Name (ARN) of the lifecycle configuration.
- NotebookInstanceLifecycleConfigName
-
- Type: string
The name of the lifecycle configuration.
- OnCreate
-
- Type: Array of NotebookInstanceLifecycleHook structures
The shell script that runs only once, when you create a notebook instance.
- OnStart
-
- Type: Array of NotebookInstanceLifecycleHook structures
The shell script that runs every time you start a notebook instance, including when you create the notebook instance.
Errors
There are no errors described for this operation.
DescribeOptimizationJob
$result = $client->describeOptimizationJob([/* ... */]); $promise = $client->describeOptimizationJobAsync([/* ... */]);
Provides the properties of the specified optimization job.
Parameter Syntax
$result = $client->describeOptimizationJob([
'OptimizationJobName' => '', // REQUIRED
]);
Parameter Details
Members
- OptimizationJobName
-
- Required: Yes
- Type: string
The name that you assigned to the optimization job.
Result Syntax
[
'CreationTime' => ,
'DeploymentInstanceType' => 'ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p6-b200.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge',
'FailureReason' => '',
'LastModifiedTime' => ,
'MaxInstanceCount' => ,
'ModelSource' => [
'S3' => [
'ModelAccessConfig' => [
'AcceptEula' => true || false,
],
'S3Uri' => '',
],
'SageMakerModel' => [
'ModelName' => '',
],
],
'OptimizationConfigs' => [
[
'ModelCompilationConfig' => [
'Image' => '',
'OverrideEnvironment' => ['', ...],
],
'ModelQuantizationConfig' => [
'Image' => '',
'OverrideEnvironment' => ['', ...],
],
'ModelShardingConfig' => [
'Image' => '',
'OverrideEnvironment' => ['', ...],
],
'ModelSpeculativeDecodingConfig' => [
'Technique' => 'EAGLE',
'TrainingDataSource' => [
'S3DataType' => 'S3Prefix|ManifestFile',
'S3Uri' => '',
],
],
],
// ...
],
'OptimizationEndTime' => ,
'OptimizationEnvironment' => ['', ...],
'OptimizationJobArn' => '',
'OptimizationJobName' => '',
'OptimizationJobStatus' => 'INPROGRESS|COMPLETED|FAILED|STARTING|STOPPING|STOPPED',
'OptimizationOutput' => [
'RecommendedInferenceImage' => '',
],
'OptimizationStartTime' => ,
'OutputConfig' => [
'KmsKeyId' => '',
'S3OutputLocation' => '',
'SageMakerModel' => [
'ModelName' => '',
],
],
'RoleArn' => '',
'StoppingCondition' => [
'MaxPendingTimeInSeconds' => ,
'MaxRuntimeInSeconds' => ,
'MaxWaitTimeInSeconds' => ,
],
'TrainingPlanArns' => ['', ...],
'VpcConfig' => [
'SecurityGroupIds' => ['', ...],
'Subnets' => ['', ...],
],
]
Result Details
Members
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when you created the optimization job.
- DeploymentInstanceType
-
- Required: Yes
- Type: string
The type of instance that hosts the optimized model that you create with the optimization job.
- FailureReason
-
- Type: string
If the optimization job status is
FAILED, the reason for the failure. - LastModifiedTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the optimization job was last updated.
- MaxInstanceCount
-
- Type: int
The maximum number of instances to use for the optimization job.
- ModelSource
-
- Required: Yes
- Type: OptimizationJobModelSource structure
The location of the source model to optimize with an optimization job.
- OptimizationConfigs
-
- Required: Yes
- Type: Array of OptimizationConfig structures
Settings for each of the optimization techniques that the job applies.
- OptimizationEndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the optimization job finished processing.
- OptimizationEnvironment
-
- Type: Associative array of custom strings keys (NonEmptyString256) to strings
The environment variables to set in the model container.
- OptimizationJobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the optimization job.
- OptimizationJobName
-
- Required: Yes
- Type: string
The name that you assigned to the optimization job.
- OptimizationJobStatus
-
- Required: Yes
- Type: string
The current status of the optimization job.
- OptimizationOutput
-
- Type: OptimizationOutput structure
Output values produced by an optimization job.
- OptimizationStartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the optimization job started.
- OutputConfig
-
- Required: Yes
- Type: OptimizationJobOutputConfig structure
Details for where to store the optimized model that you create with the optimization job.
- RoleArn
-
- Required: Yes
- Type: string
The ARN of the IAM role that you assigned to the optimization job.
- StoppingCondition
-
- Required: Yes
- Type: StoppingCondition structure
Specifies a limit to how long a job can run. When the job reaches the time limit, SageMaker ends the job. Use this API to cap costs.
To stop a training job, SageMaker sends the algorithm the
SIGTERMsignal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.The training algorithms provided by SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with
CreateModel.The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.
- TrainingPlanArns
-
- Type: Array of strings
The Amazon Resource Name (ARN) of the training plan associated with this optimization job. This field appears only when you specified a training plan when you created the job. Optimization jobs that use on-demand capacity don't return this field.
- VpcConfig
-
- Type: OptimizationVpcConfig structure
A VPC in Amazon VPC that your optimized model has access to.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribePartnerApp
$result = $client->describePartnerApp([/* ... */]); $promise = $client->describePartnerAppAsync([/* ... */]);
Gets information about a SageMaker Partner AI App.
Parameter Syntax
$result = $client->describePartnerApp([
'Arn' => '', // REQUIRED
'IncludeAvailableUpgrade' => true || false,
]);
Parameter Details
Members
- Arn
-
- Required: Yes
- Type: string
The ARN of the SageMaker Partner AI App to describe.
- IncludeAvailableUpgrade
-
- Type: boolean
When set to
TRUE, the response includes available upgrade information for the SageMaker Partner AI App. Default isFALSE.
Result Syntax
[
'ApplicationConfig' => [
'AdminUsers' => ['', ...],
'Arguments' => ['', ...],
'AssignedGroupPatterns' => ['', ...],
'RoleGroupAssignments' => [
[
'GroupPatterns' => ['', ...],
'RoleName' => '',
],
// ...
],
],
'Arn' => '',
'AuthType' => 'IAM|IDC',
'AvailableUpgrade' => [
'ReleaseNotes' => ['', ...],
'Version' => '',
],
'BaseUrl' => '',
'CreationTime' => ,
'CurrentVersionEolDate' => ,
'EnableAutoMinorVersionUpgrade' => true || false,
'EnableIamSessionBasedIdentity' => true || false,
'Error' => [
'Code' => '',
'Reason' => '',
],
'ExecutionRoleArn' => '',
'IdcConfig' => [
'ApplicationArn' => '',
'InstanceArn' => '',
],
'KmsKeyId' => '',
'LastModifiedTime' => ,
'MaintenanceConfig' => [
'MaintenanceWindowStart' => '',
],
'Name' => '',
'Status' => 'Creating|Updating|Deleting|Available|Failed|UpdateFailed|Deleted',
'Tier' => '',
'Type' => 'lakera-guard|comet|deepchecks-llm-evaluation|fiddler',
'Version' => '',
]
Result Details
Members
- ApplicationConfig
-
- Type: PartnerAppConfig structure
Configuration settings for the SageMaker Partner AI App.
- Arn
-
- Type: string
The ARN of the SageMaker Partner AI App that was described.
- AuthType
-
- Type: string
The authorization type that users use to access the SageMaker Partner AI App. Valid values:
-
IAM: Users access the SageMaker Partner AI App with their Amazon Web Services IAM identity. -
IDC: Users access the SageMaker Partner AI App with their Amazon Web Services IAM Identity Center identity.
- AvailableUpgrade
-
- Type: AvailableUpgrade structure
A map of available minor version upgrades for the SageMaker Partner AI App. The key is the semantic version number, and the value is a list of release notes for that version. A null value indicates no upgrades are available.
- BaseUrl
-
- Type: string
The URL of the SageMaker Partner AI App that the Application SDK uses to support in-app calls for the user.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the SageMaker Partner AI App was created.
- CurrentVersionEolDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The end-of-life date for the current version of the SageMaker Partner AI App.
- EnableAutoMinorVersionUpgrade
-
- Type: boolean
Indicates whether the SageMaker Partner AI App is configured for automatic minor version upgrades during scheduled maintenance windows.
- EnableIamSessionBasedIdentity
-
- Type: boolean
When set to
TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user. - Error
-
- Type: ErrorInfo structure
This is an error field object that contains the error code and the reason for an operation failure.
- ExecutionRoleArn
-
- Type: string
The ARN of the IAM role associated with the SageMaker Partner AI App.
- IdcConfig
-
- Type: IdcConfigOutput structure
Contains the Amazon Web Services IAM Identity Center configuration for the SageMaker Partner AI App, including the Identity Center instance and the Identity Center application that SageMaker creates for the app. The service returns this field for apps that use
IDCauthorization. - KmsKeyId
-
- Type: string
The Amazon Web Services KMS customer managed key used to encrypt the data at rest associated with SageMaker Partner AI Apps.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the SageMaker Partner AI App was last modified.
- MaintenanceConfig
-
- Type: PartnerAppMaintenanceConfig structure
Maintenance configuration settings for the SageMaker Partner AI App.
- Name
-
- Type: string
The name of the SageMaker Partner AI App.
- Status
-
- Type: string
The status of the SageMaker Partner AI App.
-
Creating: SageMaker AI is creating the partner AI app. The partner AI app is not available during creation.
-
Updating: SageMaker AI is updating the partner AI app. The partner AI app is not available when updating.
-
Deleting: SageMaker AI is deleting the partner AI app. The partner AI app is not available during deletion.
-
Available: The partner AI app is provisioned and accessible.
-
Failed: The partner AI app is in a failed state and isn't available. SageMaker AI is investigating the issue. For further guidance, contact Amazon Web Services Support.
-
UpdateFailed: The partner AI app couldn't be updated but is available.
-
Deleted: The partner AI app is permanently deleted and not available.
- Tier
-
- Type: string
The instance type and size of the cluster attached to the SageMaker Partner AI App.
- Type
-
- Type: string
The type of SageMaker Partner AI App. Must be one of the following:
lakera-guard,comet,deepchecks-llm-evaluation, orfiddler. - Version
-
- Type: string
The version of the SageMaker Partner AI App.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribePipeline
$result = $client->describePipeline([/* ... */]); $promise = $client->describePipelineAsync([/* ... */]);
Describes the details of a pipeline.
Parameter Syntax
$result = $client->describePipeline([
'PipelineName' => '', // REQUIRED
'PipelineVersionId' => ,
]);
Parameter Details
Members
- PipelineName
-
- Required: Yes
- Type: string
The name or Amazon Resource Name (ARN) of the pipeline to describe.
- PipelineVersionId
-
- Type: long (int|float)
The ID of the pipeline version to describe.
Result Syntax
[
'CreatedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'CreationTime' => ,
'LastModifiedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'LastModifiedTime' => ,
'LastRunTime' => ,
'ParallelismConfiguration' => [
'MaxParallelExecutionSteps' => ,
],
'PipelineArn' => '',
'PipelineDefinition' => '',
'PipelineDescription' => '',
'PipelineDisplayName' => '',
'PipelineName' => '',
'PipelineStatus' => 'Active|Deleting',
'PipelineVersionDescription' => '',
'PipelineVersionDisplayName' => '',
'RoleArn' => '',
]
Result Details
Members
- CreatedBy
-
- Type: UserContext structure
Information about the user who created or modified a SageMaker resource.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the pipeline was created.
- LastModifiedBy
-
- Type: UserContext structure
Information about the user who created or modified a SageMaker resource.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the pipeline was last modified.
- LastRunTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the pipeline was last run.
- ParallelismConfiguration
-
- Type: ParallelismConfiguration structure
Lists the parallelism configuration applied to the pipeline.
- PipelineArn
-
- Type: string
The Amazon Resource Name (ARN) of the pipeline.
- PipelineDefinition
-
- Type: string
The JSON pipeline definition.
- PipelineDescription
-
- Type: string
The description of the pipeline.
- PipelineDisplayName
-
- Type: string
The display name of the pipeline.
- PipelineName
-
- Type: string
The name of the pipeline.
- PipelineStatus
-
- Type: string
The status of the pipeline execution.
- PipelineVersionDescription
-
- Type: string
The description of the pipeline version.
- PipelineVersionDisplayName
-
- Type: string
The display name of the pipeline version.
- RoleArn
-
- Type: string
The Amazon Resource Name (ARN) that the pipeline uses to execute.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribePipelineDefinitionForExecution
$result = $client->describePipelineDefinitionForExecution([/* ... */]); $promise = $client->describePipelineDefinitionForExecutionAsync([/* ... */]);
Describes the details of an execution's pipeline definition.
Parameter Syntax
$result = $client->describePipelineDefinitionForExecution([
'PipelineExecutionArn' => '', // REQUIRED
]);
Parameter Details
Members
- PipelineExecutionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the pipeline execution.
Result Syntax
[
'CreationTime' => ,
'PipelineDefinition' => '',
]
Result Details
Members
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the pipeline was created.
- PipelineDefinition
-
- Type: string
The JSON pipeline definition.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribePipelineExecution
$result = $client->describePipelineExecution([/* ... */]); $promise = $client->describePipelineExecutionAsync([/* ... */]);
Describes the details of a pipeline execution.
Parameter Syntax
$result = $client->describePipelineExecution([
'PipelineExecutionArn' => '', // REQUIRED
]);
Parameter Details
Members
- PipelineExecutionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the pipeline execution.
Result Syntax
[
'CreatedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'CreationTime' => ,
'FailureReason' => '',
'LastModifiedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'LastModifiedTime' => ,
'MLflowConfig' => [
'MlflowExperimentName' => '',
'MlflowResourceArn' => '',
],
'ParallelismConfiguration' => [
'MaxParallelExecutionSteps' => ,
],
'PipelineArn' => '',
'PipelineExecutionArn' => '',
'PipelineExecutionDescription' => '',
'PipelineExecutionDisplayName' => '',
'PipelineExecutionStatus' => 'Executing|Stopping|Stopped|Failed|Succeeded',
'PipelineExperimentConfig' => [
'ExperimentName' => '',
'TrialName' => '',
],
'PipelineVersionId' => ,
'SelectiveExecutionConfig' => [
'SelectedSteps' => [
[
'StepName' => '',
],
// ...
],
'SourcePipelineExecutionArn' => '',
],
]
Result Details
Members
- CreatedBy
-
- Type: UserContext structure
Information about the user who created or modified a SageMaker resource.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the pipeline execution was created.
- FailureReason
-
- Type: string
If the execution failed, a message describing why.
- LastModifiedBy
-
- Type: UserContext structure
Information about the user who created or modified a SageMaker resource.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the pipeline execution was modified last.
- MLflowConfig
-
- Type: MLflowConfiguration structure
The MLflow configuration of the pipeline execution.
- ParallelismConfiguration
-
- Type: ParallelismConfiguration structure
The parallelism configuration applied to the pipeline.
- PipelineArn
-
- Type: string
The Amazon Resource Name (ARN) of the pipeline.
- PipelineExecutionArn
-
- Type: string
The Amazon Resource Name (ARN) of the pipeline execution.
- PipelineExecutionDescription
-
- Type: string
The description of the pipeline execution.
- PipelineExecutionDisplayName
-
- Type: string
The display name of the pipeline execution.
- PipelineExecutionStatus
-
- Type: string
The status of the pipeline execution.
- PipelineExperimentConfig
-
- Type: PipelineExperimentConfig structure
Specifies the names of the experiment and trial created by a pipeline.
- PipelineVersionId
-
- Type: long (int|float)
The ID of the pipeline version.
- SelectiveExecutionConfig
-
- Type: SelectiveExecutionConfig structure
The selective execution configuration applied to the pipeline run.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeProcessingJob
$result = $client->describeProcessingJob([/* ... */]); $promise = $client->describeProcessingJobAsync([/* ... */]);
Returns a description of a processing job.
Parameter Syntax
$result = $client->describeProcessingJob([
'ProcessingJobName' => '', // REQUIRED
]);
Parameter Details
Members
- ProcessingJobName
-
- Required: Yes
- Type: string
The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
Result Syntax
[
'AppSpecification' => [
'ContainerArguments' => ['', ...],
'ContainerEntrypoint' => ['', ...],
'ImageUri' => '',
],
'AutoMLJobArn' => '',
'CreationTime' => ,
'Environment' => ['', ...],
'ExitMessage' => '',
'ExperimentConfig' => [
'ExperimentName' => '',
'RunName' => '',
'TrialComponentDisplayName' => '',
'TrialName' => '',
],
'FailureReason' => '',
'LastModifiedTime' => ,
'MonitoringScheduleArn' => '',
'NetworkConfig' => [
'EnableInterContainerTrafficEncryption' => true || false,
'EnableNetworkIsolation' => true || false,
'VpcConfig' => [
'SecurityGroupIds' => ['', ...],
'Subnets' => ['', ...],
],
],
'ProcessingEndTime' => ,
'ProcessingInputs' => [
[
'AppManaged' => true || false,
'DatasetDefinition' => [
'AthenaDatasetDefinition' => [
'Catalog' => '',
'Database' => '',
'KmsKeyId' => '',
'OutputCompression' => 'GZIP|SNAPPY|ZLIB',
'OutputFormat' => 'PARQUET|ORC|AVRO|JSON|TEXTFILE',
'OutputS3Uri' => '',
'QueryString' => '',
'WorkGroup' => '',
],
'DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'InputMode' => 'Pipe|File',
'LocalPath' => '',
'RedshiftDatasetDefinition' => [
'ClusterId' => '',
'ClusterRoleArn' => '',
'Database' => '',
'DbUser' => '',
'KmsKeyId' => '',
'OutputCompression' => 'None|GZIP|BZIP2|ZSTD|SNAPPY',
'OutputFormat' => 'PARQUET|CSV',
'OutputS3Uri' => '',
'QueryString' => '',
],
],
'InputName' => '',
'S3Input' => [
'LocalPath' => '',
'S3CompressionType' => 'None|Gzip',
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3DataType' => 'ManifestFile|S3Prefix',
'S3InputMode' => 'Pipe|File',
'S3Uri' => '',
],
],
// ...
],
'ProcessingJobArn' => '',
'ProcessingJobName' => '',
'ProcessingJobStatus' => 'InProgress|Completed|Failed|Stopping|Stopped',
'ProcessingOutputConfig' => [
'KmsKeyId' => '',
'Outputs' => [
[
'AppManaged' => true || false,
'FeatureStoreOutput' => [
'FeatureGroupName' => '',
],
'OutputName' => '',
'S3Output' => [
'LocalPath' => '',
'S3UploadMode' => 'Continuous|EndOfJob',
'S3Uri' => '',
],
],
// ...
],
],
'ProcessingResources' => [
'ClusterConfig' => [
'InstanceCount' => ,
'InstancePreferences' => [
[
'InstanceCount' => ,
'InstanceType' => 'ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p5.4xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
],
// ...
],
'InstanceType' => 'ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p5.4xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'SelectedInstanceCount' => ,
'SelectedInstanceType' => 'ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p5.4xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'VolumeKmsKeyId' => '',
'VolumeSizeInGB' => ,
],
],
'ProcessingStartTime' => ,
'RoleArn' => '',
'StoppingCondition' => [
'MaxRuntimeInSeconds' => ,
],
'TrainingJobArn' => '',
]
Result Details
Members
- AppSpecification
-
- Required: Yes
- Type: AppSpecification structure
Configures the processing job to run a specified container image.
- AutoMLJobArn
-
- Type: string
The ARN of an AutoML job associated with this processing job.
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the processing job was created.
- Environment
-
- Type: Associative array of custom strings keys (ProcessingEnvironmentKey) to strings
The environment variables set in the Docker container.
- ExitMessage
-
- Type: string
An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.
- ExperimentConfig
-
- Type: ExperimentConfig structure
The configuration information used to create an experiment.
- FailureReason
-
- Type: string
A string, up to one KB in size, that contains the reason a processing job failed, if it failed.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the processing job was last modified.
- MonitoringScheduleArn
-
- Type: string
The ARN of a monitoring schedule for an endpoint associated with this processing job.
- NetworkConfig
-
- Type: NetworkConfig structure
Networking options for a processing job.
- ProcessingEndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the processing job completed.
- ProcessingInputs
-
- Type: Array of ProcessingInput structures
The inputs for a processing job.
- ProcessingJobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the processing job.
- ProcessingJobName
-
- Required: Yes
- Type: string
The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
- ProcessingJobStatus
-
- Required: Yes
- Type: string
Provides the status of a processing job.
- ProcessingOutputConfig
-
- Type: ProcessingOutputConfig structure
Output configuration for the processing job.
- ProcessingResources
-
- Required: Yes
- Type: ProcessingResources structure
Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.
- ProcessingStartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the processing job started.
- RoleArn
-
- Type: string
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
- StoppingCondition
-
- Type: ProcessingStoppingCondition structure
The time limit for how long the processing job is allowed to run.
- TrainingJobArn
-
- Type: string
The ARN of a training job associated with this processing job.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeProject
$result = $client->describeProject([/* ... */]); $promise = $client->describeProjectAsync([/* ... */]);
Describes the details of a project.
Parameter Syntax
$result = $client->describeProject([
'ProjectName' => '', // REQUIRED
]);
Parameter Details
Members
- ProjectName
-
- Required: Yes
- Type: string
The name of the project to describe.
Result Syntax
[
'CreatedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'CreationTime' => ,
'LastModifiedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'LastModifiedTime' => ,
'ProjectArn' => '',
'ProjectDescription' => '',
'ProjectId' => '',
'ProjectName' => '',
'ProjectStatus' => 'Pending|CreateInProgress|CreateCompleted|CreateFailed|DeleteInProgress|DeleteFailed|DeleteCompleted|UpdateInProgress|UpdateCompleted|UpdateFailed',
'ServiceCatalogProvisionedProductDetails' => [
'ProvisionedProductId' => '',
'ProvisionedProductStatusMessage' => '',
],
'ServiceCatalogProvisioningDetails' => [
'PathId' => '',
'ProductId' => '',
'ProvisioningArtifactId' => '',
'ProvisioningParameters' => [
[
'Key' => '',
'Value' => '',
],
// ...
],
],
'TemplateProviderDetails' => [
[
'CfnTemplateProviderDetail' => [
'Parameters' => [
[
'Key' => '',
'Value' => '',
],
// ...
],
'RoleARN' => '',
'StackDetail' => [
'Id' => '',
'Name' => '',
'StatusMessage' => '',
],
'TemplateName' => '',
'TemplateURL' => '',
],
],
// ...
],
]
Result Details
Members
- CreatedBy
-
- Type: UserContext structure
Information about the user who created or modified a SageMaker resource.
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the project was created.
- LastModifiedBy
-
- Type: UserContext structure
Information about the user who created or modified a SageMaker resource.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when project was last modified.
- ProjectArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the project.
- ProjectDescription
-
- Type: string
The description of the project.
- ProjectId
-
- Required: Yes
- Type: string
The ID of the project.
- ProjectName
-
- Required: Yes
- Type: string
The name of the project.
- ProjectStatus
-
- Required: Yes
- Type: string
The status of the project.
- ServiceCatalogProvisionedProductDetails
-
- Type: ServiceCatalogProvisionedProductDetails structure
Information about a provisioned service catalog product.
- ServiceCatalogProvisioningDetails
-
- Type: ServiceCatalogProvisioningDetails structure
Information used to provision a service catalog product. For information, see What is Amazon Web Services Service Catalog.
- TemplateProviderDetails
-
- Type: Array of TemplateProviderDetail structures
An array of template providers associated with the project.
Errors
There are no errors described for this operation.
DescribeReservedCapacity
$result = $client->describeReservedCapacity([/* ... */]); $promise = $client->describeReservedCapacityAsync([/* ... */]);
Retrieves details about a reserved capacity.
Parameter Syntax
$result = $client->describeReservedCapacity([
'ReservedCapacityArn' => '', // REQUIRED
]);
Parameter Details
Members
- ReservedCapacityArn
-
- Required: Yes
- Type: string
ARN of the reserved capacity to describe.
Result Syntax
[
'AvailabilityZone' => '',
'AvailableInstanceCount' => ,
'DurationHours' => ,
'DurationMinutes' => ,
'EndTime' => ,
'InUseInstanceCount' => ,
'InstanceType' => 'ml.p4d.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.trn1.32xlarge|ml.trn2.48xlarge|ml.p6-b200.48xlarge|ml.p4de.24xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge',
'ReservedCapacityArn' => '',
'ReservedCapacityType' => 'UltraServer|Instance',
'StartTime' => ,
'Status' => 'Pending|Active|Scheduled|Expired|Failed',
'TotalInstanceCount' => ,
'UltraServerSummary' => [
'AvailableSpareInstanceCount' => ,
'InstanceType' => 'ml.p4d.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.trn1.32xlarge|ml.trn2.48xlarge|ml.p6-b200.48xlarge|ml.p4de.24xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge',
'UltraServerCount' => ,
'UltraServerType' => '',
'UnhealthyInstanceCount' => ,
],
]
Result Details
Members
- AvailabilityZone
-
- Type: string
The Availability Zone where the reserved capacity is provisioned.
- AvailableInstanceCount
-
- Type: int
The number of instances currently available for use in this reserved capacity.
- DurationHours
-
- Type: long (int|float)
The total duration of the reserved capacity in hours.
- DurationMinutes
-
- Type: long (int|float)
The number of minutes for the duration of the reserved capacity. For example, if a reserved capacity starts at 08:55 and ends at 11:30, the minutes field would be 35.
- EndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the reserved capacity expires.
- InUseInstanceCount
-
- Type: int
The number of instances currently in use from this reserved capacity.
- InstanceType
-
- Required: Yes
- Type: string
The Amazon EC2 instance type used in the reserved capacity.
- ReservedCapacityArn
-
- Required: Yes
- Type: string
ARN of the reserved capacity.
- ReservedCapacityType
-
- Type: string
The type of reserved capacity.
- StartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the reserved capacity becomes active.
- Status
-
- Type: string
The current status of the reserved capacity.
- TotalInstanceCount
-
- Required: Yes
- Type: int
The total number of instances allocated to this reserved capacity.
- UltraServerSummary
-
- Type: UltraServerSummary structure
A summary of the UltraServer associated with this reserved capacity.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeSpace
$result = $client->describeSpace([/* ... */]); $promise = $client->describeSpaceAsync([/* ... */]);
Describes the space.
Parameter Syntax
$result = $client->describeSpace([
'DomainId' => '', // REQUIRED
'SpaceName' => '', // REQUIRED
]);
Parameter Details
Members
- DomainId
-
- Required: Yes
- Type: string
The ID of the associated domain.
- SpaceName
-
- Required: Yes
- Type: string
The name of the space.
Result Syntax
[
'CreationTime' => ,
'DomainId' => '',
'FailureReason' => '',
'HomeEfsFileSystemUid' => '',
'LastModifiedTime' => ,
'OwnershipSettings' => [
'OwnerUserProfileName' => '',
],
'SpaceArn' => '',
'SpaceDisplayName' => '',
'SpaceName' => '',
'SpaceSettings' => [
'AppType' => 'JupyterServer|KernelGateway|DetailedProfiler|TensorBoard|CodeEditor|JupyterLab|RStudioServerPro|RSessionGateway|Canvas',
'CodeEditorAppSettings' => [
'AppLifecycleManagement' => [
'IdleSettings' => [
'IdleTimeoutInMinutes' => ,
],
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
],
'CustomFileSystems' => [
[
'EFSFileSystem' => [
'FileSystemId' => '',
],
'FSxLustreFileSystem' => [
'FileSystemId' => '',
],
'S3FileSystem' => [
'S3Uri' => '',
],
],
// ...
],
'JupyterLabAppSettings' => [
'AppLifecycleManagement' => [
'IdleSettings' => [
'IdleTimeoutInMinutes' => ,
],
],
'CodeRepositories' => [
[
'RepositoryUrl' => '',
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
],
'JupyterServerAppSettings' => [
'CodeRepositories' => [
[
'RepositoryUrl' => '',
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
'LifecycleConfigArns' => ['', ...],
],
'KernelGatewayAppSettings' => [
'CustomImages' => [
[
'AppImageConfigName' => '',
'ImageName' => '',
'ImageVersionNumber' => ,
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
'LifecycleConfigArns' => ['', ...],
],
'RemoteAccess' => 'ENABLED|DISABLED',
'SpaceManagedResources' => 'ENABLED|DISABLED',
'SpaceStorageSettings' => [
'EbsStorageSettings' => [
'EbsVolumeSizeInGb' => ,
],
],
],
'SpaceSharingSettings' => [
'SharingType' => 'Private|Shared',
],
'Status' => 'Deleting|Failed|InService|Pending|Updating|Update_Failed|Delete_Failed',
'Url' => '',
]
Result Details
Members
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation time.
- DomainId
-
- Type: string
The ID of the associated domain.
- FailureReason
-
- Type: string
The failure reason.
- HomeEfsFileSystemUid
-
- Type: string
The ID of the space's profile in the Amazon EFS volume.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last modified time.
- OwnershipSettings
-
- Type: OwnershipSettings structure
The collection of ownership settings for a space.
- SpaceArn
-
- Type: string
The space's Amazon Resource Name (ARN).
- SpaceDisplayName
-
- Type: string
The name of the space that appears in the Amazon SageMaker Studio UI.
- SpaceName
-
- Type: string
The name of the space.
- SpaceSettings
-
- Type: SpaceSettings structure
A collection of space settings.
- SpaceSharingSettings
-
- Type: SpaceSharingSettings structure
The collection of space sharing settings for a space.
- Status
-
- Type: string
The status.
- Url
-
- Type: string
Returns the URL of the space. If the space is created with Amazon Web Services IAM Identity Center (Successor to Amazon Web Services Single Sign-On) authentication, users can navigate to the URL after appending the respective redirect parameter for the application type to be federated through Amazon Web Services IAM Identity Center.
The following application types are supported:
-
Studio Classic:
&redirect=JupyterServer -
JupyterLab:
&redirect=JupyterLab -
Code Editor, based on Code-OSS, Visual Studio Code - Open Source:
&redirect=CodeEditor
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeStudioLifecycleConfig
$result = $client->describeStudioLifecycleConfig([/* ... */]); $promise = $client->describeStudioLifecycleConfigAsync([/* ... */]);
Describes the Amazon SageMaker AI Studio Lifecycle Configuration.
Parameter Syntax
$result = $client->describeStudioLifecycleConfig([
'StudioLifecycleConfigName' => '', // REQUIRED
]);
Parameter Details
Members
- StudioLifecycleConfigName
-
- Required: Yes
- Type: string
The name of the Amazon SageMaker AI Studio Lifecycle Configuration to describe.
Result Syntax
[
'CreationTime' => ,
'LastModifiedTime' => ,
'StudioLifecycleConfigAppType' => 'JupyterServer|KernelGateway|CodeEditor|JupyterLab',
'StudioLifecycleConfigArn' => '',
'StudioLifecycleConfigContent' => '',
'StudioLifecycleConfigName' => '',
]
Result Details
Members
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation time of the Amazon SageMaker AI Studio Lifecycle Configuration.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
This value is equivalent to CreationTime because Amazon SageMaker AI Studio Lifecycle Configurations are immutable.
- StudioLifecycleConfigAppType
-
- Type: string
The App type that the Lifecycle Configuration is attached to.
- StudioLifecycleConfigArn
-
- Type: string
The ARN of the Lifecycle Configuration to describe.
- StudioLifecycleConfigContent
-
- Type: string
The content of your Amazon SageMaker AI Studio Lifecycle Configuration script.
- StudioLifecycleConfigName
-
- Type: string
The name of the Amazon SageMaker AI Studio Lifecycle Configuration that is described.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeSubscribedWorkteam
$result = $client->describeSubscribedWorkteam([/* ... */]); $promise = $client->describeSubscribedWorkteamAsync([/* ... */]);
Gets information about a work team provided by a vendor. It returns details about the subscription with a vendor in the Amazon Web Services Marketplace.
Parameter Syntax
$result = $client->describeSubscribedWorkteam([
'WorkteamArn' => '', // REQUIRED
]);
Parameter Details
Members
- WorkteamArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the subscribed work team to describe.
Result Syntax
[
'SubscribedWorkteam' => [
'ListingId' => '',
'MarketplaceDescription' => '',
'MarketplaceTitle' => '',
'SellerName' => '',
'WorkteamArn' => '',
],
]
Result Details
Members
- SubscribedWorkteam
-
- Required: Yes
- Type: SubscribedWorkteam structure
A
Workteaminstance that contains information about the work team.
Errors
There are no errors described for this operation.
DescribeTrainingJob
$result = $client->describeTrainingJob([/* ... */]); $promise = $client->describeTrainingJobAsync([/* ... */]);
Returns information about a training job.
Some of the attributes below only appear if the training job successfully starts. If the training job fails, TrainingJobStatus is Failed and, depending on the FailureReason, attributes like TrainingStartTime, TrainingTimeInSeconds, TrainingEndTime, and BillableTimeInSeconds may not be present in the response.
Parameter Syntax
$result = $client->describeTrainingJob([
'TrainingJobName' => '', // REQUIRED
]);
Parameter Details
Members
- TrainingJobName
-
- Required: Yes
- Type: string
The name of the training job.
Result Syntax
[
'AlgorithmSpecification' => [
'AlgorithmName' => '',
'ContainerArguments' => ['', ...],
'ContainerEntrypoint' => ['', ...],
'EnableSageMakerMetricsTimeSeries' => true || false,
'MetricDefinitions' => [
[
'Name' => '',
'Regex' => '',
],
// ...
],
'TrainingImage' => '',
'TrainingImageConfig' => [
'TrainingRepositoryAccessMode' => 'Platform|Vpc',
'TrainingRepositoryAuthConfig' => [
'TrainingRepositoryCredentialsProviderArn' => '',
],
],
'TrainingInputMode' => 'Pipe|File|FastFile',
],
'AutoMLJobArn' => '',
'BillableTimeInSeconds' => ,
'BillableTokenCount' => ,
'CheckpointConfig' => [
'LocalPath' => '',
'S3Uri' => '',
],
'CreationTime' => ,
'DebugHookConfig' => [
'CollectionConfigurations' => [
[
'CollectionName' => '',
'CollectionParameters' => ['', ...],
],
// ...
],
'HookParameters' => ['', ...],
'LocalPath' => '',
'S3OutputPath' => '',
],
'DebugRuleConfigurations' => [
[
'InstanceType' => 'ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p5.4xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'LocalPath' => '',
'RuleConfigurationName' => '',
'RuleEvaluatorImage' => '',
'RuleParameters' => ['', ...],
'S3OutputPath' => '',
'VolumeSizeInGB' => ,
],
// ...
],
'DebugRuleEvaluationStatuses' => [
[
'LastModifiedTime' => ,
'RuleConfigurationName' => '',
'RuleEvaluationJobArn' => '',
'RuleEvaluationStatus' => 'InProgress|NoIssuesFound|IssuesFound|Error|Stopping|Stopped',
'StatusDetails' => '',
],
// ...
],
'EnableInterContainerTrafficEncryption' => true || false,
'EnableManagedSpotTraining' => true || false,
'EnableNetworkIsolation' => true || false,
'Environment' => ['', ...],
'ExperimentConfig' => [
'ExperimentName' => '',
'RunName' => '',
'TrialComponentDisplayName' => '',
'TrialName' => '',
],
'FailureReason' => '',
'FinalMetricDataList' => [
[
'MetricName' => '',
'Timestamp' => ,
'Value' => ,
],
// ...
],
'HyperParameters' => ['', ...],
'InfraCheckConfig' => [
'EnableInfraCheck' => true || false,
],
'InputDataConfig' => [
[
'ChannelName' => '',
'CompressionType' => 'None|Gzip',
'ContentType' => '',
'DataSource' => [
'DatasetSource' => [
'DatasetArn' => '',
],
'FileSystemDataSource' => [
'DirectoryPath' => '',
'FileSystemAccessMode' => 'rw|ro',
'FileSystemId' => '',
'FileSystemType' => 'EFS|FSxLustre',
],
'S3DataSource' => [
'AttributeNames' => ['', ...],
'HubAccessConfig' => [
'HubContentArn' => '',
],
'InstanceGroupNames' => ['', ...],
'ModelAccessConfig' => [
'AcceptEula' => true || false,
],
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile|Converse',
'S3Uri' => '',
],
],
'InputMode' => 'Pipe|File|FastFile',
'RecordWrapperType' => 'None|RecordIO',
'ShuffleConfig' => [
'Seed' => ,
],
],
// ...
],
'LabelingJobArn' => '',
'LastModifiedTime' => ,
'MlflowConfig' => [
'MlflowExperimentName' => '',
'MlflowResourceArn' => '',
'MlflowRunName' => '',
],
'MlflowDetails' => [
'MlflowExperimentId' => '',
'MlflowRunId' => '',
],
'ModelArtifacts' => [
'S3ModelArtifacts' => '',
],
'ModelPackageConfig' => [
'ModelPackageGroupArn' => '',
'SourceModelPackageArn' => '',
],
'OutputDataConfig' => [
'CompressionType' => 'GZIP|NONE',
'KmsKeyId' => '',
'S3OutputPath' => '',
],
'OutputModelPackageArn' => '',
'ProfilerConfig' => [
'DisableProfiler' => true || false,
'ProfilingIntervalInMilliseconds' => ,
'ProfilingParameters' => ['', ...],
'S3OutputPath' => '',
],
'ProfilerRuleConfigurations' => [
[
'InstanceType' => 'ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p5.4xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'LocalPath' => '',
'RuleConfigurationName' => '',
'RuleEvaluatorImage' => '',
'RuleParameters' => ['', ...],
'S3OutputPath' => '',
'VolumeSizeInGB' => ,
],
// ...
],
'ProfilerRuleEvaluationStatuses' => [
[
'LastModifiedTime' => ,
'RuleConfigurationName' => '',
'RuleEvaluationJobArn' => '',
'RuleEvaluationStatus' => 'InProgress|NoIssuesFound|IssuesFound|Error|Stopping|Stopped',
'StatusDetails' => '',
],
// ...
],
'ProfilingStatus' => 'Enabled|Disabled',
'ProgressInfo' => [
'CurrentEpoch' => ,
'CurrentStep' => ,
'MaxEpoch' => ,
'TotalStepCountPerEpoch' => ,
],
'RemoteDebugConfig' => [
'EnableRemoteDebug' => true || false,
],
'ResourceConfig' => [
'InstanceCount' => ,
'InstanceGroups' => [
[
'InstanceCount' => ,
'InstanceGroupName' => '',
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
],
// ...
],
'InstancePlacementConfig' => [
'EnableMultipleJobs' => true || false,
'PlacementSpecifications' => [
[
'InstanceCount' => ,
'UltraServerId' => '',
],
// ...
],
],
'InstancePreferences' => [
[
'InstanceCount' => ,
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'TrainingPlanArns' => ['', ...],
],
// ...
],
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'KeepAlivePeriodInSeconds' => ,
'SelectedInstanceCount' => ,
'SelectedInstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.p6-b200.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'TrainingPlanArn' => '',
'VolumeKmsKeyId' => '',
'VolumeSizeInGB' => ,
],
'RetryStrategy' => [
'MaximumRetryAttempts' => ,
],
'RoleArn' => '',
'SecondaryStatus' => 'Starting|LaunchingMLInstances|PreparingTrainingStack|Downloading|DownloadingTrainingImage|Training|Uploading|Stopping|Stopped|MaxRuntimeExceeded|Completed|Failed|Interrupted|MaxWaitTimeExceeded|Updating|Restarting|Pending',
'SecondaryStatusTransitions' => [
[
'EndTime' => ,
'StartTime' => ,
'Status' => 'Starting|LaunchingMLInstances|PreparingTrainingStack|Downloading|DownloadingTrainingImage|Training|Uploading|Stopping|Stopped|MaxRuntimeExceeded|Completed|Failed|Interrupted|MaxWaitTimeExceeded|Updating|Restarting|Pending',
'StatusMessage' => '',
],
// ...
],
'ServerlessJobConfig' => [
'AcceptEula' => true || false,
'BaseModelArn' => '',
'CustomizationTechnique' => 'SFT|DPO|RLVR|RLAIF',
'EvaluationType' => 'LLMAJEvaluation|CustomScorerEvaluation|BenchmarkEvaluation',
'EvaluatorArn' => '',
'JobType' => 'FineTuning|Evaluation',
'Peft' => 'LORA',
'SequenceLength' => '',
],
'StoppingCondition' => [
'MaxPendingTimeInSeconds' => ,
'MaxRuntimeInSeconds' => ,
'MaxWaitTimeInSeconds' => ,
],
'TensorBoardOutputConfig' => [
'LocalPath' => '',
'S3OutputPath' => '',
],
'TrainingEndTime' => ,
'TrainingJobArn' => '',
'TrainingJobName' => '',
'TrainingJobStatus' => 'InProgress|Completed|Failed|Stopping|Stopped|Deleting',
'TrainingStartTime' => ,
'TrainingTimeInSeconds' => ,
'TuningJobArn' => '',
'VpcConfig' => [
'SecurityGroupIds' => ['', ...],
'Subnets' => ['', ...],
],
'WarmPoolStatus' => [
'ResourceRetainedBillableTimeInSeconds' => ,
'ReusedByJob' => '',
'Status' => 'Available|Terminated|Reused|InUse',
],
]
Result Details
Members
- AlgorithmSpecification
-
- Type: AlgorithmSpecification structure
Information about the algorithm used for training, and algorithm metadata.
- AutoMLJobArn
-
- Type: string
The Amazon Resource Name (ARN) of an AutoML job.
- BillableTimeInSeconds
-
- Type: int
The billable time in seconds. Billable time refers to the absolute wall-clock time.
Multiply
BillableTimeInSecondsby the number of instances (InstanceCount) in your training cluster to get the total compute time SageMaker bills you if you run distributed training. The formula is as follows:BillableTimeInSeconds * InstanceCount.You can calculate the savings from using managed spot training using the formula
(1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example, ifBillableTimeInSecondsis 100 andTrainingTimeInSecondsis 500, the savings is 80%. - BillableTokenCount
-
- Type: long (int|float)
The billable token count for eligible serverless training jobs.
- CheckpointConfig
-
- Type: CheckpointConfig structure
Contains information about the output location for managed spot training checkpoint data.
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that indicates when the training job was created.
- DebugHookConfig
-
- Type: DebugHookConfig structure
Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and storage paths. To learn more about how to configure the
DebugHookConfigparameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job. - DebugRuleConfigurations
-
- Type: Array of DebugRuleConfiguration structures
Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.
- DebugRuleEvaluationStatuses
-
- Type: Array of DebugRuleEvaluationStatus structures
Evaluation status of Amazon SageMaker Debugger rules for debugging on a training job.
- EnableInterContainerTrafficEncryption
-
- Type: boolean
To encrypt all communications between ML compute instances in distributed training, choose
True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithms in distributed training. - EnableManagedSpotTraining
-
- Type: boolean
A Boolean indicating whether managed spot training is enabled (
True) or not (False). - EnableNetworkIsolation
-
- Type: boolean
If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster for distributed training, choose
True. If you enable network isolation for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access. - Environment
-
- Type: Associative array of custom strings keys (TrainingEnvironmentKey) to strings
The environment variables to set in the Docker container.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields.
- ExperimentConfig
-
- Type: ExperimentConfig structure
Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:
- FailureReason
-
- Type: string
If the training job failed, the reason it failed.
- FinalMetricDataList
-
- Type: Array of MetricData structures
A collection of
MetricDataobjects that specify the names, values, and dates and times that the training algorithm emitted to Amazon CloudWatch. - HyperParameters
-
- Type: Associative array of custom strings keys (HyperParameterKey) to strings
Algorithm-specific parameters.
- InfraCheckConfig
-
- Type: InfraCheckConfig structure
Contains information about the infrastructure health check configuration for the training job.
- InputDataConfig
-
- Type: Array of Channel structures
An array of
Channelobjects that describes each data input channel. - LabelingJobArn
-
- Type: string
The Amazon Resource Name (ARN) of the SageMaker Ground Truth labeling job that created the transform or training job.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that indicates when the status of the training job was last modified.
- MlflowConfig
-
- Type: MlflowConfig structure
The MLflow configuration using SageMaker managed MLflow.
- MlflowDetails
-
- Type: MlflowDetails structure
The MLflow details of this job.
- ModelArtifacts
-
- Required: Yes
- Type: ModelArtifacts structure
Information about the Amazon S3 location that is configured for storing model artifacts.
- ModelPackageConfig
-
- Type: ModelPackageConfig structure
The configuration for the model package.
- OutputDataConfig
-
- Type: OutputDataConfig structure
The S3 path where model artifacts that you configured when creating the job are stored. SageMaker creates subfolders for model artifacts.
- OutputModelPackageArn
-
- Type: string
The Amazon Resource Name (ARN) of the output model package containing model weights or checkpoints.
- ProfilerConfig
-
- Type: ProfilerConfig structure
Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.
- ProfilerRuleConfigurations
-
- Type: Array of ProfilerRuleConfiguration structures
Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.
- ProfilerRuleEvaluationStatuses
-
- Type: Array of ProfilerRuleEvaluationStatus structures
Evaluation status of Amazon SageMaker Debugger rules for profiling on a training job.
- ProfilingStatus
-
- Type: string
Profiling status of a training job.
- ProgressInfo
-
- Type: TrainingProgressInfo structure
The Serverless training job progress information.
- RemoteDebugConfig
-
- Type: RemoteDebugConfig structure
Configuration for remote debugging. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.
- ResourceConfig
-
- Type: ResourceConfig structure
Resources, including ML compute instances and ML storage volumes, that are configured for model training.
- RetryStrategy
-
- Type: RetryStrategy structure
The number of times to retry the job when the job fails due to an
InternalServerError. - RoleArn
-
- Type: string
The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.
- SecondaryStatus
-
- Required: Yes
- Type: string
Provides detailed information about the state of the training job. For detailed information on the secondary status of the training job, see
StatusMessageunder SecondaryStatusTransition.SageMaker provides primary statuses and secondary statuses that apply to each of them:
- InProgress
-
-
Starting- Starting the training job. -
Pending- The training job is waiting for compute capacity or compute resource provision. -
Downloading- An optional stage for algorithms that supportFiletraining input mode. It indicates that data is being downloaded to the ML storage volumes. -
Training- Training is in progress. -
Interrupted- The job stopped because the managed spot training instances were interrupted. -
Uploading- Training is complete and the model artifacts are being uploaded to the S3 location.
-
- Completed
-
-
Completed- The training job has completed.
-
- Failed
-
-
Failed- The training job has failed. The reason for the failure is returned in theFailureReasonfield ofDescribeTrainingJobResponse.
-
- Stopped
-
-
MaxRuntimeExceeded- The job stopped because it exceeded the maximum allowed runtime. -
MaxWaitTimeExceeded- The job stopped because it exceeded the maximum allowed wait time. -
Stopped- The training job has stopped.
-
- Stopping
-
-
Stopping- Stopping the training job.
-
Valid values for
SecondaryStatusare subject to change.We no longer support the following secondary statuses:
-
LaunchingMLInstances -
PreparingTraining -
DownloadingTrainingImage
- SecondaryStatusTransitions
-
- Type: Array of SecondaryStatusTransition structures
A history of all of the secondary statuses that the training job has transitioned through.
- ServerlessJobConfig
-
- Type: ServerlessJobConfig structure
The configuration for serverless training jobs.
- StoppingCondition
-
- Required: Yes
- Type: StoppingCondition structure
Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.
To stop a job, SageMaker sends the algorithm the
SIGTERMsignal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost. - TensorBoardOutputConfig
-
- Type: TensorBoardOutputConfig structure
Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.
- TrainingEndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of
TrainingStartTimeand this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure. - TrainingJobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the training job.
- TrainingJobName
-
- Required: Yes
- Type: string
Name of the model training job.
- TrainingJobStatus
-
- Required: Yes
- Type: string
The status of the training job.
SageMaker provides the following training job statuses:
-
InProgress- The training is in progress. -
Completed- The training job has completed. -
Failed- The training job has failed. To see the reason for the failure, see theFailureReasonfield in the response to aDescribeTrainingJobResponsecall. -
Stopping- The training job is stopping. -
Stopped- The training job has stopped.
For more detailed information, see
SecondaryStatus. - TrainingStartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of
TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container. - TrainingTimeInSeconds
-
- Type: int
The training time in seconds.
- TuningJobArn
-
- Type: string
The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.
- VpcConfig
-
- Type: VpcConfig structure
A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.
- WarmPoolStatus
-
- Type: WarmPoolStatus structure
The status of the warm pool associated with the training job.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeTrainingPlan
$result = $client->describeTrainingPlan([/* ... */]); $promise = $client->describeTrainingPlanAsync([/* ... */]);
Retrieves detailed information about a specific training plan.
Parameter Syntax
$result = $client->describeTrainingPlan([
'TrainingPlanName' => '', // REQUIRED
]);
Parameter Details
Members
- TrainingPlanName
-
- Required: Yes
- Type: string
The name of the training plan to describe.
Result Syntax
[
'AvailableInstanceCount' => ,
'AvailableSpareInstanceCount' => ,
'CurrencyCode' => '',
'DurationHours' => ,
'DurationMinutes' => ,
'EndTime' => ,
'InUseInstanceCount' => ,
'ReservedCapacitySummaries' => [
[
'AvailabilityZone' => '',
'AvailabilityZoneId' => '',
'DurationHours' => ,
'DurationMinutes' => ,
'EndTime' => ,
'InstanceType' => 'ml.p4d.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.trn1.32xlarge|ml.trn2.48xlarge|ml.p6-b200.48xlarge|ml.p4de.24xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge',
'ReservedCapacityArn' => '',
'ReservedCapacityType' => 'UltraServer|Instance',
'StartTime' => ,
'Status' => 'Pending|Active|Scheduled|Expired|Failed',
'TotalInstanceCount' => ,
'UltraServerCount' => ,
'UltraServerType' => '',
],
// ...
],
'StartTime' => ,
'Status' => 'Pending|Active|Scheduled|Expired|Failed',
'StatusMessage' => '',
'TargetResources' => ['', ...],
'TotalInstanceCount' => ,
'TotalUltraServerCount' => ,
'TrainingPlanArn' => '',
'TrainingPlanName' => '',
'UnhealthyInstanceCount' => ,
'UpfrontFee' => '',
]
Result Details
Members
- AvailableInstanceCount
-
- Type: int
The number of instances currently available for use in this training plan.
- AvailableSpareInstanceCount
-
- Type: int
The number of available spare instances in the training plan.
- CurrencyCode
-
- Type: string
The currency code for the upfront fee (e.g., USD).
- DurationHours
-
- Type: long (int|float)
The number of whole hours in the total duration for this training plan.
- DurationMinutes
-
- Type: long (int|float)
The additional minutes beyond whole hours in the total duration for this training plan.
- EndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The end time of the training plan.
- InUseInstanceCount
-
- Type: int
The number of instances currently in use from this training plan.
- ReservedCapacitySummaries
-
- Type: Array of ReservedCapacitySummary structures
The list of Reserved Capacity providing the underlying compute resources of the plan.
- StartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start time of the training plan.
- Status
-
- Required: Yes
- Type: string
The current status of the training plan (e.g., Pending, Active, Expired). To see the complete list of status values available for a training plan, refer to the
Statusattribute within theTrainingPlanSummaryobject. - StatusMessage
-
- Type: string
A message providing additional information about the current status of the training plan.
- TargetResources
-
- Type: Array of strings
The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod, SageMaker Endpoints, Studio apps) that can use this training plan.
Training plans are specific to their target resource.
-
A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.
-
A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.
-
A training plan for SageMaker endpoints can be used exclusively to provide compute resources to SageMaker endpoints for model deployment.
-
A training plan for Studio apps can be used to launch JupyterLab and Code Editor apps on reserved training plan capacity.
- TotalInstanceCount
-
- Type: int
The total number of instances reserved in this training plan.
- TotalUltraServerCount
-
- Type: int
The total number of UltraServers reserved to this training plan.
- TrainingPlanArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN); of the training plan.
- TrainingPlanName
-
- Required: Yes
- Type: string
The name of the training plan.
- UnhealthyInstanceCount
-
- Type: int
The number of instances in the training plan that are currently in an unhealthy state.
- UpfrontFee
-
- Type: string
The upfront fee for the training plan.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeTrainingPlanExtensionHistory
$result = $client->describeTrainingPlanExtensionHistory([/* ... */]); $promise = $client->describeTrainingPlanExtensionHistoryAsync([/* ... */]);
Retrieves the extension history for a specified training plan. The response includes details about each extension, such as the offering ID, start and end dates, status, payment status, and cost information.
Parameter Syntax
$result = $client->describeTrainingPlanExtensionHistory([
'MaxResults' => ,
'NextToken' => '',
'TrainingPlanArn' => '', // REQUIRED
]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of extensions to return in the response.
- NextToken
-
- Type: string
A token to continue pagination if more results are available.
- TrainingPlanArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN); of the training plan to retrieve extension history for.
Result Syntax
[
'NextToken' => '',
'TrainingPlanExtensions' => [
[
'AvailabilityZone' => '',
'AvailabilityZoneId' => '',
'CurrencyCode' => '',
'DurationHours' => ,
'EndDate' => ,
'ExtendedAt' => ,
'PaymentStatus' => '',
'StartDate' => ,
'Status' => '',
'TrainingPlanExtensionOfferingId' => '',
'UpfrontFee' => '',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
A token to continue pagination if more results are available.
- TrainingPlanExtensions
-
- Required: Yes
- Type: Array of TrainingPlanExtension structures
A list of extensions for the specified training plan.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeTransformJob
$result = $client->describeTransformJob([/* ... */]); $promise = $client->describeTransformJobAsync([/* ... */]);
Returns information about a transform job.
Parameter Syntax
$result = $client->describeTransformJob([
'TransformJobName' => '', // REQUIRED
]);
Parameter Details
Members
- TransformJobName
-
- Required: Yes
- Type: string
The name of the transform job that you want to view details of.
Result Syntax
[
'AutoMLJobArn' => '',
'BatchStrategy' => 'MultiRecord|SingleRecord',
'CreationTime' => ,
'DataCaptureConfig' => [
'DestinationS3Uri' => '',
'GenerateInferenceId' => true || false,
'KmsKeyId' => '',
],
'DataProcessing' => [
'InputFilter' => '',
'JoinSource' => 'Input|None',
'OutputFilter' => '',
],
'Environment' => ['', ...],
'ExperimentConfig' => [
'ExperimentName' => '',
'RunName' => '',
'TrialComponentDisplayName' => '',
'TrialName' => '',
],
'FailureReason' => '',
'LabelingJobArn' => '',
'MaxConcurrentTransforms' => ,
'MaxPayloadInMB' => ,
'ModelClientConfig' => [
'InvocationsMaxRetries' => ,
'InvocationsTimeoutInSeconds' => ,
],
'ModelName' => '',
'TransformEndTime' => ,
'TransformInput' => [
'CompressionType' => 'None|Gzip',
'ContentType' => '',
'DataSource' => [
'S3DataSource' => [
'S3DataType' => 'ManifestFile|S3Prefix|AugmentedManifestFile|Converse',
'S3Uri' => '',
],
],
'SplitType' => 'None|Line|RecordIO|TFRecord',
],
'TransformJobArn' => '',
'TransformJobName' => '',
'TransformJobStatus' => 'InProgress|Completed|Failed|Stopping|Stopped',
'TransformOutput' => [
'Accept' => '',
'AssembleWith' => 'None|Line',
'KmsKeyId' => '',
'S3OutputPath' => '',
],
'TransformResources' => [
'InstanceCount' => ,
'InstanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge',
'TransformAmiVersion' => '',
'VolumeKmsKeyId' => '',
],
'TransformStartTime' => ,
]
Result Details
Members
- AutoMLJobArn
-
- Type: string
The Amazon Resource Name (ARN) of the AutoML transform job.
- BatchStrategy
-
- Type: string
Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.
To enable the batch strategy, you must set
SplitTypetoLine,RecordIO, orTFRecord. - CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp that shows when the transform Job was created.
- DataCaptureConfig
-
- Type: BatchDataCaptureConfig structure
Configuration to control how SageMaker captures inference data.
- DataProcessing
-
- Type: DataProcessing structure
The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.
- Environment
-
- Type: Associative array of custom strings keys (TransformEnvironmentKey) to strings
The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.
- ExperimentConfig
-
- Type: ExperimentConfig structure
Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:
- FailureReason
-
- Type: string
If the transform job failed,
FailureReasondescribes why it failed. A transform job creates a log file, which includes error messages, and stores it as an Amazon S3 object. For more information, see Log Amazon SageMaker Events with Amazon CloudWatch. - LabelingJobArn
-
- Type: string
The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.
- MaxConcurrentTransforms
-
- Type: int
The maximum number of parallel requests on each instance node that can be launched in a transform job. The default value is 1.
- MaxPayloadInMB
-
- Type: int
The maximum payload size, in MB, used in the transform job.
- ModelClientConfig
-
- Type: ModelClientConfig structure
The timeout and maximum number of retries for processing a transform job invocation.
- ModelName
-
- Required: Yes
- Type: string
The name of the model used in the transform job.
- TransformEndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of
TransformStartTime. - TransformInput
-
- Required: Yes
- Type: TransformInput structure
Describes the dataset to be transformed and the Amazon S3 location where it is stored.
- TransformJobArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the transform job.
- TransformJobName
-
- Required: Yes
- Type: string
The name of the transform job.
- TransformJobStatus
-
- Required: Yes
- Type: string
The status of the transform job. If the transform job failed, the reason is returned in the
FailureReasonfield. - TransformOutput
-
- Type: TransformOutput structure
Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
- TransformResources
-
- Required: Yes
- Type: TransformResources structure
Describes the resources, including ML instance types and ML instance count, to use for the transform job.
- TransformStartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of
TransformEndTime.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeTrial
$result = $client->describeTrial([/* ... */]); $promise = $client->describeTrialAsync([/* ... */]);
Provides a list of a trial's properties.
Parameter Syntax
$result = $client->describeTrial([
'TrialName' => '', // REQUIRED
]);
Parameter Details
Members
- TrialName
-
- Required: Yes
- Type: string
The name of the trial to describe.
Result Syntax
[
'CreatedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'CreationTime' => ,
'DisplayName' => '',
'ExperimentName' => '',
'LastModifiedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'LastModifiedTime' => ,
'MetadataProperties' => [
'CommitId' => '',
'GeneratedBy' => '',
'ProjectId' => '',
'Repository' => '',
],
'Source' => [
'SourceArn' => '',
'SourceType' => '',
],
'TrialArn' => '',
'TrialName' => '',
]
Result Details
Members
- CreatedBy
-
- Type: UserContext structure
Who created the trial.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the trial was created.
- DisplayName
-
- Type: string
The name of the trial as displayed. If
DisplayNameisn't specified,TrialNameis displayed. - ExperimentName
-
- Type: string
The name of the experiment the trial is part of.
- LastModifiedBy
-
- Type: UserContext structure
Who last modified the trial.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the trial was last modified.
- MetadataProperties
-
- Type: MetadataProperties structure
Metadata properties of the tracking entity, trial, or trial component.
- Source
-
- Type: TrialSource structure
The Amazon Resource Name (ARN) of the source and, optionally, the job type.
- TrialArn
-
- Type: string
The Amazon Resource Name (ARN) of the trial.
- TrialName
-
- Type: string
The name of the trial.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeTrialComponent
$result = $client->describeTrialComponent([/* ... */]); $promise = $client->describeTrialComponentAsync([/* ... */]);
Provides a list of a trials component's properties.
Parameter Syntax
$result = $client->describeTrialComponent([
'TrialComponentName' => '', // REQUIRED
]);
Parameter Details
Members
- TrialComponentName
-
- Required: Yes
- Type: string
The name of the trial component to describe.
Result Syntax
[
'CreatedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'CreationTime' => ,
'DisplayName' => '',
'EndTime' => ,
'InputArtifacts' => [
'' => [
'MediaType' => '',
'Value' => '',
],
// ...
],
'LastModifiedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'LastModifiedTime' => ,
'LineageGroupArn' => '',
'MetadataProperties' => [
'CommitId' => '',
'GeneratedBy' => '',
'ProjectId' => '',
'Repository' => '',
],
'Metrics' => [
[
'Avg' => ,
'Count' => ,
'Last' => ,
'Max' => ,
'MetricName' => '',
'Min' => ,
'SourceArn' => '',
'StdDev' => ,
'TimeStamp' => ,
],
// ...
],
'OutputArtifacts' => [
'' => [
'MediaType' => '',
'Value' => '',
],
// ...
],
'Parameters' => [
'' => [
'NumberValue' => ,
'StringValue' => '',
],
// ...
],
'Source' => [
'SourceArn' => '',
'SourceType' => '',
],
'Sources' => [
[
'SourceArn' => '',
'SourceType' => '',
],
// ...
],
'StartTime' => ,
'Status' => [
'Message' => '',
'PrimaryStatus' => 'InProgress|Completed|Failed|Stopping|Stopped',
],
'TrialComponentArn' => '',
'TrialComponentName' => '',
]
Result Details
Members
- CreatedBy
-
- Type: UserContext structure
Who created the trial component.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the component was created.
- DisplayName
-
- Type: string
The name of the component as displayed. If
DisplayNameisn't specified,TrialComponentNameis displayed. - EndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the component ended.
- InputArtifacts
-
- Type: Associative array of custom strings keys (TrialComponentKey128) to TrialComponentArtifact structures
The input artifacts of the component.
- LastModifiedBy
-
- Type: UserContext structure
Who last modified the component.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the component was last modified.
- LineageGroupArn
-
- Type: string
The Amazon Resource Name (ARN) of the lineage group.
- MetadataProperties
-
- Type: MetadataProperties structure
Metadata properties of the tracking entity, trial, or trial component.
- Metrics
-
- Type: Array of TrialComponentMetricSummary structures
The metrics for the component.
- OutputArtifacts
-
- Type: Associative array of custom strings keys (TrialComponentKey128) to TrialComponentArtifact structures
The output artifacts of the component.
- Parameters
-
- Type: Associative array of custom strings keys (TrialComponentKey320) to TrialComponentParameterValue structures
The hyperparameters of the component.
- Source
-
- Type: TrialComponentSource structure
The Amazon Resource Name (ARN) of the source and, optionally, the job type.
- Sources
-
- Type: Array of TrialComponentSource structures
A list of ARNs and, if applicable, job types for multiple sources of an experiment run.
- StartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the component started.
- Status
-
- Type: TrialComponentStatus structure
The status of the component. States include:
-
InProgress
-
Completed
-
Failed
- TrialComponentArn
-
- Type: string
The Amazon Resource Name (ARN) of the trial component.
- TrialComponentName
-
- Type: string
The name of the trial component.
Errors
- ResourceNotFound:
Resource being access is not found.
DescribeUserProfile
$result = $client->describeUserProfile([/* ... */]); $promise = $client->describeUserProfileAsync([/* ... */]);
Describes a user profile. For more information, see CreateUserProfile.
Parameter Syntax
$result = $client->describeUserProfile([
'DomainId' => '', // REQUIRED
'UserProfileName' => '', // REQUIRED
]);
Parameter Details
Members
- DomainId
-
- Required: Yes
- Type: string
The domain ID.
- UserProfileName
-
- Required: Yes
- Type: string
The user profile name. This value is not case sensitive.
Result Syntax
[
'CreationTime' => ,
'DomainId' => '',
'FailureReason' => '',
'HomeEfsFileSystemUid' => '',
'LastModifiedTime' => ,
'SingleSignOnUserIdentifier' => '',
'SingleSignOnUserValue' => '',
'Status' => 'Deleting|Failed|InService|Pending|Updating|Update_Failed|Delete_Failed',
'UserProfileArn' => '',
'UserProfileName' => '',
'UserSettings' => [
'AutoMountHomeEFS' => 'Enabled|Disabled|DefaultAsDomain',
'CanvasAppSettings' => [
'DirectDeploySettings' => [
'Status' => 'ENABLED|DISABLED',
],
'EmrServerlessSettings' => [
'ExecutionRoleArn' => '',
'Status' => 'ENABLED|DISABLED',
],
'GenerativeAiSettings' => [
'AmazonBedrockRoleArn' => '',
],
'IdentityProviderOAuthSettings' => [
[
'DataSourceName' => 'SalesforceGenie|Snowflake',
'SecretArn' => '',
'Status' => 'ENABLED|DISABLED',
],
// ...
],
'KendraSettings' => [
'Status' => 'ENABLED|DISABLED',
],
'ModelRegisterSettings' => [
'CrossAccountModelRegisterRoleArn' => '',
'Status' => 'ENABLED|DISABLED',
],
'TimeSeriesForecastingSettings' => [
'AmazonForecastRoleArn' => '',
'Status' => 'ENABLED|DISABLED',
],
'WorkspaceSettings' => [
'S3ArtifactPath' => '',
'S3KmsKeyId' => '',
],
],
'CodeEditorAppSettings' => [
'AppLifecycleManagement' => [
'IdleSettings' => [
'IdleTimeoutInMinutes' => ,
'LifecycleManagement' => 'ENABLED|DISABLED',
'MaxIdleTimeoutInMinutes' => ,
'MinIdleTimeoutInMinutes' => ,
],
],
'BuiltInLifecycleConfigArn' => '',
'CustomImages' => [
[
'AppImageConfigName' => '',
'ImageName' => '',
'ImageVersionNumber' => ,
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
'LifecycleConfigArns' => ['', ...],
],
'CustomFileSystemConfigs' => [
[
'EFSFileSystemConfig' => [
'FileSystemId' => '',
'FileSystemPath' => '',
],
'FSxLustreFileSystemConfig' => [
'FileSystemId' => '',
'FileSystemPath' => '',
],
'S3FileSystemConfig' => [
'MountPath' => '',
'S3Uri' => '',
],
],
// ...
],
'CustomPosixUserConfig' => [
'Gid' => ,
'Uid' => ,
],
'DefaultLandingUri' => '',
'ExecutionRole' => '',
'JupyterLabAppSettings' => [
'AppLifecycleManagement' => [
'IdleSettings' => [
'IdleTimeoutInMinutes' => ,
'LifecycleManagement' => 'ENABLED|DISABLED',
'MaxIdleTimeoutInMinutes' => ,
'MinIdleTimeoutInMinutes' => ,
],
],
'BuiltInLifecycleConfigArn' => '',
'CodeRepositories' => [
[
'RepositoryUrl' => '',
],
// ...
],
'CustomImages' => [
[
'AppImageConfigName' => '',
'ImageName' => '',
'ImageVersionNumber' => ,
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
'EmrSettings' => [
'AssumableRoleArns' => ['', ...],
'ExecutionRoleArns' => ['', ...],
],
'LifecycleConfigArns' => ['', ...],
],
'JupyterServerAppSettings' => [
'CodeRepositories' => [
[
'RepositoryUrl' => '',
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
'LifecycleConfigArns' => ['', ...],
],
'KernelGatewayAppSettings' => [
'CustomImages' => [
[
'AppImageConfigName' => '',
'ImageName' => '',
'ImageVersionNumber' => ,
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
'LifecycleConfigArns' => ['', ...],
],
'RSessionAppSettings' => [
'CustomImages' => [
[
'AppImageConfigName' => '',
'ImageName' => '',
'ImageVersionNumber' => ,
],
// ...
],
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
],
'RStudioServerProAppSettings' => [
'AccessStatus' => 'ENABLED|DISABLED',
'UserGroup' => 'R_STUDIO_ADMIN|R_STUDIO_USER',
],
'SecurityGroups' => ['', ...],
'SharingSettings' => [
'NotebookOutputOption' => 'Allowed|Disabled',
'S3KmsKeyId' => '',
'S3OutputPath' => '',
],
'SpaceStorageSettings' => [
'DefaultEbsStorageSettings' => [
'DefaultEbsVolumeSizeInGb' => ,
'MaximumEbsVolumeSizeInGb' => ,
],
],
'StudioWebPortal' => 'ENABLED|DISABLED',
'StudioWebPortalSettings' => [
'ExecutionRoleSessionNameMode' => 'STATIC|USER_IDENTITY',
'HiddenAppTypes' => ['', ...],
'HiddenInstanceTypes' => ['', ...],
'HiddenMlTools' => ['', ...],
'HiddenSageMakerImageVersionAliases' => [
[
'SageMakerImageName' => 'sagemaker_distribution',
'VersionAliases' => ['', ...],
],
// ...
],
],
'TensorBoardAppSettings' => [
'DefaultResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
],
],
]
Result Details
Members
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation time.
- DomainId
-
- Type: string
The ID of the domain that contains the profile.
- FailureReason
-
- Type: string
The failure reason.
- HomeEfsFileSystemUid
-
- Type: string
The ID of the user's profile in the Amazon Elastic File System volume.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last modified time.
- SingleSignOnUserIdentifier
-
- Type: string
The IAM Identity Center user identifier.
- SingleSignOnUserValue
-
- Type: string
The IAM Identity Center user value.
- Status
-
- Type: string
The status.
- UserProfileArn
-
- Type: string
The user profile Amazon Resource Name (ARN).
- UserProfileName
-
- Type: string
The user profile name.
- UserSettings
-
- Type: UserSettings structure
A collection of settings.
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.
DescribeWorkforce
$result = $client->describeWorkforce([/* ... */]); $promise = $client->describeWorkforceAsync([/* ... */]);
Lists private workforce information, including workforce name, Amazon Resource Name (ARN), and, if applicable, allowed IP address ranges (CIDRs). Allowable IP address ranges are the IP addresses that workers can use to access tasks.
This operation applies only to private workforces.
Parameter Syntax
$result = $client->describeWorkforce([
'WorkforceName' => '', // REQUIRED
]);
Parameter Details
Members
- WorkforceName
-
- Required: Yes
- Type: string
The name of the private workforce whose access you want to restrict.
WorkforceNameis automatically set todefaultwhen a workforce is created and cannot be modified.
Result Syntax
[
'Workforce' => [
'CognitoConfig' => [
'ClientId' => '',
'UserPool' => '',
],
'CreateDate' => ,
'FailureReason' => '',
'IpAddressType' => 'ipv4|dualstack',
'LastUpdatedDate' => ,
'OidcConfig' => [
'AuthenticationRequestExtraParams' => ['', ...],
'AuthorizationEndpoint' => '',
'ClientId' => '',
'Issuer' => '',
'JwksUri' => '',
'LogoutEndpoint' => '',
'Scope' => '',
'TokenEndpoint' => '',
'UserInfoEndpoint' => '',
],
'SourceIpConfig' => [
'Cidrs' => ['', ...],
],
'Status' => 'Initializing|Updating|Deleting|Failed|Active',
'SubDomain' => '',
'WorkforceArn' => '',
'WorkforceName' => '',
'WorkforceVpcConfig' => [
'SecurityGroupIds' => ['', ...],
'Subnets' => ['', ...],
'VpcEndpointId' => '',
'VpcId' => '',
],
],
]
Result Details
Members
- Workforce
-
- Required: Yes
- Type: Workforce structure
A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.
Errors
There are no errors described for this operation.
DescribeWorkteam
$result = $client->describeWorkteam([/* ... */]); $promise = $client->describeWorkteamAsync([/* ... */]);
Gets information about a specific work team. You can see information such as the creation date, the last updated date, membership information, and the work team's Amazon Resource Name (ARN).
Parameter Syntax
$result = $client->describeWorkteam([
'WorkteamName' => '', // REQUIRED
]);
Parameter Details
Members
- WorkteamName
-
- Required: Yes
- Type: string
The name of the work team to return a description of.
Result Syntax
[
'Workteam' => [
'CreateDate' => ,
'Description' => '',
'LastUpdatedDate' => ,
'MemberDefinitions' => [
[
'CognitoMemberDefinition' => [
'ClientId' => '',
'UserGroup' => '',
'UserPool' => '',
],
'OidcMemberDefinition' => [
'Groups' => ['', ...],
],
],
// ...
],
'NotificationConfiguration' => [
'NotificationTopicArn' => '',
],
'ProductListingIds' => ['', ...],
'SubDomain' => '',
'WorkerAccessConfiguration' => [
'S3Presign' => [
'IamPolicyConstraints' => [
'SourceIp' => 'Enabled|Disabled',
'VpcSourceIp' => 'Enabled|Disabled',
],
],
],
'WorkforceArn' => '',
'WorkteamArn' => '',
'WorkteamName' => '',
],
]
Result Details
Members
- Workteam
-
- Required: Yes
- Type: Workteam structure
A
Workteaminstance that contains information about the work team.
Errors
There are no errors described for this operation.
DetachClusterNodeVolume
$result = $client->detachClusterNodeVolume([/* ... */]); $promise = $client->detachClusterNodeVolumeAsync([/* ... */]);
Detaches your Amazon Elastic Block Store (Amazon EBS) volume from a node in your EKS orchestrated SageMaker HyperPod cluster.
This API works with the Amazon Elastic Block Store (Amazon EBS) Container Storage Interface (CSI) driver to manage the lifecycle of persistent storage in your HyperPod EKS clusters.
Parameter Syntax
$result = $client->detachClusterNodeVolume([
'ClusterArn' => '', // REQUIRED
'NodeId' => '', // REQUIRED
'VolumeId' => '', // REQUIRED
]);
Parameter Details
Members
- ClusterArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster containing the target node. Your cluster must use EKS as the orchestration and be in the
InServicestate. - NodeId
-
- Required: Yes
- Type: string
The unique identifier of the cluster node from which you want to detach the volume.
- VolumeId
-
- Required: Yes
- Type: string
The unique identifier of your EBS volume that you want to detach. Your volume must be currently attached to the specified node.
Result Syntax
[
'AttachTime' => ,
'ClusterArn' => '',
'DeviceName' => '',
'NodeId' => '',
'Status' => 'attaching|attached|detaching|detached|busy',
'VolumeId' => '',
]
Result Details
Members
- AttachTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The original timestamp when your volume was initially attached to the node.
- ClusterArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster where the volume detachment operation was performed.
- DeviceName
-
- Required: Yes
- Type: string
The device name assigned to your attached volume on the target instance.
- NodeId
-
- Required: Yes
- Type: string
The unique identifier of the cluster node from which your volume was detached.
- Status
-
- Required: Yes
- Type: string
The current status of your volume detachment operation.
- VolumeId
-
- Required: Yes
- Type: string
The unique identifier of your EBS volume that was detached.
Errors
- ResourceNotFound:
Resource being access is not found.
DisableSagemakerServicecatalogPortfolio
$result = $client->disableSagemakerServicecatalogPortfolio([/* ... */]); $promise = $client->disableSagemakerServicecatalogPortfolioAsync([/* ... */]);
Disables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.
Parameter Syntax
$result = $client->disableSagemakerServicecatalogPortfolio([ ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DisassociateTrialComponent
$result = $client->disassociateTrialComponent([/* ... */]); $promise = $client->disassociateTrialComponentAsync([/* ... */]);
Disassociates a trial component from a trial. This doesn't effect other trials the component is associated with. Before you can delete a component, you must disassociate the component from all trials it is associated with. To associate a trial component with a trial, call the AssociateTrialComponent API.
To get a list of the trials a component is associated with, use the Search API. Specify ExperimentTrialComponent for the Resource parameter. The list appears in the response under Results.TrialComponent.Parents.
Parameter Syntax
$result = $client->disassociateTrialComponent([
'TrialComponentName' => '', // REQUIRED
'TrialName' => '', // REQUIRED
]);
Parameter Details
Members
- TrialComponentName
-
- Required: Yes
- Type: string
The name of the component to disassociate from the trial.
- TrialName
-
- Required: Yes
- Type: string
The name of the trial to disassociate from.
Result Syntax
[
'TrialArn' => '',
'TrialComponentArn' => '',
]
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.
EnableSagemakerServicecatalogPortfolio
$result = $client->enableSagemakerServicecatalogPortfolio([/* ... */]); $promise = $client->enableSagemakerServicecatalogPortfolioAsync([/* ... */]);
Enables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.
Parameter Syntax
$result = $client->enableSagemakerServicecatalogPortfolio([ ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
ExtendTrainingPlan
$result = $client->extendTrainingPlan([/* ... */]); $promise = $client->extendTrainingPlanAsync([/* ... */]);
Extends an existing training plan by purchasing an extension offering. This allows you to add additional compute capacity time to your training plan without creating a new plan or reconfiguring your workloads.
To find available extension offerings, use the SearchTrainingPlanOfferings API with the TrainingPlanArn parameter.
To view the history of extensions for a training plan, use the DescribeTrainingPlanExtensionHistory API.
Parameter Syntax
$result = $client->extendTrainingPlan([
'TrainingPlanExtensionOfferingId' => '', // REQUIRED
]);
Parameter Details
Members
- TrainingPlanExtensionOfferingId
-
- Required: Yes
- Type: string
The unique identifier of the extension offering to purchase. You can retrieve this ID from the
TrainingPlanExtensionOfferingsin the response of theSearchTrainingPlanOfferingsAPI.
Result Syntax
[
'TrainingPlanExtensions' => [
[
'AvailabilityZone' => '',
'AvailabilityZoneId' => '',
'CurrencyCode' => '',
'DurationHours' => ,
'EndDate' => ,
'ExtendedAt' => ,
'PaymentStatus' => '',
'StartDate' => ,
'Status' => '',
'TrainingPlanExtensionOfferingId' => '',
'UpfrontFee' => '',
],
// ...
],
]
Result Details
Members
- TrainingPlanExtensions
-
- Required: Yes
- Type: Array of TrainingPlanExtension structures
The list of extensions for the training plan, including the newly created extension.
Errors
- ResourceNotFound:
Resource being access is not found.
GetDeviceFleetReport
$result = $client->getDeviceFleetReport([/* ... */]); $promise = $client->getDeviceFleetReportAsync([/* ... */]);
Describes a fleet.
Parameter Syntax
$result = $client->getDeviceFleetReport([
'DeviceFleetName' => '', // REQUIRED
]);
Parameter Details
Members
- DeviceFleetName
-
- Required: Yes
- Type: string
The name of the fleet.
Result Syntax
[
'AgentVersions' => [
[
'AgentCount' => ,
'Version' => '',
],
// ...
],
'Description' => '',
'DeviceFleetArn' => '',
'DeviceFleetName' => '',
'DeviceStats' => [
'ConnectedDeviceCount' => ,
'RegisteredDeviceCount' => ,
],
'ModelStats' => [
[
'ActiveDeviceCount' => ,
'ConnectedDeviceCount' => ,
'ModelName' => '',
'ModelVersion' => '',
'OfflineDeviceCount' => ,
'SamplingDeviceCount' => ,
],
// ...
],
'OutputConfig' => [
'KmsKeyId' => '',
'PresetDeploymentConfig' => '',
'PresetDeploymentType' => 'GreengrassV2Component',
'S3OutputLocation' => '',
],
'ReportGenerated' => ,
]
Result Details
Members
- AgentVersions
-
- Type: Array of AgentVersion structures
The versions of Edge Manager agent deployed on the fleet.
- Description
-
- Type: string
Description of the fleet.
- DeviceFleetArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the device.
- DeviceFleetName
-
- Required: Yes
- Type: string
The name of the fleet.
- DeviceStats
-
- Type: DeviceStats structure
Status of devices.
- ModelStats
-
- Type: Array of EdgeModelStat structures
Status of model on device.
- OutputConfig
-
- Type: EdgeOutputConfig structure
The output configuration for storing sample data collected by the fleet.
- ReportGenerated
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp of when the report was generated.
Errors
There are no errors described for this operation.
GetLineageGroupPolicy
$result = $client->getLineageGroupPolicy([/* ... */]); $promise = $client->getLineageGroupPolicyAsync([/* ... */]);
The resource policy for the lineage group.
Parameter Syntax
$result = $client->getLineageGroupPolicy([
'LineageGroupName' => '', // REQUIRED
]);
Parameter Details
Members
- LineageGroupName
-
- Required: Yes
- Type: string
The name or Amazon Resource Name (ARN) of the lineage group.
Result Syntax
[
'LineageGroupArn' => '',
'ResourcePolicy' => '',
]
Result Details
Members
- LineageGroupArn
-
- Type: string
The Amazon Resource Name (ARN) of the lineage group.
- ResourcePolicy
-
- Type: string
The resource policy that gives access to the lineage group in another account.
Errors
- ResourceNotFound:
Resource being access is not found.
GetModelPackageGroupPolicy
$result = $client->getModelPackageGroupPolicy([/* ... */]); $promise = $client->getModelPackageGroupPolicyAsync([/* ... */]);
Gets a resource policy that manages access for a model group. For information about resource policies, see Identity-based policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..
Parameter Syntax
$result = $client->getModelPackageGroupPolicy([
'ModelPackageGroupName' => '', // REQUIRED
]);
Parameter Details
Members
- ModelPackageGroupName
-
- Required: Yes
- Type: string
The name of the model group for which to get the resource policy.
Result Syntax
[
'ResourcePolicy' => '',
]
Result Details
Members
- ResourcePolicy
-
- Required: Yes
- Type: string
The resource policy for the model group.
Errors
There are no errors described for this operation.
GetSagemakerServicecatalogPortfolioStatus
$result = $client->getSagemakerServicecatalogPortfolioStatus([/* ... */]); $promise = $client->getSagemakerServicecatalogPortfolioStatusAsync([/* ... */]);
Gets the status of Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.
Parameter Syntax
$result = $client->getSagemakerServicecatalogPortfolioStatus([ ]);
Parameter Details
Members
Result Syntax
[
'Status' => 'Enabled|Disabled',
]
Result Details
Members
- Status
-
- Type: string
Whether Service Catalog is enabled or disabled in SageMaker.
Errors
There are no errors described for this operation.
GetScalingConfigurationRecommendation
$result = $client->getScalingConfigurationRecommendation([/* ... */]); $promise = $client->getScalingConfigurationRecommendationAsync([/* ... */]);
Starts an Amazon SageMaker Inference Recommender autoscaling recommendation job. Returns recommendations for autoscaling policies that you can apply to your SageMaker endpoint.
Parameter Syntax
$result = $client->getScalingConfigurationRecommendation([
'EndpointName' => '',
'InferenceRecommendationsJobName' => '', // REQUIRED
'RecommendationId' => '',
'ScalingPolicyObjective' => [
'MaxInvocationsPerMinute' => ,
'MinInvocationsPerMinute' => ,
],
'TargetCpuUtilizationPerCore' => ,
]);
Parameter Details
Members
- EndpointName
-
- Type: string
The name of an endpoint benchmarked during a previously completed inference recommendation job. This name should come from one of the recommendations returned by the job specified in the
InferenceRecommendationsJobNamefield.Specify either this field or the
RecommendationIdfield. - InferenceRecommendationsJobName
-
- Required: Yes
- Type: string
The name of a previously completed Inference Recommender job.
- RecommendationId
-
- Type: string
The recommendation ID of a previously completed inference recommendation. This ID should come from one of the recommendations returned by the job specified in the
InferenceRecommendationsJobNamefield.Specify either this field or the
EndpointNamefield. - ScalingPolicyObjective
-
- Type: ScalingPolicyObjective structure
An object where you specify the anticipated traffic pattern for an endpoint.
- TargetCpuUtilizationPerCore
-
- Type: int
The percentage of how much utilization you want an instance to use before autoscaling. The default value is 50%.
Result Syntax
[
'DynamicScalingConfiguration' => [
'MaxCapacity' => ,
'MinCapacity' => ,
'ScaleInCooldown' => ,
'ScaleOutCooldown' => ,
'ScalingPolicies' => [
[
'TargetTracking' => [
'MetricSpecification' => [
'Customized' => [
'MetricName' => '',
'Namespace' => '',
'Statistic' => 'Average|Minimum|Maximum|SampleCount|Sum',
],
'Predefined' => [
'PredefinedMetricType' => '',
],
],
'TargetValue' => ,
],
],
// ...
],
],
'EndpointName' => '',
'InferenceRecommendationsJobName' => '',
'Metric' => [
'InvocationsPerInstance' => ,
'ModelLatency' => ,
],
'RecommendationId' => '',
'ScalingPolicyObjective' => [
'MaxInvocationsPerMinute' => ,
'MinInvocationsPerMinute' => ,
],
'TargetCpuUtilizationPerCore' => ,
]
Result Details
Members
- DynamicScalingConfiguration
-
- Type: DynamicScalingConfiguration structure
An object with the recommended values for you to specify when creating an autoscaling policy.
- EndpointName
-
- Type: string
The name of an endpoint benchmarked during a previously completed Inference Recommender job.
- InferenceRecommendationsJobName
-
- Type: string
The name of a previously completed Inference Recommender job.
- Metric
-
- Type: ScalingPolicyMetric structure
An object with a list of metrics that were benchmarked during the previously completed Inference Recommender job.
- RecommendationId
-
- Type: string
The recommendation ID of a previously completed inference recommendation.
- ScalingPolicyObjective
-
- Type: ScalingPolicyObjective structure
An object representing the anticipated traffic pattern for an endpoint that you specified in the request.
- TargetCpuUtilizationPerCore
-
- Type: int
The percentage of how much utilization you want an instance to use before autoscaling, which you specified in the request. The default value is 50%.
Errors
- ResourceNotFound:
Resource being access is not found.
GetSearchSuggestions
$result = $client->getSearchSuggestions([/* ... */]); $promise = $client->getSearchSuggestionsAsync([/* ... */]);
An auto-complete API for the search functionality in the SageMaker console. It returns suggestions of possible matches for the property name to use in Search queries. Provides suggestions for HyperParameters, Tags, and Metrics.
Parameter Syntax
$result = $client->getSearchSuggestions([
'Resource' => 'TrainingJob|Experiment|ExperimentTrial|ExperimentTrialComponent|Endpoint|Model|ModelPackage|ModelPackageGroup|Pipeline|PipelineExecution|FeatureGroup|FeatureMetadata|Image|ImageVersion|Project|HyperParameterTuningJob|ModelCard|PipelineVersion|Job|HubContent', // REQUIRED
'SuggestionQuery' => [
'PropertyNameQuery' => [
'PropertyNameHint' => '', // REQUIRED
],
],
]);
Parameter Details
Members
- Resource
-
- Required: Yes
- Type: string
The name of the SageMaker resource to search for.
- SuggestionQuery
-
- Type: SuggestionQuery structure
Limits the property names that are included in the response.
Result Syntax
[
'PropertyNameSuggestions' => [
[
'PropertyName' => '',
],
// ...
],
]
Result Details
Members
- PropertyNameSuggestions
-
- Type: Array of PropertyNameSuggestion structures
A list of property names for a
Resourcethat match aSuggestionQuery.
Errors
There are no errors described for this operation.
ImportHubContent
$result = $client->importHubContent([/* ... */]); $promise = $client->importHubContentAsync([/* ... */]);
Import hub content.
Parameter Syntax
$result = $client->importHubContent([
'DocumentSchemaVersion' => '', // REQUIRED
'HubContentDescription' => '',
'HubContentDisplayName' => '',
'HubContentDocument' => '', // REQUIRED
'HubContentMarkdown' => '',
'HubContentName' => '', // REQUIRED
'HubContentSearchKeywords' => ['', ...],
'HubContentType' => 'Model|Notebook|ModelReference|DataSet|JsonDoc', // REQUIRED
'HubContentVersion' => '',
'HubName' => '', // REQUIRED
'SupportStatus' => 'Supported|Deprecated|Restricted',
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- DocumentSchemaVersion
-
- Required: Yes
- Type: string
The version of the hub content schema to import.
- HubContentDescription
-
- Type: string
A description of the hub content to import.
- HubContentDisplayName
-
- Type: string
The display name of the hub content to import.
- HubContentDocument
-
- Required: Yes
- Type: string
The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.
- HubContentMarkdown
-
- Type: string
A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.
- HubContentName
-
- Required: Yes
- Type: string
The name of the hub content to import.
- HubContentSearchKeywords
-
- Type: Array of strings
The searchable keywords of the hub content.
- HubContentType
-
- Required: Yes
- Type: string
The type of hub content to import.
- HubContentVersion
-
- Type: string
The version of the hub content to import.
- HubName
-
- Required: Yes
- Type: string
The name of the hub to import content into.
- SupportStatus
-
- Type: string
The status of the hub content resource.
- Tags
-
- Type: Array of Tag structures
Any tags associated with the hub content.
Result Syntax
[
'HubArn' => '',
'HubContentArn' => '',
]
Result Details
Members
- HubArn
-
- Required: Yes
- Type: string
The ARN of the hub that the content was imported into.
- HubContentArn
-
- Required: Yes
- Type: string
The ARN of the hub content that was imported.
Errors
- ResourceNotFound:
Resource being access is not found.
- ResourceInUse:
Resource being accessed is in use.
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
ListAIBenchmarkJobs
$result = $client->listAIBenchmarkJobs([/* ... */]); $promise = $client->listAIBenchmarkJobsAsync([/* ... */]);
Returns a list of AI benchmark jobs in your account. You can filter the results by name, status, and creation time, and sort the results. The response is paginated.
Parameter Syntax
$result = $client->listAIBenchmarkJobs([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime|Status',
'SortOrder' => 'Ascending|Descending',
'StatusEquals' => 'InProgress|Completed|Failed|Stopping|Stopped',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only jobs created after the specified time.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only jobs created before the specified time.
- MaxResults
-
- Type: int
The maximum number of benchmark jobs to return in the response.
- NameContains
-
- Type: string
A string in the job name. This filter returns only jobs whose name contains the specified string.
- NextToken
-
- Type: string
If the previous call to
ListAIBenchmarkJobsdidn't return the full set of jobs, the call returns a token for getting the next set. - SortBy
-
- Type: string
The field to sort results by. The default is
CreationTime. - SortOrder
-
- Type: string
The sort order for results. The default is
Descending. - StatusEquals
-
- Type: string
A filter that returns only benchmark jobs with the specified status.
Result Syntax
[
'AIBenchmarkJobs' => [
[
'AIBenchmarkJobArn' => '',
'AIBenchmarkJobName' => '',
'AIBenchmarkJobStatus' => 'InProgress|Completed|Failed|Stopping|Stopped',
'AIWorkloadConfigName' => '',
'CreationTime' => ,
'EndTime' => ,
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- AIBenchmarkJobs
-
- Required: Yes
- Type: Array of AIBenchmarkJobSummary structures
An array of
AIBenchmarkJobSummaryobjects, one for each benchmark job that matches the specified filters. - NextToken
-
- Type: string
If the response is truncated, Amazon SageMaker AI returns this token. To retrieve the next set of jobs, use it in the subsequent request.
Errors
There are no errors described for this operation.
ListAIRecommendationJobs
$result = $client->listAIRecommendationJobs([/* ... */]); $promise = $client->listAIRecommendationJobsAsync([/* ... */]);
Returns a list of AI recommendation jobs in your account. You can filter the results by name, status, and creation time, and sort the results. The response is paginated.
Parameter Syntax
$result = $client->listAIRecommendationJobs([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime|Status',
'SortOrder' => 'Ascending|Descending',
'StatusEquals' => 'InProgress|Completed|Failed|Stopping|Stopped',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only jobs created after the specified time.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only jobs created before the specified time.
- MaxResults
-
- Type: int
The maximum number of recommendation jobs to return in the response.
- NameContains
-
- Type: string
A string in the job name. This filter returns only jobs whose name contains the specified string.
- NextToken
-
- Type: string
If the previous call to
ListAIRecommendationJobsdidn't return the full set of jobs, the call returns a token for getting the next set. - SortBy
-
- Type: string
The field to sort results by. The default is
CreationTime. - SortOrder
-
- Type: string
The sort order for results. The default is
Descending. - StatusEquals
-
- Type: string
A filter that returns only recommendation jobs with the specified status.
Result Syntax
[
'AIRecommendationJobs' => [
[
'AIRecommendationJobArn' => '',
'AIRecommendationJobName' => '',
'AIRecommendationJobStatus' => 'InProgress|Completed|Failed|Stopping|Stopped',
'CreationTime' => ,
'EndTime' => ,
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- AIRecommendationJobs
-
- Required: Yes
- Type: Array of AIRecommendationJobSummary structures
An array of
AIRecommendationJobSummaryobjects, one for each recommendation job that matches the specified filters. - NextToken
-
- Type: string
If the response is truncated, Amazon SageMaker AI returns this token. To retrieve the next set of jobs, use it in the subsequent request.
Errors
There are no errors described for this operation.
ListAIWorkloadConfigs
$result = $client->listAIWorkloadConfigs([/* ... */]); $promise = $client->listAIWorkloadConfigsAsync([/* ... */]);
Returns a list of AI workload configurations in your account. You can filter the results by name and creation time, and sort the results. The response is paginated.
Parameter Syntax
$result = $client->listAIWorkloadConfigs([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only configurations created after the specified time.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only configurations created before the specified time.
- MaxResults
-
- Type: int
The maximum number of AI workload configurations to return in the response.
- NameContains
-
- Type: string
A string in the configuration name. This filter returns only configurations whose name contains the specified string.
- NextToken
-
- Type: string
If the previous call to
ListAIWorkloadConfigsdidn't return the full set of configurations, the call returns a token for getting the next set of configurations. - SortBy
-
- Type: string
The field to sort results by. The default is
CreationTime. - SortOrder
-
- Type: string
The sort order for results. The default is
Descending.
Result Syntax
[
'AIWorkloadConfigs' => [
[
'AIWorkloadConfigArn' => '',
'AIWorkloadConfigName' => '',
'CreationTime' => ,
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- AIWorkloadConfigs
-
- Required: Yes
- Type: Array of AIWorkloadConfigSummary structures
An array of
AIWorkloadConfigSummaryobjects, one for each AI workload configuration that matches the specified filters. - NextToken
-
- Type: string
If the response is truncated, Amazon SageMaker AI returns this token. To retrieve the next set of configurations, use it in the subsequent request.
Errors
There are no errors described for this operation.
ListActions
$result = $client->listActions([/* ... */]); $promise = $client->listActionsAsync([/* ... */]);
Lists the actions in your account and their properties.
Parameter Syntax
$result = $client->listActions([
'ActionType' => '',
'CreatedAfter' => ,
'CreatedBefore' => ,
'MaxResults' => ,
'NextToken' => '',
'SortBy' => 'Name|CreationTime',
'SortOrder' => 'Ascending|Descending',
'SourceUri' => '',
]);
Parameter Details
Members
- ActionType
-
- Type: string
A filter that returns only actions of the specified type.
- CreatedAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only actions created on or after the specified time.
- CreatedBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only actions created on or before the specified time.
- MaxResults
-
- Type: int
The maximum number of actions to return in the response. The default value is 10.
- NextToken
-
- Type: string
If the previous call to
ListActionsdidn't return the full set of actions, the call returns a token for getting the next set of actions. - SortBy
-
- Type: string
The property used to sort results. The default value is
CreationTime. - SortOrder
-
- Type: string
The sort order. The default value is
Descending. - SourceUri
-
- Type: string
A filter that returns only actions with the specified source URI.
Result Syntax
[
'ActionSummaries' => [
[
'ActionArn' => '',
'ActionName' => '',
'ActionType' => '',
'CreationTime' => ,
'LastModifiedTime' => ,
'Source' => [
'SourceId' => '',
'SourceType' => '',
'SourceUri' => '',
],
'Status' => 'Unknown|InProgress|Completed|Failed|Stopping|Stopped',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- ActionSummaries
-
- Type: Array of ActionSummary structures
A list of actions and their properties.
- NextToken
-
- Type: string
A token for getting the next set of actions, if there are any.
Errors
- ResourceNotFound:
Resource being access is not found.
ListAlgorithms
$result = $client->listAlgorithms([/* ... */]); $promise = $client->listAlgorithmsAsync([/* ... */]);
Lists the machine learning algorithms that have been created.
Parameter Syntax
$result = $client->listAlgorithms([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only algorithms created after the specified time (timestamp).
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only algorithms created before the specified time (timestamp).
- MaxResults
-
- Type: int
The maximum number of algorithms to return in the response.
- NameContains
-
- Type: string
A string in the algorithm name. This filter returns only algorithms whose name contains the specified string.
- NextToken
-
- Type: string
If the response to a previous
ListAlgorithmsrequest was truncated, the response includes aNextToken. To retrieve the next set of algorithms, use the token in the next request. - SortBy
-
- Type: string
The parameter by which to sort the results. The default is
CreationTime. - SortOrder
-
- Type: string
The sort order for the results. The default is
Ascending.
Result Syntax
[
'AlgorithmSummaryList' => [
[
'AlgorithmArn' => '',
'AlgorithmDescription' => '',
'AlgorithmName' => '',
'AlgorithmStatus' => 'Pending|InProgress|Completed|Failed|Deleting',
'CreationTime' => ,
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- AlgorithmSummaryList
-
- Required: Yes
- Type: Array of AlgorithmSummary structures
>An array of
AlgorithmSummaryobjects, each of which lists an algorithm. - NextToken
-
- Type: string
If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.
Errors
There are no errors described for this operation.
ListAliases
$result = $client->listAliases([/* ... */]); $promise = $client->listAliasesAsync([/* ... */]);
Lists the aliases of a specified image or image version.
Parameter Syntax
$result = $client->listAliases([
'Alias' => '',
'ImageName' => '', // REQUIRED
'MaxResults' => ,
'NextToken' => '',
'Version' => ,
]);
Parameter Details
Members
- Alias
-
- Type: string
The alias of the image version.
- ImageName
-
- Required: Yes
- Type: string
The name of the image.
- MaxResults
-
- Type: int
The maximum number of aliases to return.
- NextToken
-
- Type: string
If the previous call to
ListAliasesdidn't return the full set of aliases, the call returns a token for retrieving the next set of aliases. - Version
-
- Type: int
The version of the image. If image version is not specified, the aliases of all versions of the image are listed.
Result Syntax
[
'NextToken' => '',
'SageMakerImageVersionAliases' => ['', ...],
]
Result Details
Members
- NextToken
-
- Type: string
A token for getting the next set of aliases, if more aliases exist.
- SageMakerImageVersionAliases
-
- Type: Array of strings
A list of SageMaker AI image version aliases.
Errors
- ResourceNotFound:
Resource being access is not found.
ListAppImageConfigs
$result = $client->listAppImageConfigs([/* ... */]); $promise = $client->listAppImageConfigsAsync([/* ... */]);
Lists the AppImageConfigs in your account and their properties. The list can be filtered by creation time or modified time, and whether the AppImageConfig name contains a specified string.
Parameter Syntax
$result = $client->listAppImageConfigs([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'MaxResults' => ,
'ModifiedTimeAfter' => ,
'ModifiedTimeBefore' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'CreationTime|LastModifiedTime|Name',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only AppImageConfigs created on or after the specified time.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only AppImageConfigs created on or before the specified time.
- MaxResults
-
- Type: int
The total number of items to return in the response. If the total number of items available is more than the value specified, a
NextTokenis provided in the response. To resume pagination, provide theNextTokenvalue in the as part of a subsequent call. The default value is 10. - ModifiedTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only AppImageConfigs modified on or after the specified time.
- ModifiedTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only AppImageConfigs modified on or before the specified time.
- NameContains
-
- Type: string
A filter that returns only AppImageConfigs whose name contains the specified string.
- NextToken
-
- Type: string
If the previous call to
ListImagesdidn't return the full set of AppImageConfigs, the call returns a token for getting the next set of AppImageConfigs. - SortBy
-
- Type: string
The property used to sort results. The default value is
CreationTime. - SortOrder
-
- Type: string
The sort order. The default value is
Descending.
Result Syntax
[
'AppImageConfigs' => [
[
'AppImageConfigArn' => '',
'AppImageConfigName' => '',
'CodeEditorAppImageConfig' => [
'ContainerConfig' => [
'ContainerArguments' => ['', ...],
'ContainerEntrypoint' => ['', ...],
'ContainerEnvironmentVariables' => ['', ...],
],
'FileSystemConfig' => [
'DefaultGid' => ,
'DefaultUid' => ,
'MountPath' => '',
],
],
'CreationTime' => ,
'JupyterLabAppImageConfig' => [
'ContainerConfig' => [
'ContainerArguments' => ['', ...],
'ContainerEntrypoint' => ['', ...],
'ContainerEnvironmentVariables' => ['', ...],
],
'FileSystemConfig' => [
'DefaultGid' => ,
'DefaultUid' => ,
'MountPath' => '',
],
],
'KernelGatewayImageConfig' => [
'FileSystemConfig' => [
'DefaultGid' => ,
'DefaultUid' => ,
'MountPath' => '',
],
'KernelSpecs' => [
[
'DisplayName' => '',
'Name' => '',
],
// ...
],
],
'LastModifiedTime' => ,
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- AppImageConfigs
-
- Type: Array of AppImageConfigDetails structures
A list of AppImageConfigs and their properties.
- NextToken
-
- Type: string
A token for getting the next set of AppImageConfigs, if there are any.
Errors
There are no errors described for this operation.
ListApps
$result = $client->listApps([/* ... */]); $promise = $client->listAppsAsync([/* ... */]);
Lists apps.
Parameter Syntax
$result = $client->listApps([
'DomainIdEquals' => '',
'MaxResults' => ,
'NextToken' => '',
'SortBy' => 'CreationTime',
'SortOrder' => 'Ascending|Descending',
'SpaceNameEquals' => '',
'UserProfileNameEquals' => '',
]);
Parameter Details
Members
- DomainIdEquals
-
- Type: string
A parameter to search for the domain ID.
- MaxResults
-
- Type: int
This parameter defines the maximum number of results that can be return in a single response. The
MaxResultsparameter is an upper bound, not a target. If there are more results available than the value specified, aNextTokenis provided in the response. TheNextTokenindicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value forMaxResultsis 10. - NextToken
-
- Type: string
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
- SortBy
-
- Type: string
The parameter by which to sort the results. The default is CreationTime.
- SortOrder
-
- Type: string
The sort order for the results. The default is Ascending.
- SpaceNameEquals
-
- Type: string
A parameter to search by space name. If
UserProfileNameEqualsis set, then this value cannot be set. - UserProfileNameEquals
-
- Type: string
A parameter to search by user profile name. If
SpaceNameEqualsis set, then this value cannot be set.
Result Syntax
[
'Apps' => [
[
'AppName' => '',
'AppType' => 'JupyterServer|KernelGateway|DetailedProfiler|TensorBoard|CodeEditor|JupyterLab|RStudioServerPro|RSessionGateway|Canvas',
'CreationTime' => ,
'DomainId' => '',
'ResourceSpec' => [
'InstanceType' => 'system|ml.t3.micro|ml.t3.small|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.geospatial.interactive|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p5.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.p5.4xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge',
'LifecycleConfigArn' => '',
'SageMakerImageArn' => '',
'SageMakerImageVersionAlias' => '',
'SageMakerImageVersionArn' => '',
'TrainingPlanArn' => '',
],
'SpaceName' => '',
'Status' => 'Deleted|Deleting|Failed|InService|Pending',
'UserProfileName' => '',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- Apps
-
- Type: Array of AppDetails structures
The list of apps.
- NextToken
-
- Type: string
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
Errors
There are no errors described for this operation.
ListArtifacts
$result = $client->listArtifacts([/* ... */]); $promise = $client->listArtifactsAsync([/* ... */]);
Lists the artifacts in your account and their properties.
Parameter Syntax
$result = $client->listArtifacts([
'ArtifactType' => '',
'CreatedAfter' => ,
'CreatedBefore' => ,
'MaxResults' => ,
'NextToken' => '',
'SortBy' => 'CreationTime',
'SortOrder' => 'Ascending|Descending',
'SourceUri' => '',
]);
Parameter Details
Members
- ArtifactType
-
- Type: string
A filter that returns only artifacts of the specified type.
- CreatedAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only artifacts created on or after the specified time.
- CreatedBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only artifacts created on or before the specified time.
- MaxResults
-
- Type: int
The maximum number of artifacts to return in the response. The default value is 10.
- NextToken
-
- Type: string
If the previous call to
ListArtifactsdidn't return the full set of artifacts, the call returns a token for getting the next set of artifacts. - SortBy
-
- Type: string
The property used to sort results. The default value is
CreationTime. - SortOrder
-
- Type: string
The sort order. The default value is
Descending. - SourceUri
-
- Type: string
A filter that returns only artifacts with the specified source URI.
Result Syntax
[
'ArtifactSummaries' => [
[
'ArtifactArn' => '',
'ArtifactName' => '',
'ArtifactType' => '',
'CreationTime' => ,
'LastModifiedTime' => ,
'Source' => [
'SourceTypes' => [
[
'SourceIdType' => 'MD5Hash|S3ETag|S3Version|Custom',
'Value' => '',
],
// ...
],
'SourceUri' => '',
],
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- ArtifactSummaries
-
- Type: Array of ArtifactSummary structures
A list of artifacts and their properties.
- NextToken
-
- Type: string
A token for getting the next set of artifacts, if there are any.
Errors
- ResourceNotFound:
Resource being access is not found.
ListAssociations
$result = $client->listAssociations([/* ... */]); $promise = $client->listAssociationsAsync([/* ... */]);
Lists the associations in your account and their properties.
Parameter Syntax
$result = $client->listAssociations([
'AssociationType' => 'ContributedTo|AssociatedWith|DerivedFrom|Produced|SameAs',
'CreatedAfter' => ,
'CreatedBefore' => ,
'DestinationArn' => '',
'DestinationType' => '',
'MaxResults' => ,
'NextToken' => '',
'SortBy' => 'SourceArn|DestinationArn|SourceType|DestinationType|CreationTime',
'SortOrder' => 'Ascending|Descending',
'SourceArn' => '',
'SourceType' => '',
]);
Parameter Details
Members
- AssociationType
-
- Type: string
A filter that returns only associations of the specified type.
- CreatedAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only associations created on or after the specified time.
- CreatedBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only associations created on or before the specified time.
- DestinationArn
-
- Type: string
A filter that returns only associations with the specified destination Amazon Resource Name (ARN).
- DestinationType
-
- Type: string
A filter that returns only associations with the specified destination type.
- MaxResults
-
- Type: int
The maximum number of associations to return in the response. The default value is 10.
- NextToken
-
- Type: string
If the previous call to
ListAssociationsdidn't return the full set of associations, the call returns a token for getting the next set of associations. - SortBy
-
- Type: string
The property used to sort results. The default value is
CreationTime. - SortOrder
-
- Type: string
The sort order. The default value is
Descending. - SourceArn
-
- Type: string
A filter that returns only associations with the specified source ARN.
- SourceType
-
- Type: string
A filter that returns only associations with the specified source type.
Result Syntax
[
'AssociationSummaries' => [
[
'AssociationType' => 'ContributedTo|AssociatedWith|DerivedFrom|Produced|SameAs',
'CreatedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'CreationTime' => ,
'DestinationArn' => '',
'DestinationName' => '',
'DestinationType' => '',
'SourceArn' => '',
'SourceName' => '',
'SourceType' => '',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- AssociationSummaries
-
- Type: Array of AssociationSummary structures
A list of associations and their properties.
- NextToken
-
- Type: string
A token for getting the next set of associations, if there are any.
Errors
- ResourceNotFound:
Resource being access is not found.
ListAutoMLJobs
$result = $client->listAutoMLJobs([/* ... */]); $promise = $client->listAutoMLJobsAsync([/* ... */]);
Request a list of jobs.
Parameter Syntax
$result = $client->listAutoMLJobs([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'LastModifiedTimeAfter' => ,
'LastModifiedTimeBefore' => ,
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime|Status',
'SortOrder' => 'Ascending|Descending',
'StatusEquals' => 'Completed|InProgress|Failed|Stopped|Stopping',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Request a list of jobs, using a filter for time.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Request a list of jobs, using a filter for time.
- LastModifiedTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Request a list of jobs, using a filter for time.
- LastModifiedTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Request a list of jobs, using a filter for time.
- MaxResults
-
- Type: int
Request a list of jobs up to a specified limit.
- NameContains
-
- Type: string
Request a list of jobs, using a search filter for name.
- NextToken
-
- Type: string
If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
- SortBy
-
- Type: string
The parameter by which to sort the results. The default is
Name. - SortOrder
-
- Type: string
The sort order for the results. The default is
Descending. - StatusEquals
-
- Type: string
Request a list of jobs, using a filter for status.
Result Syntax
[
'AutoMLJobSummaries' => [
[
'AutoMLJobArn' => '',
'AutoMLJobName' => '',
'AutoMLJobSecondaryStatus' => 'Starting|MaxCandidatesReached|Failed|Stopped|MaxAutoMLJobRuntimeReached|Stopping|CandidateDefinitionsGenerated|Completed|ExplainabilityError|DeployingModel|ModelDeploymentError|GeneratingModelInsightsReport|ModelInsightsError|AnalyzingData|FeatureEngineering|ModelTuning|GeneratingExplainabilityReport|TrainingModels|PreTraining',
'AutoMLJobStatus' => 'Completed|InProgress|Failed|Stopped|Stopping',
'CreationTime' => ,
'EndTime' => ,
'FailureReason' => '',
'LastModifiedTime' => ,
'PartialFailureReasons' => [
[
'PartialFailureMessage' => '',
],
// ...
],
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- AutoMLJobSummaries
-
- Required: Yes
- Type: Array of AutoMLJobSummary structures
Returns a summary list of jobs.
- NextToken
-
- Type: string
If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
Errors
There are no errors described for this operation.
ListCandidatesForAutoMLJob
$result = $client->listCandidatesForAutoMLJob([/* ... */]); $promise = $client->listCandidatesForAutoMLJobAsync([/* ... */]);
List the candidates created for the job.
Parameter Syntax
$result = $client->listCandidatesForAutoMLJob([
'AutoMLJobName' => '', // REQUIRED
'CandidateNameEquals' => '',
'MaxResults' => ,
'NextToken' => '',
'SortBy' => 'CreationTime|Status|FinalObjectiveMetricValue',
'SortOrder' => 'Ascending|Descending',
'StatusEquals' => 'Completed|InProgress|Failed|Stopped|Stopping',
]);
Parameter Details
Members
- AutoMLJobName
-
- Required: Yes
- Type: string
List the candidates created for the job by providing the job's name.
- CandidateNameEquals
-
- Type: string
List the candidates for the job and filter by candidate name.
- MaxResults
-
- Type: int
List the job's candidates up to a specified limit.
- NextToken
-
- Type: string
If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
- SortBy
-
- Type: string
The parameter by which to sort the results. The default is
Descending. - SortOrder
-
- Type: string
The sort order for the results. The default is
Ascending. - StatusEquals
-
- Type: string
List the candidates for the job and filter by status.
Result Syntax
[
'Candidates' => [
[
'CandidateName' => '',
'CandidateProperties' => [
'CandidateArtifactLocations' => [
'BacktestResults' => '',
'Explainability' => '',
'ModelInsights' => '',
],
'CandidateMetrics' => [
[
'MetricName' => 'Accuracy|MSE|F1|F1macro|AUC|RMSE|BalancedAccuracy|R2|Recall|RecallMacro|Precision|PrecisionMacro|MAE|MAPE|MASE|WAPE|AverageWeightedQuantileLoss',
'Set' => 'Train|Validation|Test',
'StandardMetricName' => 'Accuracy|MSE|F1|F1macro|AUC|RMSE|MAE|R2|BalancedAccuracy|Precision|PrecisionMacro|Recall|RecallMacro|LogLoss|InferenceLatency|MAPE|MASE|WAPE|AverageWeightedQuantileLoss|Rouge1|Rouge2|RougeL|RougeLSum|Perplexity|ValidationLoss|TrainingLoss',
'Value' => ,
],
// ...
],
],
'CandidateStatus' => 'Completed|InProgress|Failed|Stopped|Stopping',
'CandidateSteps' => [
[
'CandidateStepArn' => '',
'CandidateStepName' => '',
'CandidateStepType' => 'AWS::SageMaker::TrainingJob|AWS::SageMaker::TransformJob|AWS::SageMaker::ProcessingJob',
],
// ...
],
'CreationTime' => ,
'EndTime' => ,
'FailureReason' => '',
'FinalAutoMLJobObjectiveMetric' => [
'MetricName' => 'Accuracy|MSE|F1|F1macro|AUC|RMSE|BalancedAccuracy|R2|Recall|RecallMacro|Precision|PrecisionMacro|MAE|MAPE|MASE|WAPE|AverageWeightedQuantileLoss',
'StandardMetricName' => 'Accuracy|MSE|F1|F1macro|AUC|RMSE|BalancedAccuracy|R2|Recall|RecallMacro|Precision|PrecisionMacro|MAE|MAPE|MASE|WAPE|AverageWeightedQuantileLoss',
'Type' => 'Maximize|Minimize',
'Value' => ,
],
'InferenceContainerDefinitions' => [
'' => [
[
'Environment' => ['', ...],
'Image' => '',
'ModelDataUrl' => '',
],
// ...
],
// ...
],
'InferenceContainers' => [
[
'Environment' => ['', ...],
'Image' => '',
'ModelDataUrl' => '',
],
// ...
],
'LastModifiedTime' => ,
'ObjectiveStatus' => 'Succeeded|Pending|Failed',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- Candidates
-
- Required: Yes
- Type: Array of AutoMLCandidate structures
Summaries about the
AutoMLCandidates. - NextToken
-
- Type: string
If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
Errors
- ResourceNotFound:
Resource being access is not found.
ListClusterEvents
$result = $client->listClusterEvents([/* ... */]); $promise = $client->listClusterEventsAsync([/* ... */]);
Retrieves a list of event summaries for a specified HyperPod cluster. The operation supports filtering, sorting, and pagination of results. This functionality is only supported when the NodeProvisioningMode is set to Continuous.
Parameter Syntax
$result = $client->listClusterEvents([
'ClusterName' => '', // REQUIRED
'EventTimeAfter' => ,
'EventTimeBefore' => ,
'InstanceGroupName' => '',
'MaxResults' => ,
'NextToken' => '',
'NodeId' => '',
'ResourceType' => 'Cluster|InstanceGroup|Instance',
'SortBy' => 'EventTime',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- ClusterName
-
- Required: Yes
- Type: string
The name or Amazon Resource Name (ARN) of the HyperPod cluster for which to list events.
- EventTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start of the time range for filtering events. Only events that occurred after this time are included in the results.
- EventTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The end of the time range for filtering events. Only events that occurred before this time are included in the results.
- InstanceGroupName
-
- Type: string
The name of the instance group to filter events. If specified, only events related to this instance group are returned.
- MaxResults
-
- Type: int
The maximum number of events to return in the response. Valid range is 1 to 100.
- NextToken
-
- Type: string
A token to retrieve the next set of results. This token is obtained from the output of a previous
ListClusterEventscall. - NodeId
-
- Type: string
The EC2 instance ID to filter events. If specified, only events related to this instance are returned.
- ResourceType
-
- Type: string
The type of resource for which to filter events. Valid values are
Cluster,InstanceGroup, orInstance. - SortBy
-
- Type: string
The field to use for sorting the event list. Currently, the only supported value is
EventTime. - SortOrder
-
- Type: string
The order in which to sort the results. Valid values are
AscendingorDescending(the default isDescending).
Result Syntax
[
'Events' => [
[
'ClusterArn' => '',
'ClusterName' => '',
'Description' => '',
'EventId' => '',
'EventLevel' => 'Info|Warn|Error',
'EventTime' => ,
'InstanceGroupName' => '',
'InstanceId' => '',
'ResourceType' => 'Cluster|InstanceGroup|Instance',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- Events
-
- Type: Array of ClusterEventSummary structures
A list of event summaries matching the specified criteria.
- NextToken
-
- Type: string
A token to retrieve the next set of results. Include this token in subsequent
ListClusterEventscalls to fetch more events.
Errors
- ResourceNotFound:
Resource being access is not found.
ListClusterNodes
$result = $client->listClusterNodes([/* ... */]); $promise = $client->listClusterNodesAsync([/* ... */]);
Retrieves the list of instances (also called nodes interchangeably) in a SageMaker HyperPod cluster.
Parameter Syntax
$result = $client->listClusterNodes([
'ClusterName' => '', // REQUIRED
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'IncludeNodeLogicalIds' => true || false,
'InstanceGroupNameContains' => '',
'MaxResults' => ,
'NextToken' => '',
'SortBy' => 'CREATION_TIME|NAME',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- ClusterName
-
- Required: Yes
- Type: string
The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the list of nodes.
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time. Timestamps are formatted according to the ISO 8601 standard.
Acceptable formats include:
-
YYYY-MM-DDThh:mm:ss.sssTZD(UTC), for example,2014-10-01T20:30:00.000Z -
YYYY-MM-DDThh:mm:ss.sssTZD(with offset), for example,2014-10-01T12:30:00.000-08:00 -
YYYY-MM-DD, for example,2014-10-01 -
Unix time in seconds, for example,
1412195400. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.
For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for
CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide. - IncludeNodeLogicalIds
-
- Type: boolean
Specifies whether to include nodes that are still being provisioned in the response. When set to true, the response includes all nodes regardless of their provisioning status. When set to
False(default), only nodes with assignedInstanceIdsare returned. - InstanceGroupNameContains
-
- Type: string
A filter that returns the instance groups whose name contain a specified string.
- MaxResults
-
- Type: int
The maximum number of nodes to return in the response.
- NextToken
-
- Type: string
If the result of the previous
ListClusterNodesrequest was truncated, the response includes aNextToken. To retrieve the next set of cluster nodes, use the token in the next request. - SortBy
-
- Type: string
The field by which to sort results. The default value is
CREATION_TIME. - SortOrder
-
- Type: string
The sort order for results. The default value is
Ascending.
Result Syntax
[
'ClusterNodeSummaries' => [
[
'CurrentImageReleaseVersion' => '',
'ImageVersionStatus' => 'UpToDate|UpdateAvailable|SecurityUpdateRequired|EndOfLife',
'InstanceGroupName' => '',
'InstanceId' => '',
'InstanceStatus' => [
'Message' => '',
'Status' => 'Running|Failure|Pending|ShuttingDown|SystemUpdating|DeepHealthCheckInProgress|NotFound',
],
'InstanceType' => 'ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5.4xlarge|ml.p6e-gb200.36xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.c5n.large|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.gr6.4xlarge|ml.gr6.8xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.trn2.3xlarge|ml.trn2.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.i3en.large|ml.i3en.xlarge|ml.i3en.2xlarge|ml.i3en.3xlarge|ml.i3en.6xlarge|ml.i3en.12xlarge|ml.i3en.24xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.r5d.16xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.p6-b300.48xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.c6g.medium|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c7g.medium|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.c6a.large|ml.c6a.xlarge|ml.c6a.2xlarge|ml.c6a.4xlarge|ml.c6a.8xlarge|ml.c6a.12xlarge|ml.c6a.16xlarge|ml.c6a.24xlarge|ml.c6a.32xlarge|ml.c6a.48xlarge|ml.m6a.large|ml.m6a.xlarge|ml.m6a.2xlarge|ml.m6a.4xlarge|ml.m6a.8xlarge|ml.m6a.12xlarge|ml.m6a.16xlarge|ml.m6a.24xlarge|ml.m6a.32xlarge|ml.m6a.48xlarge|ml.m6g.medium|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m7g.medium|ml.m7g.large|ml.m7g.xlarge|ml.m7g.2xlarge|ml.m7g.4xlarge|ml.m7g.8xlarge|ml.m7g.12xlarge|ml.m7g.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.c8a.16xlarge|ml.m8a.16xlarge',
'LastSoftwareUpdateTime' => ,
'LaunchTime' => ,
'NodeLogicalId' => '',
'PrivateDnsHostname' => '',
'UltraServerInfo' => [
'Id' => '',
'Type' => '',
],
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- ClusterNodeSummaries
-
- Required: Yes
- Type: Array of ClusterNodeSummary structures
The summaries of listed instances in a SageMaker HyperPod cluster
- NextToken
-
- Type: string
The next token specified for listing instances in a SageMaker HyperPod cluster.
Errors
- ResourceNotFound:
Resource being access is not found.
ListClusterSchedulerConfigs
$result = $client->listClusterSchedulerConfigs([/* ... */]); $promise = $client->listClusterSchedulerConfigsAsync([/* ... */]);
List the cluster policy configurations.
Parameter Syntax
$result = $client->listClusterSchedulerConfigs([
'ClusterArn' => '',
'CreatedAfter' => ,
'CreatedBefore' => ,
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime|Status',
'SortOrder' => 'Ascending|Descending',
'Status' => 'Creating|CreateFailed|CreateRollbackFailed|Created|Updating|UpdateFailed|UpdateRollbackFailed|Updated|Deleting|DeleteFailed|DeleteRollbackFailed|Deleted',
]);
Parameter Details
Members
- ClusterArn
-
- Type: string
Filter for ARN of the cluster.
- CreatedAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Filter for after this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
- CreatedBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Filter for before this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
- MaxResults
-
- Type: int
The maximum number of cluster policies to list.
- NameContains
-
- Type: string
Filter for name containing this string.
- NextToken
-
- Type: string
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
- SortBy
-
- Type: string
Filter for sorting the list by a given value. For example, sort by name, creation time, or status.
- SortOrder
-
- Type: string
The order of the list. By default, listed in
Descendingorder according to bySortBy. To change the list order, you can specifySortOrderto beAscending. - Status
-
- Type: string
Filter for status.
Result Syntax
[
'ClusterSchedulerConfigSummaries' => [
[
'ClusterArn' => '',
'ClusterSchedulerConfigArn' => '',
'ClusterSchedulerConfigId' => '',
'ClusterSchedulerConfigVersion' => ,
'CreationTime' => ,
'LastModifiedTime' => ,
'Name' => '',
'Status' => 'Creating|CreateFailed|CreateRollbackFailed|Created|Updating|UpdateFailed|UpdateRollbackFailed|Updated|Deleting|DeleteFailed|DeleteRollbackFailed|Deleted',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- ClusterSchedulerConfigSummaries
-
- Type: Array of ClusterSchedulerConfigSummary structures
Summaries of the cluster policies.
- NextToken
-
- Type: string
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
Errors
There are no errors described for this operation.
ListClusters
$result = $client->listClusters([/* ... */]); $promise = $client->listClustersAsync([/* ... */]);
Retrieves the list of SageMaker HyperPod clusters.
Parameter Syntax
$result = $client->listClusters([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'CREATION_TIME|NAME',
'SortOrder' => 'Ascending|Descending',
'TrainingPlanArn' => '',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Set a start time for the time range during which you want to list SageMaker HyperPod clusters. Timestamps are formatted according to the ISO 8601 standard.
Acceptable formats include:
-
YYYY-MM-DDThh:mm:ss.sssTZD(UTC), for example,2014-10-01T20:30:00.000Z -
YYYY-MM-DDThh:mm:ss.sssTZD(with offset), for example,2014-10-01T12:30:00.000-08:00 -
YYYY-MM-DD, for example,2014-10-01 -
Unix time in seconds, for example,
1412195400. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.
For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for
CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide. - MaxResults
-
- Type: int
Specifies the maximum number of clusters to evaluate for the operation (not necessarily the number of matching items). After SageMaker processes the number of clusters up to
MaxResults, it stops the operation and returns the matching clusters up to that point. If all the matching clusters are desired, SageMaker will go through all the clusters untilNextTokenis empty. - NameContains
-
- Type: string
Set the maximum number of instances to print in the list.
- NextToken
-
- Type: string
Set the next token to retrieve the list of SageMaker HyperPod clusters.
- SortBy
-
- Type: string
The field by which to sort results. The default value is
CREATION_TIME. - SortOrder
-
- Type: string
The sort order for results. The default value is
Ascending. - TrainingPlanArn
-
- Type: string
The Amazon Resource Name (ARN); of the training plan to filter clusters by. For more information about reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see
CreateTrainingPlan.
Result Syntax
[
'ClusterSummaries' => [
[
'ClusterArn' => '',
'ClusterName' => '',
'ClusterStatus' => 'Creating|Deleting|Failed|InService|RollingBack|SystemUpdating|Updating',
'CreationTime' => ,
'ImageVersionStatus' => 'UpToDate|UpdateAvailable|SecurityUpdateRequired|EndOfLife',
'TrainingPlanArns' => ['', ...],
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- ClusterSummaries
-
- Required: Yes
- Type: Array of ClusterSummary structures
The summaries of listed SageMaker HyperPod clusters.
- NextToken
-
- Type: string
If the result of the previous
ListClustersrequest was truncated, the response includes aNextToken. To retrieve the next set of clusters, use the token in the next request.
Errors
There are no errors described for this operation.
ListCodeRepositories
$result = $client->listCodeRepositories([/* ... */]); $promise = $client->listCodeRepositoriesAsync([/* ... */]);
Gets a list of the Git repositories in your account.
Parameter Syntax
$result = $client->listCodeRepositories([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'LastModifiedTimeAfter' => ,
'LastModifiedTimeBefore' => ,
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime|LastModifiedTime',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only Git repositories that were created after the specified time.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only Git repositories that were created before the specified time.
- LastModifiedTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only Git repositories that were last modified after the specified time.
- LastModifiedTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only Git repositories that were last modified before the specified time.
- MaxResults
-
- Type: int
The maximum number of Git repositories to return in the response.
- NameContains
-
- Type: string
A string in the Git repositories name. This filter returns only repositories whose name contains the specified string.
- NextToken
-
- Type: string
If the result of a
ListCodeRepositoriesOutputrequest was truncated, the response includes aNextToken. To get the next set of Git repositories, use the token in the next request. - SortBy
-
- Type: string
The field to sort results by. The default is
Name. - SortOrder
-
- Type: string
The sort order for results. The default is
Ascending.
Result Syntax
[
'CodeRepositorySummaryList' => [
[
'CodeRepositoryArn' => '',
'CodeRepositoryName' => '',
'CreationTime' => ,
'GitConfig' => [
'Branch' => '',
'RepositoryUrl' => '',
'SecretArn' => '',
],
'LastModifiedTime' => ,
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- CodeRepositorySummaryList
-
- Required: Yes
- Type: Array of CodeRepositorySummary structures
Gets a list of summaries of the Git repositories. Each summary specifies the following values for the repository:
-
Name
-
Amazon Resource Name (ARN)
-
Creation time
-
Last modified time
-
Configuration information, including the URL location of the repository and the ARN of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository.
- NextToken
-
- Type: string
If the result of a
ListCodeRepositoriesOutputrequest was truncated, the response includes aNextToken. To get the next set of Git repositories, use the token in the next request.
Errors
There are no errors described for this operation.
ListCompilationJobs
$result = $client->listCompilationJobs([/* ... */]); $promise = $client->listCompilationJobsAsync([/* ... */]);
Lists model compilation jobs that satisfy various filters.
To create a model compilation job, use CreateCompilationJob. To get information about a particular model compilation job you have created, use DescribeCompilationJob.
Parameter Syntax
$result = $client->listCompilationJobs([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'LastModifiedTimeAfter' => ,
'LastModifiedTimeBefore' => ,
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime|Status',
'SortOrder' => 'Ascending|Descending',
'StatusEquals' => 'INPROGRESS|COMPLETED|FAILED|STARTING|STOPPING|STOPPED',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns the model compilation jobs that were created after a specified time.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns the model compilation jobs that were created before a specified time.
- LastModifiedTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns the model compilation jobs that were modified after a specified time.
- LastModifiedTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns the model compilation jobs that were modified before a specified time.
- MaxResults
-
- Type: int
The maximum number of model compilation jobs to return in the response.
- NameContains
-
- Type: string
A filter that returns the model compilation jobs whose name contains a specified string.
- NextToken
-
- Type: string
If the result of the previous
ListCompilationJobsrequest was truncated, the response includes aNextToken. To retrieve the next set of model compilation jobs, use the token in the next request. - SortBy
-
- Type: string
The field by which to sort results. The default is
CreationTime. - SortOrder
-
- Type: string
The sort order for results. The default is
Ascending. - StatusEquals
-
- Type: string
A filter that retrieves model compilation jobs with a specific
CompilationJobStatusstatus.
Result Syntax
[
'CompilationJobSummaries' => [
[
'CompilationEndTime' => ,
'CompilationJobArn' => '',
'CompilationJobName' => '',
'CompilationJobStatus' => 'INPROGRESS|COMPLETED|FAILED|STARTING|STOPPING|STOPPED',
'CompilationStartTime' => ,
'CompilationTargetDevice' => 'lambda|ml_m4|ml_m5|ml_m6g|ml_c4|ml_c5|ml_c6g|ml_p2|ml_p3|ml_g4dn|ml_inf1|ml_inf2|ml_trn1|ml_eia2|jetson_tx1|jetson_tx2|jetson_nano|jetson_xavier|rasp3b|rasp4b|imx8qm|deeplens|rk3399|rk3288|aisage|sbe_c|qcs605|qcs603|sitara_am57x|amba_cv2|amba_cv22|amba_cv25|x86_win32|x86_win64|coreml|jacinto_tda4vm|imx8mplus',
'CompilationTargetPlatformAccelerator' => 'INTEL_GRAPHICS|MALI|NVIDIA|NNA',
'CompilationTargetPlatformArch' => 'X86_64|X86|ARM64|ARM_EABI|ARM_EABIHF',
'CompilationTargetPlatformOs' => 'ANDROID|LINUX',
'CreationTime' => ,
'LastModifiedTime' => ,
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- CompilationJobSummaries
-
- Required: Yes
- Type: Array of CompilationJobSummary structures
An array of CompilationJobSummary objects, each describing a model compilation job.
- NextToken
-
- Type: string
If the response is truncated, Amazon SageMaker AI returns this
NextToken. To retrieve the next set of model compilation jobs, use this token in the next request.
Errors
There are no errors described for this operation.
ListComputeQuotas
$result = $client->listComputeQuotas([/* ... */]); $promise = $client->listComputeQuotasAsync([/* ... */]);
List the resource allocation definitions.
Parameter Syntax
$result = $client->listComputeQuotas([
'ClusterArn' => '',
'CreatedAfter' => ,
'CreatedBefore' => ,
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime|Status|ClusterArn',
'SortOrder' => 'Ascending|Descending',
'Status' => 'Creating|CreateFailed|CreateRollbackFailed|Created|Updating|UpdateFailed|UpdateRollbackFailed|Updated|Deleting|DeleteFailed|DeleteRollbackFailed|Deleted',
]);
Parameter Details
Members
- ClusterArn
-
- Type: string
Filter for ARN of the cluster.
- CreatedAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Filter for after this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
- CreatedBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Filter for before this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
- MaxResults
-
- Type: int
The maximum number of compute allocation definitions to list.
- NameContains
-
- Type: string
Filter for name containing this string.
- NextToken
-
- Type: string
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
- SortBy
-
- Type: string
Filter for sorting the list by a given value. For example, sort by name, creation time, or status.
- SortOrder
-
- Type: string
The order of the list. By default, listed in
Descendingorder according to bySortBy. To change the list order, you can specifySortOrderto beAscending. - Status
-
- Type: string
Filter for status.
Result Syntax
[
'ComputeQuotaSummaries' => [
[
'ActivationState' => 'Enabled|Disabled',
'ClusterArn' => '',
'ComputeQuotaArn' => '',
'ComputeQuotaConfig' => [
'ComputeQuotaResources' => [
[
'AcceleratorPartition' => [
'Count' => ,
'Type' => 'mig-1g.5gb|mig-1g.10gb|mig-1g.18gb|mig-1g.20gb|mig-1g.23gb|mig-1g.35gb|mig-1g.45gb|mig-1g.47gb|mig-2g.10gb|mig-2g.20gb|mig-2g.35gb|mig-2g.45gb|mig-2g.47gb|mig-3g.20gb|mig-3g.40gb|mig-3g.71gb|mig-3g.90gb|mig-3g.93gb|mig-4g.20gb|mig-4g.40gb|mig-4g.71gb|mig-4g.90gb|mig-4g.93gb|mig-7g.40gb|mig-7g.80gb|mig-7g.141gb|mig-7g.180gb|mig-7g.186gb',
],
'Accelerators' => ,
'Count' => ,
'InstanceType' => 'ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5.4xlarge|ml.p6e-gb200.36xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.c5n.large|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.gr6.4xlarge|ml.gr6.8xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.trn2.3xlarge|ml.trn2.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.i3en.large|ml.i3en.xlarge|ml.i3en.2xlarge|ml.i3en.3xlarge|ml.i3en.6xlarge|ml.i3en.12xlarge|ml.i3en.24xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.r5d.16xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.p6-b300.48xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.c6g.medium|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c7g.medium|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.c6a.large|ml.c6a.xlarge|ml.c6a.2xlarge|ml.c6a.4xlarge|ml.c6a.8xlarge|ml.c6a.12xlarge|ml.c6a.16xlarge|ml.c6a.24xlarge|ml.c6a.32xlarge|ml.c6a.48xlarge|ml.m6a.large|ml.m6a.xlarge|ml.m6a.2xlarge|ml.m6a.4xlarge|ml.m6a.8xlarge|ml.m6a.12xlarge|ml.m6a.16xlarge|ml.m6a.24xlarge|ml.m6a.32xlarge|ml.m6a.48xlarge|ml.m6g.medium|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m7g.medium|ml.m7g.large|ml.m7g.xlarge|ml.m7g.2xlarge|ml.m7g.4xlarge|ml.m7g.8xlarge|ml.m7g.12xlarge|ml.m7g.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.c8a.16xlarge|ml.m8a.16xlarge',
'MemoryInGiB' => ,
'VCpu' => ,
],
// ...
],
'PreemptTeamTasks' => 'Never|LowerPriority',
'ResourceSharingConfig' => [
'AbsoluteBorrowLimits' => [
[
'AcceleratorPartition' => [
'Count' => ,
'Type' => 'mig-1g.5gb|mig-1g.10gb|mig-1g.18gb|mig-1g.20gb|mig-1g.23gb|mig-1g.35gb|mig-1g.45gb|mig-1g.47gb|mig-2g.10gb|mig-2g.20gb|mig-2g.35gb|mig-2g.45gb|mig-2g.47gb|mig-3g.20gb|mig-3g.40gb|mig-3g.71gb|mig-3g.90gb|mig-3g.93gb|mig-4g.20gb|mig-4g.40gb|mig-4g.71gb|mig-4g.90gb|mig-4g.93gb|mig-7g.40gb|mig-7g.80gb|mig-7g.141gb|mig-7g.180gb|mig-7g.186gb',
],
'Accelerators' => ,
'Count' => ,
'InstanceType' => 'ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5.4xlarge|ml.p6e-gb200.36xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.12xlarge|ml.c5.18xlarge|ml.c5.24xlarge|ml.c5n.large|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.8xlarge|ml.m5.12xlarge|ml.m5.16xlarge|ml.m5.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.16xlarge|ml.g6.12xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.gr6.4xlarge|ml.gr6.8xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.16xlarge|ml.g6e.12xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.p6-b200.48xlarge|ml.trn2.3xlarge|ml.trn2.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.i3en.large|ml.i3en.xlarge|ml.i3en.2xlarge|ml.i3en.3xlarge|ml.i3en.6xlarge|ml.i3en.12xlarge|ml.i3en.24xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.r5d.16xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.p6-b300.48xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.c6g.medium|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c7g.medium|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.c6a.large|ml.c6a.xlarge|ml.c6a.2xlarge|ml.c6a.4xlarge|ml.c6a.8xlarge|ml.c6a.12xlarge|ml.c6a.16xlarge|ml.c6a.24xlarge|ml.c6a.32xlarge|ml.c6a.48xlarge|ml.m6a.large|ml.m6a.xlarge|ml.m6a.2xlarge|ml.m6a.4xlarge|ml.m6a.8xlarge|ml.m6a.12xlarge|ml.m6a.16xlarge|ml.m6a.24xlarge|ml.m6a.32xlarge|ml.m6a.48xlarge|ml.m6g.medium|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m7g.medium|ml.m7g.large|ml.m7g.xlarge|ml.m7g.2xlarge|ml.m7g.4xlarge|ml.m7g.8xlarge|ml.m7g.12xlarge|ml.m7g.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.c8a.16xlarge|ml.m8a.16xlarge',
'MemoryInGiB' => ,
'VCpu' => ,
],
// ...
],
'BorrowLimit' => ,
'Strategy' => 'Lend|DontLend|LendAndBorrow',
],
],
'ComputeQuotaId' => '',
'ComputeQuotaTarget' => [
'FairShareWeight' => ,
'TeamName' => '',
],
'ComputeQuotaVersion' => ,
'CreationTime' => ,
'LastModifiedTime' => ,
'Name' => '',
'Status' => 'Creating|CreateFailed|CreateRollbackFailed|Created|Updating|UpdateFailed|UpdateRollbackFailed|Updated|Deleting|DeleteFailed|DeleteRollbackFailed|Deleted',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- ComputeQuotaSummaries
-
- Type: Array of ComputeQuotaSummary structures
Summaries of the compute allocation definitions.
- NextToken
-
- Type: string
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
Errors
There are no errors described for this operation.
ListContexts
$result = $client->listContexts([/* ... */]); $promise = $client->listContextsAsync([/* ... */]);
Lists the contexts in your account and their properties.
Parameter Syntax
$result = $client->listContexts([
'ContextType' => '',
'CreatedAfter' => ,
'CreatedBefore' => ,
'MaxResults' => ,
'NextToken' => '',
'SortBy' => 'Name|CreationTime',
'SortOrder' => 'Ascending|Descending',
'SourceUri' => '',
]);
Parameter Details
Members
- ContextType
-
- Type: string
A filter that returns only contexts of the specified type.
- CreatedAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only contexts created on or after the specified time.
- CreatedBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only contexts created on or before the specified time.
- MaxResults
-
- Type: int
The maximum number of contexts to return in the response. The default value is 10.
- NextToken
-
- Type: string
If the previous call to
ListContextsdidn't return the full set of contexts, the call returns a token for getting the next set of contexts. - SortBy
-
- Type: string
The property used to sort results. The default value is
CreationTime. - SortOrder
-
- Type: string
The sort order. The default value is
Descending. - SourceUri
-
- Type: string
A filter that returns only contexts with the specified source URI.
Result Syntax
[
'ContextSummaries' => [
[
'ContextArn' => '',
'ContextName' => '',
'ContextType' => '',
'CreationTime' => ,
'LastModifiedTime' => ,
'Source' => [
'SourceId' => '',
'SourceType' => '',
'SourceUri' => '',
],
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- ContextSummaries
-
- Type: Array of ContextSummary structures
A list of contexts and their properties.
- NextToken
-
- Type: string
A token for getting the next set of contexts, if there are any.
Errors
- ResourceNotFound:
Resource being access is not found.
ListDataQualityJobDefinitions
$result = $client->listDataQualityJobDefinitions([/* ... */]); $promise = $client->listDataQualityJobDefinitionsAsync([/* ... */]);
Lists the data quality job definitions in your account.
Parameter Syntax
$result = $client->listDataQualityJobDefinitions([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'EndpointName' => '',
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only data quality monitoring job definitions created after the specified time.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only data quality monitoring job definitions created before the specified time.
- EndpointName
-
- Type: string
A filter that lists the data quality job definitions associated with the specified endpoint.
- MaxResults
-
- Type: int
The maximum number of data quality monitoring job definitions to return in the response.
- NameContains
-
- Type: string
A string in the data quality monitoring job definition name. This filter returns only data quality monitoring job definitions whose name contains the specified string.
- NextToken
-
- Type: string
If the result of the previous
ListDataQualityJobDefinitionsrequest was truncated, the response includes aNextToken. To retrieve the next set of transform jobs, use the token in the next request.> - SortBy
-
- Type: string
The field to sort results by. The default is
CreationTime. - SortOrder
-
- Type: string
Whether to sort the results in
AscendingorDescendingorder. The default isDescending.
Result Syntax
[
'JobDefinitionSummaries' => [
[
'CreationTime' => ,
'EndpointName' => '',
'MonitoringJobDefinitionArn' => '',
'MonitoringJobDefinitionName' => '',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- JobDefinitionSummaries
-
- Required: Yes
- Type: Array of MonitoringJobDefinitionSummary structures
A list of data quality monitoring job definitions.
- NextToken
-
- Type: string
If the result of the previous
ListDataQualityJobDefinitionsrequest was truncated, the response includes aNextToken. To retrieve the next set of data quality monitoring job definitions, use the token in the next request.
Errors
There are no errors described for this operation.
ListDeviceFleets
$result = $client->listDeviceFleets([/* ... */]); $promise = $client->listDeviceFleetsAsync([/* ... */]);
Returns a list of devices in the fleet.
Parameter Syntax
$result = $client->listDeviceFleets([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'LastModifiedTimeAfter' => ,
'LastModifiedTimeBefore' => ,
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'NAME|CREATION_TIME|LAST_MODIFIED_TIME',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Filter fleets where packaging job was created after specified time.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Filter fleets where the edge packaging job was created before specified time.
- LastModifiedTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Select fleets where the job was updated after X
- LastModifiedTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Select fleets where the job was updated before X
- MaxResults
-
- Type: int
The maximum number of results to select.
- NameContains
-
- Type: string
Filter for fleets containing this name in their fleet device name.
- NextToken
-
- Type: string
The response from the last list when returning a list large enough to need tokening.
- SortBy
-
- Type: string
The column to sort by.
- SortOrder
-
- Type: string
What direction to sort in.
Result Syntax
[
'DeviceFleetSummaries' => [
[
'CreationTime' => ,
'DeviceFleetArn' => '',
'DeviceFleetName' => '',
'LastModifiedTime' => ,
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- DeviceFleetSummaries
-
- Required: Yes
- Type: Array of DeviceFleetSummary structures
Summary of the device fleet.
- NextToken
-
- Type: string
The response from the last list when returning a list large enough to need tokening.
Errors
There are no errors described for this operation.
ListDevices
$result = $client->listDevices([/* ... */]); $promise = $client->listDevicesAsync([/* ... */]);
A list of devices.
Parameter Syntax
$result = $client->listDevices([
'DeviceFleetName' => '',
'LatestHeartbeatAfter' => ,
'MaxResults' => ,
'ModelName' => '',
'NextToken' => '',
]);
Parameter Details
Members
- DeviceFleetName
-
- Type: string
Filter for fleets containing this name in their device fleet name.
- LatestHeartbeatAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Select fleets where the job was updated after X
- MaxResults
-
- Type: int
Maximum number of results to select.
- ModelName
-
- Type: string
A filter that searches devices that contains this name in any of their models.
- NextToken
-
- Type: string
The response from the last list when returning a list large enough to need tokening.
Result Syntax
[
'DeviceSummaries' => [
[
'AgentVersion' => '',
'Description' => '',
'DeviceArn' => '',
'DeviceFleetName' => '',
'DeviceName' => '',
'IotThingName' => '',
'LatestHeartbeat' => ,
'Models' => [
[
'ModelName' => '',
'ModelVersion' => '',
],
// ...
],
'RegistrationTime' => ,
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- DeviceSummaries
-
- Required: Yes
- Type: Array of DeviceSummary structures
Summary of devices.
- NextToken
-
- Type: string
The response from the last list when returning a list large enough to need tokening.
Errors
There are no errors described for this operation.
ListDomains
$result = $client->listDomains([/* ... */]); $promise = $client->listDomainsAsync([/* ... */]);
Lists the domains.
Parameter Syntax
$result = $client->listDomains([
'MaxResults' => ,
'NextToken' => '',
]);
Parameter Details
Members
- MaxResults
-
- Type: int
This parameter defines the maximum number of results that can be return in a single response. The
MaxResultsparameter is an upper bound, not a target. If there are more results available than the value specified, aNextTokenis provided in the response. TheNextTokenindicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value forMaxResultsis 10. - NextToken
-
- Type: string
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
Result Syntax
[
'Domains' => [
[
'CreationTime' => ,
'DomainArn' => '',
'DomainId' => '',
'DomainName' => '',
'LastModifiedTime' => ,
'Status' => 'Deleting|Failed|InService|Pending|Updating|Update_Failed|Delete_Failed',
'Url' => '',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- Domains
-
- Type: Array of DomainDetails structures
The list of domains.
- NextToken
-
- Type: string
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
Errors
There are no errors described for this operation.
ListEdgeDeploymentPlans
$result = $client->listEdgeDeploymentPlans([/* ... */]); $promise = $client->listEdgeDeploymentPlansAsync([/* ... */]);
Lists all edge deployment plans.
Parameter Syntax
$result = $client->listEdgeDeploymentPlans([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'DeviceFleetNameContains' => '',
'LastModifiedTimeAfter' => ,
'LastModifiedTimeBefore' => ,
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'NAME|DEVICE_FLEET_NAME|CREATION_TIME|LAST_MODIFIED_TIME',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Selects edge deployment plans created after this time.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Selects edge deployment plans created before this time.
- DeviceFleetNameContains
-
- Type: string
Selects edge deployment plans with a device fleet name containing this name.
- LastModifiedTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Selects edge deployment plans that were last updated after this time.
- LastModifiedTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Selects edge deployment plans that were last updated before this time.
- MaxResults
-
- Type: int
The maximum number of results to select (50 by default).
- NameContains
-
- Type: string
Selects edge deployment plans with names containing this name.
- NextToken
-
- Type: string
The response from the last list when returning a list large enough to need tokening.
- SortBy
-
- Type: string
The column by which to sort the edge deployment plans. Can be one of
NAME,DEVICEFLEETNAME,CREATIONTIME,LASTMODIFIEDTIME. - SortOrder
-
- Type: string
The direction of the sorting (ascending or descending).
Result Syntax
[
'EdgeDeploymentPlanSummaries' => [
[
'CreationTime' => ,
'DeviceFleetName' => '',
'EdgeDeploymentFailed' => ,
'EdgeDeploymentPending' => ,
'EdgeDeploymentPlanArn' => '',
'EdgeDeploymentPlanName' => '',
'EdgeDeploymentSuccess' => ,
'LastModifiedTime' => ,
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- EdgeDeploymentPlanSummaries
-
- Required: Yes
- Type: Array of EdgeDeploymentPlanSummary structures
List of summaries of edge deployment plans.
- NextToken
-
- Type: string
The token to use when calling the next page of results.
Errors
There are no errors described for this operation.
ListEdgePackagingJobs
$result = $client->listEdgePackagingJobs([/* ... */]); $promise = $client->listEdgePackagingJobsAsync([/* ... */]);
Returns a list of edge packaging jobs.
Parameter Syntax
$result = $client->listEdgePackagingJobs([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'LastModifiedTimeAfter' => ,
'LastModifiedTimeBefore' => ,
'MaxResults' => ,
'ModelNameContains' => '',
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'NAME|MODEL_NAME|CREATION_TIME|LAST_MODIFIED_TIME|STATUS',
'SortOrder' => 'Ascending|Descending',
'StatusEquals' => 'STARTING|INPROGRESS|COMPLETED|FAILED|STOPPING|STOPPED',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Select jobs where the job was created after specified time.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Select jobs where the job was created before specified time.
- LastModifiedTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Select jobs where the job was updated after specified time.
- LastModifiedTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Select jobs where the job was updated before specified time.
- MaxResults
-
- Type: int
Maximum number of results to select.
- ModelNameContains
-
- Type: string
Filter for jobs where the model name contains this string.
- NameContains
-
- Type: string
Filter for jobs containing this name in their packaging job name.
- NextToken
-
- Type: string
The response from the last list when returning a list large enough to need tokening.
- SortBy
-
- Type: string
Use to specify what column to sort by.
- SortOrder
-
- Type: string
What direction to sort by.
- StatusEquals
-
- Type: string
The job status to filter for.
Result Syntax
[
'EdgePackagingJobSummaries' => [
[
'CompilationJobName' => '',
'CreationTime' => ,
'EdgePackagingJobArn' => '',
'EdgePackagingJobName' => '',
'EdgePackagingJobStatus' => 'STARTING|INPROGRESS|COMPLETED|FAILED|STOPPING|STOPPED',
'LastModifiedTime' => ,
'ModelName' => '',
'ModelVersion' => '',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- EdgePackagingJobSummaries
-
- Required: Yes
- Type: Array of EdgePackagingJobSummary structures
Summaries of edge packaging jobs.
- NextToken
-
- Type: string
Token to use when calling the next page of results.
Errors
There are no errors described for this operation.
ListEndpointConfigs
$result = $client->listEndpointConfigs([/* ... */]); $promise = $client->listEndpointConfigsAsync([/* ... */]);
Lists endpoint configurations.
Parameter Syntax
$result = $client->listEndpointConfigs([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only endpoint configurations with a creation time greater than or equal to the specified time (timestamp).
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only endpoint configurations created before the specified time (timestamp).
- MaxResults
-
- Type: int
The maximum number of training jobs to return in the response.
- NameContains
-
- Type: string
A string in the endpoint configuration name. This filter returns only endpoint configurations whose name contains the specified string.
- NextToken
-
- Type: string
If the result of the previous
ListEndpointConfigrequest was truncated, the response includes aNextToken. To retrieve the next set of endpoint configurations, use the token in the next request. - SortBy
-
- Type: string
The field to sort results by. The default is
CreationTime. - SortOrder
-
- Type: string
The sort order for results. The default is
Descending.
Result Syntax
[
'EndpointConfigs' => [
[
'CreationTime' => ,
'EndpointConfigArn' => '',
'EndpointConfigName' => '',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- EndpointConfigs
-
- Required: Yes
- Type: Array of EndpointConfigSummary structures
An array of endpoint configurations.
- NextToken
-
- Type: string
If the response is truncated, SageMaker returns this token. To retrieve the next set of endpoint configurations, use it in the subsequent request
Errors
There are no errors described for this operation.
ListEndpoints
$result = $client->listEndpoints([/* ... */]); $promise = $client->listEndpointsAsync([/* ... */]);
Lists endpoints.
Parameter Syntax
$result = $client->listEndpoints([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'LastModifiedTimeAfter' => ,
'LastModifiedTimeBefore' => ,
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime|Status',
'SortOrder' => 'Ascending|Descending',
'StatusEquals' => 'OutOfService|Creating|Updating|SystemUpdating|RollingBack|InService|Deleting|Failed|UpdateRollbackFailed',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only endpoints with a creation time greater than or equal to the specified time (timestamp).
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only endpoints that were created before the specified time (timestamp).
- LastModifiedTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only endpoints that were modified after the specified timestamp.
- LastModifiedTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only endpoints that were modified before the specified timestamp.
- MaxResults
-
- Type: int
The maximum number of endpoints to return in the response. This value defaults to 10.
- NameContains
-
- Type: string
A string in endpoint names. This filter returns only endpoints whose name contains the specified string.
- NextToken
-
- Type: string
If the result of a
ListEndpointsrequest was truncated, the response includes aNextToken. To retrieve the next set of endpoints, use the token in the next request. - SortBy
-
- Type: string
Sorts the list of results. The default is
CreationTime. - SortOrder
-
- Type: string
The sort order for results. The default is
Descending. - StatusEquals
-
- Type: string
A filter that returns only endpoints with the specified status.
Result Syntax
[
'Endpoints' => [
[
'CreationTime' => ,
'EndpointArn' => '',
'EndpointName' => '',
'EndpointStatus' => 'OutOfService|Creating|Updating|SystemUpdating|RollingBack|InService|Deleting|Failed|UpdateRollbackFailed',
'LastModifiedTime' => ,
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- Endpoints
-
- Required: Yes
- Type: Array of EndpointSummary structures
An array or endpoint objects.
- NextToken
-
- Type: string
If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.
Errors
There are no errors described for this operation.
ListExperiments
$result = $client->listExperiments([/* ... */]); $promise = $client->listExperimentsAsync([/* ... */]);
Lists all the experiments in your account. The list can be filtered to show only experiments that were created in a specific time range. The list can be sorted by experiment name or creation time.
Parameter Syntax
$result = $client->listExperiments([
'CreatedAfter' => ,
'CreatedBefore' => ,
'MaxResults' => ,
'NextToken' => '',
'SortBy' => 'Name|CreationTime',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- CreatedAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only experiments created after the specified time.
- CreatedBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only experiments created before the specified time.
- MaxResults
-
- Type: int
The maximum number of experiments to return in the response. The default value is 10.
- NextToken
-
- Type: string
If the previous call to
ListExperimentsdidn't return the full set of experiments, the call returns a token for getting the next set of experiments. - SortBy
-
- Type: string
The property used to sort results. The default value is
CreationTime. - SortOrder
-
- Type: string
The sort order. The default value is
Descending.
Result Syntax
[
'ExperimentSummaries' => [
[
'CreationTime' => ,
'DisplayName' => '',
'ExperimentArn' => '',
'ExperimentName' => '',
'ExperimentSource' => [
'SourceArn' => '',
'SourceType' => '',
],
'LastModifiedTime' => ,
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- ExperimentSummaries
-
- Type: Array of ExperimentSummary structures
A list of the summaries of your experiments.
- NextToken
-
- Type: string
A token for getting the next set of experiments, if there are any.
Errors
There are no errors described for this operation.
ListFeatureGroups
$result = $client->listFeatureGroups([/* ... */]); $promise = $client->listFeatureGroupsAsync([/* ... */]);
List FeatureGroups based on given filter and order.
Parameter Syntax
$result = $client->listFeatureGroups([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'FeatureGroupStatusEquals' => 'Creating|Created|CreateFailed|Deleting|DeleteFailed',
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'OfflineStoreStatusEquals' => 'Active|Blocked|Disabled',
'SortBy' => 'Name|FeatureGroupStatus|OfflineStoreStatus|CreationTime',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Use this parameter to search for
FeatureGroupss created after a specific date and time. - CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Use this parameter to search for
FeatureGroupss created before a specific date and time. - FeatureGroupStatusEquals
-
- Type: string
A
FeatureGroupstatus. Filters byFeatureGroupstatus. - MaxResults
-
- Type: int
The maximum number of results returned by
ListFeatureGroups. - NameContains
-
- Type: string
A string that partially matches one or more
FeatureGroups names. FiltersFeatureGroups by name. - NextToken
-
- Type: string
A token to resume pagination of
ListFeatureGroupsresults. - OfflineStoreStatusEquals
-
- Type: string
An
OfflineStorestatus. Filters byOfflineStorestatus. - SortBy
-
- Type: string
The value on which the feature group list is sorted.
- SortOrder
-
- Type: string
The order in which feature groups are listed.
Result Syntax
[
'FeatureGroupSummaries' => [
[
'CreationTime' => ,
'FeatureGroupArn' => '',
'FeatureGroupName' => '',
'FeatureGroupStatus' => 'Creating|Created|CreateFailed|Deleting|DeleteFailed',
'OfflineStoreStatus' => [
'BlockedReason' => '',
'Status' => 'Active|Blocked|Disabled',
],
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- FeatureGroupSummaries
-
- Required: Yes
- Type: Array of FeatureGroupSummary structures
A summary of feature groups.
- NextToken
-
- Type: string
A token to resume pagination of
ListFeatureGroupsresults.
Errors
There are no errors described for this operation.
ListFlowDefinitions
$result = $client->listFlowDefinitions([/* ... */]); $promise = $client->listFlowDefinitionsAsync([/* ... */]);
Returns information about the flow definitions in your account.
Parameter Syntax
$result = $client->listFlowDefinitions([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'MaxResults' => ,
'NextToken' => '',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only flow definitions with a creation time greater than or equal to the specified timestamp.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only flow definitions that were created before the specified timestamp.
- MaxResults
-
- Type: int
The total number of items to return. If the total number of available items is more than the value specified in
MaxResults, then aNextTokenwill be provided in the output that you can use to resume pagination. - NextToken
-
- Type: string
A token to resume pagination.
- SortOrder
-
- Type: string
An optional value that specifies whether you want the results sorted in
AscendingorDescendingorder.
Result Syntax
[
'FlowDefinitionSummaries' => [
[
'CreationTime' => ,
'FailureReason' => '',
'FlowDefinitionArn' => '',
'FlowDefinitionName' => '',
'FlowDefinitionStatus' => 'Initializing|Active|Failed|Deleting',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- FlowDefinitionSummaries
-
- Required: Yes
- Type: Array of FlowDefinitionSummary structures
An array of objects describing the flow definitions.
- NextToken
-
- Type: string
A token to resume pagination.
Errors
There are no errors described for this operation.
ListHubContentVersions
$result = $client->listHubContentVersions([/* ... */]); $promise = $client->listHubContentVersionsAsync([/* ... */]);
List hub content versions.
Parameter Syntax
$result = $client->listHubContentVersions([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'HubContentName' => '', // REQUIRED
'HubContentType' => 'Model|Notebook|ModelReference|DataSet|JsonDoc', // REQUIRED
'HubName' => '', // REQUIRED
'MaxResults' => ,
'MaxSchemaVersion' => '',
'MinVersion' => '',
'NextToken' => '',
'SortBy' => 'HubContentName|CreationTime|HubContentStatus',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Only list hub content versions that were created after the time specified.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Only list hub content versions that were created before the time specified.
- HubContentName
-
- Required: Yes
- Type: string
The name of the hub content.
- HubContentType
-
- Required: Yes
- Type: string
The type of hub content to list versions of.
- HubName
-
- Required: Yes
- Type: string
The name of the hub to list the content versions of.
- MaxResults
-
- Type: int
The maximum number of hub content versions to list.
- MaxSchemaVersion
-
- Type: string
The upper bound of the hub content schema version.
- MinVersion
-
- Type: string
The lower bound of the hub content versions to list.
- NextToken
-
- Type: string
If the response to a previous
ListHubContentVersionsrequest was truncated, the response includes aNextToken. To retrieve the next set of hub content versions, use the token in the next request. - SortBy
-
- Type: string
Sort hub content versions by either name or creation time.
- SortOrder
-
- Type: string
Sort hub content versions by ascending or descending order.
Result Syntax
[
'HubContentSummaries' => [
[
'CreationTime' => ,
'DocumentSchemaVersion' => '',
'HubContentArn' => '',
'HubContentDescription' => '',
'HubContentDisplayName' => '',
'HubContentName' => '',
'HubContentSearchKeywords' => ['', ...],
'HubContentStatus' => 'Available|Importing|Deleting|ImportFailed|DeleteFailed|PendingImport|PendingDelete',
'HubContentType' => 'Model|Notebook|ModelReference|DataSet|JsonDoc',
'HubContentVersion' => '',
'OriginalCreationTime' => ,
'SageMakerPublicHubContentArn' => '',
'SupportStatus' => 'Supported|Deprecated|Restricted',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- HubContentSummaries
-
- Required: Yes
- Type: Array of HubContentInfo structures
The summaries of the listed hub content versions.
- NextToken
-
- Type: string
If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content versions, use it in the subsequent request.
Errors
- ResourceNotFound:
Resource being access is not found.
ListHubContents
$result = $client->listHubContents([/* ... */]); $promise = $client->listHubContentsAsync([/* ... */]);
List the contents of a hub.
Parameter Syntax
$result = $client->listHubContents([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'HubContentType' => 'Model|Notebook|ModelReference|DataSet|JsonDoc', // REQUIRED
'HubName' => '', // REQUIRED
'MaxResults' => ,
'MaxSchemaVersion' => '',
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'HubContentName|CreationTime|HubContentStatus',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Only list hub content that was created after the time specified.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Only list hub content that was created before the time specified.
- HubContentType
-
- Required: Yes
- Type: string
The type of hub content to list.
- HubName
-
- Required: Yes
- Type: string
The name of the hub to list the contents of.
- MaxResults
-
- Type: int
The maximum amount of hub content to list.
- MaxSchemaVersion
-
- Type: string
The upper bound of the hub content schema verion.
- NameContains
-
- Type: string
Only list hub content if the name contains the specified string.
- NextToken
-
- Type: string
If the response to a previous
ListHubContentsrequest was truncated, the response includes aNextToken. To retrieve the next set of hub content, use the token in the next request. - SortBy
-
- Type: string
Sort hub content versions by either name or creation time.
- SortOrder
-
- Type: string
Sort hubs by ascending or descending order.
Result Syntax
[
'HubContentSummaries' => [
[
'CreationTime' => ,
'DocumentSchemaVersion' => '',
'HubContentArn' => '',
'HubContentDescription' => '',
'HubContentDisplayName' => '',
'HubContentName' => '',
'HubContentSearchKeywords' => ['', ...],
'HubContentStatus' => 'Available|Importing|Deleting|ImportFailed|DeleteFailed|PendingImport|PendingDelete',
'HubContentType' => 'Model|Notebook|ModelReference|DataSet|JsonDoc',
'HubContentVersion' => '',
'OriginalCreationTime' => ,
'SageMakerPublicHubContentArn' => '',
'SupportStatus' => 'Supported|Deprecated|Restricted',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- HubContentSummaries
-
- Required: Yes
- Type: Array of HubContentInfo structures
The summaries of the listed hub content.
- NextToken
-
- Type: string
If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content, use it in the subsequent request.
Errors
- ResourceNotFound:
Resource being access is not found.
ListHubs
$result = $client->listHubs([/* ... */]); $promise = $client->listHubsAsync([/* ... */]);
List all existing hubs.
Parameter Syntax
$result = $client->listHubs([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'LastModifiedTimeAfter' => ,
'LastModifiedTimeBefore' => ,
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'HubName|CreationTime|HubStatus|AccountIdOwner',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Only list hubs that were created after the time specified.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Only list hubs that were created before the time specified.
- LastModifiedTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Only list hubs that were last modified after the time specified.
- LastModifiedTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Only list hubs that were last modified before the time specified.
- MaxResults
-
- Type: int
The maximum number of hubs to list.
- NameContains
-
- Type: string
Only list hubs with names that contain the specified string.
- NextToken
-
- Type: string
If the response to a previous
ListHubsrequest was truncated, the response includes aNextToken. To retrieve the next set of hubs, use the token in the next request. - SortBy
-
- Type: string
Sort hubs by either name or creation time.
- SortOrder
-
- Type: string
Sort hubs by ascending or descending order.
Result Syntax
[
'HubSummaries' => [
[
'CreationTime' => ,
'HubArn' => '',
'HubDescription' => '',
'HubDisplayName' => '',
'HubName' => '',
'HubSearchKeywords' => ['', ...],
'HubStatus' => 'InService|Creating|Updating|Deleting|CreateFailed|UpdateFailed|DeleteFailed',
'LastModifiedTime' => ,
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- HubSummaries
-
- Required: Yes
- Type: Array of HubInfo structures
The summaries of the listed hubs.
- NextToken
-
- Type: string
If the response is truncated, SageMaker returns this token. To retrieve the next set of hubs, use it in the subsequent request.
Errors
There are no errors described for this operation.
ListHumanTaskUis
$result = $client->listHumanTaskUis([/* ... */]); $promise = $client->listHumanTaskUisAsync([/* ... */]);
Returns information about the human task user interfaces in your account.
Parameter Syntax
$result = $client->listHumanTaskUis([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'MaxResults' => ,
'NextToken' => '',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only human task user interfaces with a creation time greater than or equal to the specified timestamp.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only human task user interfaces that were created before the specified timestamp.
- MaxResults
-
- Type: int
The total number of items to return. If the total number of available items is more than the value specified in
MaxResults, then aNextTokenwill be provided in the output that you can use to resume pagination. - NextToken
-
- Type: string
A token to resume pagination.
- SortOrder
-
- Type: string
An optional value that specifies whether you want the results sorted in
AscendingorDescendingorder.
Result Syntax
[
'HumanTaskUiSummaries' => [
[
'CreationTime' => ,
'HumanTaskUiArn' => '',
'HumanTaskUiName' => '',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- HumanTaskUiSummaries
-
- Required: Yes
- Type: Array of HumanTaskUiSummary structures
An array of objects describing the human task user interfaces.
- NextToken
-
- Type: string
A token to resume pagination.
Errors
There are no errors described for this operation.
ListHyperParameterTuningJobs
$result = $client->listHyperParameterTuningJobs([/* ... */]); $promise = $client->listHyperParameterTuningJobsAsync([/* ... */]);
Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.
Parameter Syntax
$result = $client->listHyperParameterTuningJobs([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'LastModifiedTimeAfter' => ,
'LastModifiedTimeBefore' => ,
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|Status|CreationTime',
'SortOrder' => 'Ascending|Descending',
'StatusEquals' => 'Completed|InProgress|Failed|Stopped|Stopping|Deleting|DeleteFailed',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only tuning jobs that were created after the specified time.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only tuning jobs that were created before the specified time.
- LastModifiedTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only tuning jobs that were modified after the specified time.
- LastModifiedTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only tuning jobs that were modified before the specified time.
- MaxResults
-
- Type: int
The maximum number of tuning jobs to return. The default value is 10.
- NameContains
-
- Type: string
A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.
- NextToken
-
- Type: string
If the result of the previous
ListHyperParameterTuningJobsrequest was truncated, the response includes aNextToken. To retrieve the next set of tuning jobs, use the token in the next request. - SortBy
-
- Type: string
The field to sort results by. The default is
Name. - SortOrder
-
- Type: string
The sort order for results. The default is
Ascending. - StatusEquals
-
- Type: string
A filter that returns only tuning jobs with the specified status.
Result Syntax
[
'HyperParameterTuningJobSummaries' => [
[
'CreationTime' => ,
'HyperParameterTuningEndTime' => ,
'HyperParameterTuningJobArn' => '',
'HyperParameterTuningJobName' => '',
'HyperParameterTuningJobStatus' => 'Completed|InProgress|Failed|Stopped|Stopping|Deleting|DeleteFailed',
'LastModifiedTime' => ,
'ObjectiveStatusCounters' => [
'Failed' => ,
'Pending' => ,
'Succeeded' => ,
],
'ResourceLimits' => [
'MaxNumberOfTrainingJobs' => ,
'MaxParallelTrainingJobs' => ,
'MaxRuntimeInSeconds' => ,
],
'Strategy' => 'Bayesian|Random|Hyperband|Grid',
'TrainingJobStatusCounters' => [
'Completed' => ,
'InProgress' => ,
'NonRetryableError' => ,
'RetryableError' => ,
'Stopped' => ,
],
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- HyperParameterTuningJobSummaries
-
- Required: Yes
- Type: Array of HyperParameterTuningJobSummary structures
A list of HyperParameterTuningJobSummary objects that describe the tuning jobs that the
ListHyperParameterTuningJobsrequest returned. - NextToken
-
- Type: string
If the result of this
ListHyperParameterTuningJobsrequest was truncated, the response includes aNextToken. To retrieve the next set of tuning jobs, use the token in the next request.
Errors
There are no errors described for this operation.
ListImageVersions
$result = $client->listImageVersions([/* ... */]); $promise = $client->listImageVersionsAsync([/* ... */]);
Lists the versions of a specified image and their properties. The list can be filtered by creation time or modified time.
Parameter Syntax
$result = $client->listImageVersions([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'ImageName' => '', // REQUIRED
'LastModifiedTimeAfter' => ,
'LastModifiedTimeBefore' => ,
'MaxResults' => ,
'NextToken' => '',
'SortBy' => 'CREATION_TIME|LAST_MODIFIED_TIME|VERSION',
'SortOrder' => 'ASCENDING|DESCENDING',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only versions created on or after the specified time.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only versions created on or before the specified time.
- ImageName
-
- Required: Yes
- Type: string
The name of the image to list the versions of.
- LastModifiedTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only versions modified on or after the specified time.
- LastModifiedTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only versions modified on or before the specified time.
- MaxResults
-
- Type: int
The maximum number of versions to return in the response. The default value is 10.
- NextToken
-
- Type: string
If the previous call to
ListImageVersionsdidn't return the full set of versions, the call returns a token for getting the next set of versions. - SortBy
-
- Type: string
The property used to sort results. The default value is
CREATION_TIME. - SortOrder
-
- Type: string
The sort order. The default value is
DESCENDING.
Result Syntax
[
'ImageVersions' => [
[
'CreationTime' => ,
'FailureReason' => '',
'ImageArn' => '',
'ImageVersionArn' => '',
'ImageVersionStatus' => 'CREATING|CREATED|CREATE_FAILED|DELETING|DELETE_FAILED',
'LastModifiedTime' => ,
'Version' => ,
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- ImageVersions
-
- Type: Array of ImageVersion structures
A list of versions and their properties.
- NextToken
-
- Type: string
A token for getting the next set of versions, if there are any.
Errors
- ResourceNotFound:
Resource being access is not found.
ListImages
$result = $client->listImages([/* ... */]); $promise = $client->listImagesAsync([/* ... */]);
Lists the images in your account and their properties. The list can be filtered by creation time or modified time, and whether the image name contains a specified string.
Parameter Syntax
$result = $client->listImages([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'LastModifiedTimeAfter' => ,
'LastModifiedTimeBefore' => ,
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'CREATION_TIME|LAST_MODIFIED_TIME|IMAGE_NAME',
'SortOrder' => 'ASCENDING|DESCENDING',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only images created on or after the specified time.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only images created on or before the specified time.
- LastModifiedTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only images modified on or after the specified time.
- LastModifiedTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only images modified on or before the specified time.
- MaxResults
-
- Type: int
The maximum number of images to return in the response. The default value is 10.
- NameContains
-
- Type: string
A filter that returns only images whose name contains the specified string.
- NextToken
-
- Type: string
If the previous call to
ListImagesdidn't return the full set of images, the call returns a token for getting the next set of images. - SortBy
-
- Type: string
The property used to sort results. The default value is
CREATION_TIME. - SortOrder
-
- Type: string
The sort order. The default value is
DESCENDING.
Result Syntax
[
'Images' => [
[
'CreationTime' => ,
'Description' => '',
'DisplayName' => '',
'FailureReason' => '',
'ImageArn' => '',
'ImageName' => '',
'ImageStatus' => 'CREATING|CREATED|CREATE_FAILED|UPDATING|UPDATE_FAILED|DELETING|DELETE_FAILED',
'LastModifiedTime' => ,
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- Images
-
- Type: Array of Image structures
A list of images and their properties.
- NextToken
-
- Type: string
A token for getting the next set of images, if there are any.
Errors
There are no errors described for this operation.
ListInferenceComponents
$result = $client->listInferenceComponents([/* ... */]); $promise = $client->listInferenceComponentsAsync([/* ... */]);
Lists the inference components in your account and their properties.
Parameter Syntax
$result = $client->listInferenceComponents([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'EndpointNameEquals' => '',
'LastModifiedTimeAfter' => ,
'LastModifiedTimeBefore' => ,
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime|Status',
'SortOrder' => 'Ascending|Descending',
'StatusEquals' => 'InService|Creating|Updating|Failed|Deleting',
'VariantNameEquals' => '',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Filters the results to only those inference components that were created after the specified time.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Filters the results to only those inference components that were created before the specified time.
- EndpointNameEquals
-
- Type: string
An endpoint name to filter the listed inference components. The response includes only those inference components that are hosted at the specified endpoint.
- LastModifiedTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Filters the results to only those inference components that were updated after the specified time.
- LastModifiedTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Filters the results to only those inference components that were updated before the specified time.
- MaxResults
-
- Type: int
The maximum number of inference components to return in the response. This value defaults to 10.
- NameContains
-
- Type: string
Filters the results to only those inference components with a name that contains the specified string.
- NextToken
-
- Type: string
A token that you use to get the next set of results following a truncated response. If the response to the previous request was truncated, that response provides the value for this token.
- SortBy
-
- Type: string
The field by which to sort the inference components in the response. The default is
CreationTime. - SortOrder
-
- Type: string
The sort order for results. The default is
Descending. - StatusEquals
-
- Type: string
Filters the results to only those inference components with the specified status.
- VariantNameEquals
-
- Type: string
A production variant name to filter the listed inference components. The response includes only those inference components that are hosted at the specified variant.
Result Syntax
[
'InferenceComponents' => [
[
'CreationTime' => ,
'EndpointArn' => '',
'EndpointName' => '',
'InferenceComponentArn' => '',
'InferenceComponentName' => '',
'InferenceComponentStatus' => 'InService|Creating|Updating|Failed|Deleting',
'LastModifiedTime' => ,
'VariantName' => '',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- InferenceComponents
-
- Required: Yes
- Type: Array of InferenceComponentSummary structures
A list of inference components and their properties that matches any of the filters you specified in the request.
- NextToken
-
- Type: string
The token to use in a subsequent request to get the next set of results following a truncated response.
Errors
There are no errors described for this operation.
ListInferenceExperiments
$result = $client->listInferenceExperiments([/* ... */]); $promise = $client->listInferenceExperimentsAsync([/* ... */]);
Returns the list of all inference experiments.
Parameter Syntax
$result = $client->listInferenceExperiments([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'LastModifiedTimeAfter' => ,
'LastModifiedTimeBefore' => ,
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime|Status',
'SortOrder' => 'Ascending|Descending',
'StatusEquals' => 'Creating|Created|Updating|Running|Starting|Stopping|Completed|Cancelled',
'Type' => 'ShadowMode',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Selects inference experiments which were created after this timestamp.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Selects inference experiments which were created before this timestamp.
- LastModifiedTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Selects inference experiments which were last modified after this timestamp.
- LastModifiedTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Selects inference experiments which were last modified before this timestamp.
- MaxResults
-
- Type: int
The maximum number of results to select.
- NameContains
-
- Type: string
Selects inference experiments whose names contain this name.
- NextToken
-
- Type: string
The response from the last list when returning a list large enough to need tokening.
- SortBy
-
- Type: string
The column by which to sort the listed inference experiments.
- SortOrder
-
- Type: string
The direction of sorting (ascending or descending).
- StatusEquals
-
- Type: string
Selects inference experiments which are in this status. For the possible statuses, see DescribeInferenceExperiment.
- Type
-
- Type: string
Selects inference experiments of this type. For the possible types of inference experiments, see CreateInferenceExperiment.
Result Syntax
[
'InferenceExperiments' => [
[
'CompletionTime' => ,
'CreationTime' => ,
'Description' => '',
'LastModifiedTime' => ,
'Name' => '',
'RoleArn' => '',
'Schedule' => [
'EndTime' => ,
'StartTime' => ,
],
'Status' => 'Creating|Created|Updating|Running|Starting|Stopping|Completed|Cancelled',
'StatusReason' => '',
'Type' => 'ShadowMode',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- InferenceExperiments
-
- Type: Array of InferenceExperimentSummary structures
List of inference experiments.
- NextToken
-
- Type: string
The token to use when calling the next page of results.
Errors
There are no errors described for this operation.
ListInferenceRecommendationsJobSteps
$result = $client->listInferenceRecommendationsJobSteps([/* ... */]); $promise = $client->listInferenceRecommendationsJobStepsAsync([/* ... */]);
Returns a list of the subtasks for an Inference Recommender job.
The supported subtasks are benchmarks, which evaluate the performance of your model on different instance types.
Parameter Syntax
$result = $client->listInferenceRecommendationsJobSteps([
'JobName' => '', // REQUIRED
'MaxResults' => ,
'NextToken' => '',
'Status' => 'PENDING|IN_PROGRESS|COMPLETED|FAILED|STOPPING|STOPPED|DELETING|DELETED',
'StepType' => 'BENCHMARK',
]);
Parameter Details
Members
- JobName
-
- Required: Yes
- Type: string
The name for the Inference Recommender job.
- MaxResults
-
- Type: int
The maximum number of results to return.
- NextToken
-
- Type: string
A token that you can specify to return more results from the list. Specify this field if you have a token that was returned from a previous request.
- Status
-
- Type: string
A filter to return benchmarks of a specified status. If this field is left empty, then all benchmarks are returned.
- StepType
-
- Type: string
A filter to return details about the specified type of subtask.
BENCHMARK: Evaluate the performance of your model on different instance types.
Result Syntax
[
'NextToken' => '',
'Steps' => [
[
'InferenceBenchmark' => [
'EndpointConfiguration' => [
'EndpointName' => '',
'InitialInstanceCount' => ,
'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.12xlarge|ml.m5d.24xlarge|ml.c4.large|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.large|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.12xlarge|ml.r5.24xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.12xlarge|ml.r5d.24xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.dl1.24xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.r8g.medium|ml.r8g.large|ml.r8g.xlarge|ml.r8g.2xlarge|ml.r8g.4xlarge|ml.r8g.8xlarge|ml.r8g.12xlarge|ml.r8g.16xlarge|ml.r8g.24xlarge|ml.r8g.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.p4d.24xlarge|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m6gd.large|ml.m6gd.xlarge|ml.m6gd.2xlarge|ml.m6gd.4xlarge|ml.m6gd.8xlarge|ml.m6gd.12xlarge|ml.m6gd.16xlarge|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c6gd.large|ml.c6gd.xlarge|ml.c6gd.2xlarge|ml.c6gd.4xlarge|ml.c6gd.8xlarge|ml.c6gd.12xlarge|ml.c6gd.16xlarge|ml.c6gn.large|ml.c6gn.xlarge|ml.c6gn.2xlarge|ml.c6gn.4xlarge|ml.c6gn.8xlarge|ml.c6gn.12xlarge|ml.c6gn.16xlarge|ml.r6g.large|ml.r6g.xlarge|ml.r6g.2xlarge|ml.r6g.4xlarge|ml.r6g.8xlarge|ml.r6g.12xlarge|ml.r6g.16xlarge|ml.r6gd.large|ml.r6gd.xlarge|ml.r6gd.2xlarge|ml.r6gd.4xlarge|ml.r6gd.8xlarge|ml.r6gd.12xlarge|ml.r6gd.16xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.r7gd.medium|ml.r7gd.large|ml.r7gd.xlarge|ml.r7gd.2xlarge|ml.r7gd.4xlarge|ml.r7gd.8xlarge|ml.r7gd.12xlarge|ml.r7gd.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.c6in.large|ml.c6in.xlarge|ml.c6in.2xlarge|ml.c6in.4xlarge|ml.c6in.8xlarge|ml.c6in.12xlarge|ml.c6in.16xlarge|ml.c6in.24xlarge|ml.c6in.32xlarge|ml.p6-b200.48xlarge|ml.p6-b300.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge',
'ServerlessConfig' => [
'MaxConcurrency' => ,
'MemorySizeInMB' => ,
'ProvisionedConcurrency' => ,
],
'VariantName' => '',
],
'EndpointMetrics' => [
'MaxInvocations' => ,
'ModelLatency' => ,
],
'FailureReason' => '',
'InvocationEndTime' => ,
'InvocationStartTime' => ,
'Metrics' => [
'CostPerHour' => ,
'CostPerInference' => ,
'CpuUtilization' => ,
'MaxInvocations' => ,
'MemoryUtilization' => ,
'ModelLatency' => ,
'ModelSetupTime' => ,
],
'ModelConfiguration' => [
'CompilationJobName' => '',
'EnvironmentParameters' => [
[
'Key' => '',
'Value' => '',
'ValueType' => '',
],
// ...
],
'InferenceSpecificationName' => '',
],
],
'JobName' => '',
'Status' => 'PENDING|IN_PROGRESS|COMPLETED|FAILED|STOPPING|STOPPED|DELETING|DELETED',
'StepType' => 'BENCHMARK',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
A token that you can specify in your next request to return more results from the list.
- Steps
-
- Type: Array of InferenceRecommendationsJobStep structures
A list of all subtask details in Inference Recommender.
Errors
- ResourceNotFound:
Resource being access is not found.
ListInferenceRecommendationsJobs
$result = $client->listInferenceRecommendationsJobs([/* ... */]); $promise = $client->listInferenceRecommendationsJobsAsync([/* ... */]);
Lists recommendation jobs that satisfy various filters.
Parameter Syntax
$result = $client->listInferenceRecommendationsJobs([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'LastModifiedTimeAfter' => ,
'LastModifiedTimeBefore' => ,
'MaxResults' => ,
'ModelNameEquals' => '',
'ModelPackageVersionArnEquals' => '',
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime|Status',
'SortOrder' => 'Ascending|Descending',
'StatusEquals' => 'PENDING|IN_PROGRESS|COMPLETED|FAILED|STOPPING|STOPPED|DELETING|DELETED',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only jobs created after the specified time (timestamp).
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only jobs created before the specified time (timestamp).
- LastModifiedTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only jobs that were last modified after the specified time (timestamp).
- LastModifiedTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only jobs that were last modified before the specified time (timestamp).
- MaxResults
-
- Type: int
The maximum number of recommendations to return in the response.
- ModelNameEquals
-
- Type: string
A filter that returns only jobs that were created for this model.
- ModelPackageVersionArnEquals
-
- Type: string
A filter that returns only jobs that were created for this versioned model package.
- NameContains
-
- Type: string
A string in the job name. This filter returns only recommendations whose name contains the specified string.
- NextToken
-
- Type: string
If the response to a previous
ListInferenceRecommendationsJobsRequestrequest was truncated, the response includes aNextToken. To retrieve the next set of recommendations, use the token in the next request. - SortBy
-
- Type: string
The parameter by which to sort the results.
- SortOrder
-
- Type: string
The sort order for the results.
- StatusEquals
-
- Type: string
A filter that retrieves only inference recommendations jobs with a specific status.
Result Syntax
[
'InferenceRecommendationsJobs' => [
[
'CompletionTime' => ,
'CreationTime' => ,
'FailureReason' => '',
'JobArn' => '',
'JobDescription' => '',
'JobName' => '',
'JobType' => 'Default|Advanced',
'LastModifiedTime' => ,
'ModelName' => '',
'ModelPackageVersionArn' => '',
'RoleArn' => '',
'SamplePayloadUrl' => '',
'Status' => 'PENDING|IN_PROGRESS|COMPLETED|FAILED|STOPPING|STOPPED|DELETING|DELETED',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- InferenceRecommendationsJobs
-
- Required: Yes
- Type: Array of InferenceRecommendationsJob structures
The recommendations created from the Amazon SageMaker Inference Recommender job.
- NextToken
-
- Type: string
A token for getting the next set of recommendations, if there are any.
Errors
There are no errors described for this operation.
ListJobSchemaVersions
$result = $client->listJobSchemaVersions([/* ... */]); $promise = $client->listJobSchemaVersionsAsync([/* ... */]);
Lists available configuration schema versions for a specified job category. Use the schema versions with DescribeJobSchemaVersion to retrieve the full schema document.
The following operations are related to ListJobSchemaVersions:
-
DescribeJobSchemaVersion -
CreateJob
Parameter Syntax
$result = $client->listJobSchemaVersions([
'JobCategory' => 'AgentRFT|AgentRFTEvaluation', // REQUIRED
'MaxResults' => ,
'NextToken' => '',
]);
Parameter Details
Members
- JobCategory
-
- Required: Yes
- Type: string
The category of job schemas to list.
- MaxResults
-
- Type: int
The maximum number of schema versions to return in the response. The default value is 5.
- NextToken
-
- Type: string
If the previous response was truncated, this token retrieves the next set of results.
Result Syntax
[
'JobConfigSchemas' => [
[
'JobConfigSchemaVersion' => '',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- JobConfigSchemas
-
- Required: Yes
- Type: Array of JobConfigSchemaVersionSummary structures
An array of
JobConfigSchemaVersionSummaryobjects listing the available schema versions. - NextToken
-
- Type: string
If the response is truncated, this token retrieves the next set of results.
Errors
- ResourceNotFound:
Resource being access is not found.
ListJobs
$result = $client->listJobs([/* ... */]); $promise = $client->listJobsAsync([/* ... */]);
Lists jobs in a specified category. You can filter results by creation time, last modified time, name, and status. Results are sorted by the field you specify in SortBy. Use pagination to retrieve large result sets efficiently.
The following operations are related to ListJobs:
-
CreateJob -
DescribeJob
Parameter Syntax
$result = $client->listJobs([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'JobCategory' => 'AgentRFT|AgentRFTEvaluation', // REQUIRED
'LastModifiedTimeAfter' => ,
'LastModifiedTimeBefore' => ,
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime|Status',
'SortOrder' => 'Ascending|Descending',
'StatusEquals' => 'InProgress|Completed|Failed|Stopping|Stopped|Deleting|DeleteFailed',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only jobs created after the specified time.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only jobs created before the specified time.
- JobCategory
-
- Required: Yes
- Type: string
The category of jobs to list.
- LastModifiedTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only jobs modified after the specified time.
- LastModifiedTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only jobs modified before the specified time.
- MaxResults
-
- Type: int
The maximum number of jobs to return in the response. The default value is 50.
- NameContains
-
- Type: string
A string in the job name to filter results. Only jobs whose name contains the specified string are returned.
- NextToken
-
- Type: string
If the previous response was truncated, this token retrieves the next set of results.
- SortBy
-
- Type: string
The field to sort results by.
- SortOrder
-
- Type: string
The sort order for results. Valid values are
AscendingandDescending. - StatusEquals
-
- Type: string
A filter that returns only jobs with the specified status.
Result Syntax
[
'JobSummaries' => [
[
'CreationTime' => ,
'EndTime' => ,
'JobArn' => '',
'JobCategory' => 'AgentRFT|AgentRFTEvaluation',
'JobName' => '',
'JobSecondaryStatus' => 'Starting|Downloading|Training|Uploading|Stopping|Stopped|MaxRuntimeExceeded|Interrupted|Failed|Completed|Restarting|Pending|Evaluating|Deleting|DeleteFailed',
'JobStatus' => 'InProgress|Completed|Failed|Stopping|Stopped|Deleting|DeleteFailed',
'LastModifiedTime' => ,
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- JobSummaries
-
- Required: Yes
- Type: Array of JobSummary structures
An array of
JobSummaryobjects that provide summary information about the jobs. - NextToken
-
- Type: string
If the response is truncated, this token retrieves the next set of results.
Errors
There are no errors described for this operation.
ListLabelingJobs
$result = $client->listLabelingJobs([/* ... */]); $promise = $client->listLabelingJobsAsync([/* ... */]);
Gets a list of labeling jobs.
Parameter Syntax
$result = $client->listLabelingJobs([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'LastModifiedTimeAfter' => ,
'LastModifiedTimeBefore' => ,
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime|Status',
'SortOrder' => 'Ascending|Descending',
'StatusEquals' => 'Initializing|InProgress|Completed|Failed|Stopping|Stopped',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only labeling jobs created after the specified time (timestamp).
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only labeling jobs created before the specified time (timestamp).
- LastModifiedTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only labeling jobs modified after the specified time (timestamp).
- LastModifiedTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only labeling jobs modified before the specified time (timestamp).
- MaxResults
-
- Type: int
The maximum number of labeling jobs to return in each page of the response.
- NameContains
-
- Type: string
A string in the labeling job name. This filter returns only labeling jobs whose name contains the specified string.
- NextToken
-
- Type: string
If the result of the previous
ListLabelingJobsrequest was truncated, the response includes aNextToken. To retrieve the next set of labeling jobs, use the token in the next request. - SortBy
-
- Type: string
The field to sort results by. The default is
CreationTime. - SortOrder
-
- Type: string
The sort order for results. The default is
Ascending. - StatusEquals
-
- Type: string
A filter that retrieves only labeling jobs with a specific status.
Result Syntax
[
'LabelingJobSummaryList' => [
[
'AnnotationConsolidationLambdaArn' => '',
'CreationTime' => ,
'FailureReason' => '',
'InputConfig' => [
'DataAttributes' => [
'ContentClassifiers' => ['', ...],
],
'DataSource' => [
'S3DataSource' => [
'ManifestS3Uri' => '',
],
'SnsDataSource' => [
'SnsTopicArn' => '',
],
],
],
'LabelCounters' => [
'FailedNonRetryableError' => ,
'HumanLabeled' => ,
'MachineLabeled' => ,
'TotalLabeled' => ,
'Unlabeled' => ,
],
'LabelingJobArn' => '',
'LabelingJobName' => '',
'LabelingJobOutput' => [
'FinalActiveLearningModelArn' => '',
'OutputDatasetS3Uri' => '',
],
'LabelingJobStatus' => 'Initializing|InProgress|Completed|Failed|Stopping|Stopped',
'LastModifiedTime' => ,
'PreHumanTaskLambdaArn' => '',
'WorkteamArn' => '',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- LabelingJobSummaryList
-
- Type: Array of LabelingJobSummary structures
An array of
LabelingJobSummaryobjects, each describing a labeling job. - NextToken
-
- Type: string
If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.
Errors
There are no errors described for this operation.
ListLabelingJobsForWorkteam
$result = $client->listLabelingJobsForWorkteam([/* ... */]); $promise = $client->listLabelingJobsForWorkteamAsync([/* ... */]);
Gets a list of labeling jobs assigned to a specified work team.
Parameter Syntax
$result = $client->listLabelingJobsForWorkteam([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'JobReferenceCodeContains' => '',
'MaxResults' => ,
'NextToken' => '',
'SortBy' => 'CreationTime',
'SortOrder' => 'Ascending|Descending',
'WorkteamArn' => '', // REQUIRED
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only labeling jobs created after the specified time (timestamp).
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only labeling jobs created before the specified time (timestamp).
- JobReferenceCodeContains
-
- Type: string
A filter the limits jobs to only the ones whose job reference code contains the specified string.
- MaxResults
-
- Type: int
The maximum number of labeling jobs to return in each page of the response.
- NextToken
-
- Type: string
If the result of the previous
ListLabelingJobsForWorkteamrequest was truncated, the response includes aNextToken. To retrieve the next set of labeling jobs, use the token in the next request. - SortBy
-
- Type: string
The field to sort results by. The default is
CreationTime. - SortOrder
-
- Type: string
The sort order for results. The default is
Ascending. - WorkteamArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the work team for which you want to see labeling jobs for.
Result Syntax
[
'LabelingJobSummaryList' => [
[
'CreationTime' => ,
'JobReferenceCode' => '',
'LabelCounters' => [
'HumanLabeled' => ,
'PendingHuman' => ,
'Total' => ,
],
'LabelingJobName' => '',
'NumberOfHumanWorkersPerDataObject' => ,
'WorkRequesterAccountId' => '',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- LabelingJobSummaryList
-
- Required: Yes
- Type: Array of LabelingJobForWorkteamSummary structures
An array of
LabelingJobSummaryobjects, each describing a labeling job. - NextToken
-
- Type: string
If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.
Errors
- ResourceNotFound:
Resource being access is not found.
ListLineageGroups
$result = $client->listLineageGroups([/* ... */]); $promise = $client->listLineageGroupsAsync([/* ... */]);
A list of lineage groups shared with your Amazon Web Services account. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.
Parameter Syntax
$result = $client->listLineageGroups([
'CreatedAfter' => ,
'CreatedBefore' => ,
'MaxResults' => ,
'NextToken' => '',
'SortBy' => 'Name|CreationTime',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- CreatedAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp to filter against lineage groups created after a certain point in time.
- CreatedBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp to filter against lineage groups created before a certain point in time.
- MaxResults
-
- Type: int
The maximum number of endpoints to return in the response. This value defaults to 10.
- NextToken
-
- Type: string
If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.
- SortBy
-
- Type: string
The parameter by which to sort the results. The default is
CreationTime. - SortOrder
-
- Type: string
The sort order for the results. The default is
Ascending.
Result Syntax
[
'LineageGroupSummaries' => [
[
'CreationTime' => ,
'DisplayName' => '',
'LastModifiedTime' => ,
'LineageGroupArn' => '',
'LineageGroupName' => '',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- LineageGroupSummaries
-
- Type: Array of LineageGroupSummary structures
A list of lineage groups and their properties.
- NextToken
-
- Type: string
If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.
Errors
There are no errors described for this operation.
ListMlflowApps
$result = $client->listMlflowApps([/* ... */]); $promise = $client->listMlflowAppsAsync([/* ... */]);
Lists all MLflow Apps
Parameter Syntax
$result = $client->listMlflowApps([
'AccountDefaultStatus' => 'ENABLED|DISABLED',
'CreatedAfter' => ,
'CreatedBefore' => ,
'DefaultForDomainId' => '',
'MaxResults' => ,
'MlflowVersion' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime|Status',
'SortOrder' => 'Ascending|Descending',
'Status' => 'Creating|Created|CreateFailed|Updating|Updated|UpdateFailed|Deleting|DeleteFailed|Deleted',
]);
Parameter Details
Members
- AccountDefaultStatus
-
- Type: string
Filter for MLflow Apps with the specified
AccountDefaultStatus. - CreatedAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Use the
CreatedAfterfilter to only list MLflow Apps created after a specific date and time. Listed MLflow Apps are shown with a date and time such as"2024-03-16T01:46:56+00:00". TheCreatedAfterparameter takes in a Unix timestamp. - CreatedBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Use the
CreatedBeforefilter to only list MLflow Apps created before a specific date and time. Listed MLflow Apps are shown with a date and time such as"2024-03-16T01:46:56+00:00". TheCreatedAfterparameter takes in a Unix timestamp. - DefaultForDomainId
-
- Type: string
Filter for MLflow Apps with the specified default SageMaker Domain ID.
- MaxResults
-
- Type: int
The maximum number of MLflow Apps to list.
- MlflowVersion
-
- Type: string
Filter for Mlflow Apps with the specified version.
- NextToken
-
- Type: string
If the previous response was truncated, use this token in your next request to receive the next set of results.
- SortBy
-
- Type: string
Filter for MLflow Apps sorting by name, creation time, or creation status.
- SortOrder
-
- Type: string
Change the order of the listed MLflow Apps. By default, MLflow Apps are listed in
Descendingorder by creation time. To change the list order, specifySortOrderto beAscending. - Status
-
- Type: string
Filter for Mlflow apps with a specific creation status.
Result Syntax
[
'NextToken' => '',
'Summaries' => [
[
'Arn' => '',
'CreationTime' => ,
'LastModifiedTime' => ,
'MlflowVersion' => '',
'Name' => '',
'Status' => 'Creating|Created|CreateFailed|Updating|Updated|UpdateFailed|Deleting|DeleteFailed|Deleted',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
- Summaries
-
- Type: Array of MlflowAppSummary structures
A list of MLflow Apps according to chosen filters.
Errors
There are no errors described for this operation.
ListMlflowTrackingServers
$result = $client->listMlflowTrackingServers([/* ... */]); $promise = $client->listMlflowTrackingServersAsync([/* ... */]);
Lists all MLflow Tracking Servers.
Parameter Syntax
$result = $client->listMlflowTrackingServers([
'CreatedAfter' => ,
'CreatedBefore' => ,
'MaxResults' => ,
'MlflowVersion' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime|Status',
'SortOrder' => 'Ascending|Descending',
'TrackingServerStatus' => 'Creating|Created|CreateFailed|Updating|Updated|UpdateFailed|Deleting|DeleteFailed|Stopping|Stopped|StopFailed|Starting|Started|StartFailed|MaintenanceInProgress|MaintenanceComplete|MaintenanceFailed',
]);
Parameter Details
Members
- CreatedAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Use the
CreatedAfterfilter to only list tracking servers created after a specific date and time. Listed tracking servers are shown with a date and time such as"2024-03-16T01:46:56+00:00". TheCreatedAfterparameter takes in a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter. - CreatedBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Use the
CreatedBeforefilter to only list tracking servers created before a specific date and time. Listed tracking servers are shown with a date and time such as"2024-03-16T01:46:56+00:00". TheCreatedBeforeparameter takes in a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter. - MaxResults
-
- Type: int
The maximum number of tracking servers to list.
- MlflowVersion
-
- Type: string
Filter for tracking servers using the specified MLflow version.
- NextToken
-
- Type: string
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
- SortBy
-
- Type: string
Filter for trackings servers sorting by name, creation time, or creation status.
- SortOrder
-
- Type: string
Change the order of the listed tracking servers. By default, tracking servers are listed in
Descendingorder by creation time. To change the list order, you can specifySortOrderto beAscending. - TrackingServerStatus
-
- Type: string
Filter for tracking servers with a specified creation status.
Result Syntax
[
'NextToken' => '',
'TrackingServerSummaries' => [
[
'CreationTime' => ,
'IsActive' => 'Active|Inactive',
'LastModifiedTime' => ,
'MlflowVersion' => '',
'TrackingServerArn' => '',
'TrackingServerName' => '',
'TrackingServerStatus' => 'Creating|Created|CreateFailed|Updating|Updated|UpdateFailed|Deleting|DeleteFailed|Stopping|Stopped|StopFailed|Starting|Started|StartFailed|MaintenanceInProgress|MaintenanceComplete|MaintenanceFailed',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
- TrackingServerSummaries
-
- Type: Array of TrackingServerSummary structures
A list of tracking servers according to chosen filters.
Errors
There are no errors described for this operation.
ListModelBiasJobDefinitions
$result = $client->listModelBiasJobDefinitions([/* ... */]); $promise = $client->listModelBiasJobDefinitionsAsync([/* ... */]);
Lists model bias jobs definitions that satisfy various filters.
Parameter Syntax
$result = $client->listModelBiasJobDefinitions([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'EndpointName' => '',
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only model bias jobs created after a specified time.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only model bias jobs created before a specified time.
- EndpointName
-
- Type: string
Name of the endpoint to monitor for model bias.
- MaxResults
-
- Type: int
The maximum number of model bias jobs to return in the response. The default value is 10.
- NameContains
-
- Type: string
Filter for model bias jobs whose name contains a specified string.
- NextToken
-
- Type: string
The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
- SortBy
-
- Type: string
Whether to sort results by the
NameorCreationTimefield. The default isCreationTime. - SortOrder
-
- Type: string
Whether to sort the results in
AscendingorDescendingorder. The default isDescending.
Result Syntax
[
'JobDefinitionSummaries' => [
[
'CreationTime' => ,
'EndpointName' => '',
'MonitoringJobDefinitionArn' => '',
'MonitoringJobDefinitionName' => '',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- JobDefinitionSummaries
-
- Required: Yes
- Type: Array of MonitoringJobDefinitionSummary structures
A JSON array in which each element is a summary for a model bias jobs.
- NextToken
-
- Type: string
The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
Errors
There are no errors described for this operation.
ListModelCardExportJobs
$result = $client->listModelCardExportJobs([/* ... */]); $promise = $client->listModelCardExportJobsAsync([/* ... */]);
List the export jobs for the Amazon SageMaker Model Card.
Parameter Syntax
$result = $client->listModelCardExportJobs([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'MaxResults' => ,
'ModelCardExportJobNameContains' => '',
'ModelCardName' => '', // REQUIRED
'ModelCardVersion' => ,
'NextToken' => '',
'SortBy' => 'Name|CreationTime|Status',
'SortOrder' => 'Ascending|Descending',
'StatusEquals' => 'InProgress|Completed|Failed',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Only list model card export jobs that were created after the time specified.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Only list model card export jobs that were created before the time specified.
- MaxResults
-
- Type: int
The maximum number of model card export jobs to list.
- ModelCardExportJobNameContains
-
- Type: string
Only list model card export jobs with names that contain the specified string.
- ModelCardName
-
- Required: Yes
- Type: string
List export jobs for the model card with the specified name.
- ModelCardVersion
-
- Type: int
List export jobs for the model card with the specified version.
- NextToken
-
- Type: string
If the response to a previous
ListModelCardExportJobsrequest was truncated, the response includes aNextToken. To retrieve the next set of model card export jobs, use the token in the next request. - SortBy
-
- Type: string
Sort model card export jobs by either name or creation time. Sorts by creation time by default.
- SortOrder
-
- Type: string
Sort model card export jobs by ascending or descending order.
- StatusEquals
-
- Type: string
Only list model card export jobs with the specified status.
Result Syntax
[
'ModelCardExportJobSummaries' => [
[
'CreatedAt' => ,
'LastModifiedAt' => ,
'ModelCardExportJobArn' => '',
'ModelCardExportJobName' => '',
'ModelCardName' => '',
'ModelCardVersion' => ,
'Status' => 'InProgress|Completed|Failed',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- ModelCardExportJobSummaries
-
- Required: Yes
- Type: Array of ModelCardExportJobSummary structures
The summaries of the listed model card export jobs.
- NextToken
-
- Type: string
If the response is truncated, SageMaker returns this token. To retrieve the next set of model card export jobs, use it in the subsequent request.
Errors
There are no errors described for this operation.
ListModelCardVersions
$result = $client->listModelCardVersions([/* ... */]); $promise = $client->listModelCardVersionsAsync([/* ... */]);
List existing versions of an Amazon SageMaker Model Card.
Parameter Syntax
$result = $client->listModelCardVersions([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'MaxResults' => ,
'ModelCardName' => '', // REQUIRED
'ModelCardStatus' => 'Draft|PendingReview|Approved|Archived',
'NextToken' => '',
'SortBy' => 'Version',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Only list model card versions that were created after the time specified.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Only list model card versions that were created before the time specified.
- MaxResults
-
- Type: int
The maximum number of model card versions to list.
- ModelCardName
-
- Required: Yes
- Type: string
List model card versions for the model card with the specified name or Amazon Resource Name (ARN).
- ModelCardStatus
-
- Type: string
Only list model card versions with the specified approval status.
- NextToken
-
- Type: string
If the response to a previous
ListModelCardVersionsrequest was truncated, the response includes aNextToken. To retrieve the next set of model card versions, use the token in the next request. - SortBy
-
- Type: string
Sort listed model card versions by version. Sorts by version by default.
- SortOrder
-
- Type: string
Sort model card versions by ascending or descending order.
Result Syntax
[
'ModelCardVersionSummaryList' => [
[
'CreationTime' => ,
'LastModifiedTime' => ,
'ModelCardArn' => '',
'ModelCardName' => '',
'ModelCardStatus' => 'Draft|PendingReview|Approved|Archived',
'ModelCardVersion' => ,
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- ModelCardVersionSummaryList
-
- Required: Yes
- Type: Array of ModelCardVersionSummary structures
The summaries of the listed versions of the model card.
- NextToken
-
- Type: string
If the response is truncated, SageMaker returns this token. To retrieve the next set of model card versions, use it in the subsequent request.
Errors
- ResourceNotFound:
Resource being access is not found.
ListModelCards
$result = $client->listModelCards([/* ... */]); $promise = $client->listModelCardsAsync([/* ... */]);
List existing model cards.
Parameter Syntax
$result = $client->listModelCards([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'MaxResults' => ,
'ModelCardStatus' => 'Draft|PendingReview|Approved|Archived',
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Only list model cards that were created after the time specified.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Only list model cards that were created before the time specified.
- MaxResults
-
- Type: int
The maximum number of model cards to list.
- ModelCardStatus
-
- Type: string
Only list model cards with the specified approval status.
- NameContains
-
- Type: string
Only list model cards with names that contain the specified string.
- NextToken
-
- Type: string
If the response to a previous
ListModelCardsrequest was truncated, the response includes aNextToken. To retrieve the next set of model cards, use the token in the next request. - SortBy
-
- Type: string
Sort model cards by either name or creation time. Sorts by creation time by default.
- SortOrder
-
- Type: string
Sort model cards by ascending or descending order.
Result Syntax
[
'ModelCardSummaries' => [
[
'CreationTime' => ,
'LastModifiedTime' => ,
'ModelCardArn' => '',
'ModelCardName' => '',
'ModelCardStatus' => 'Draft|PendingReview|Approved|Archived',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- ModelCardSummaries
-
- Required: Yes
- Type: Array of ModelCardSummary structures
The summaries of the listed model cards.
- NextToken
-
- Type: string
If the response is truncated, SageMaker returns this token. To retrieve the next set of model cards, use it in the subsequent request.
Errors
There are no errors described for this operation.
ListModelExplainabilityJobDefinitions
$result = $client->listModelExplainabilityJobDefinitions([/* ... */]); $promise = $client->listModelExplainabilityJobDefinitionsAsync([/* ... */]);
Lists model explainability job definitions that satisfy various filters.
Parameter Syntax
$result = $client->listModelExplainabilityJobDefinitions([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'EndpointName' => '',
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only model explainability jobs created after a specified time.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only model explainability jobs created before a specified time.
- EndpointName
-
- Type: string
Name of the endpoint to monitor for model explainability.
- MaxResults
-
- Type: int
The maximum number of jobs to return in the response. The default value is 10.
- NameContains
-
- Type: string
Filter for model explainability jobs whose name contains a specified string.
- NextToken
-
- Type: string
The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
- SortBy
-
- Type: string
Whether to sort results by the
NameorCreationTimefield. The default isCreationTime. - SortOrder
-
- Type: string
Whether to sort the results in
AscendingorDescendingorder. The default isDescending.
Result Syntax
[
'JobDefinitionSummaries' => [
[
'CreationTime' => ,
'EndpointName' => '',
'MonitoringJobDefinitionArn' => '',
'MonitoringJobDefinitionName' => '',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- JobDefinitionSummaries
-
- Required: Yes
- Type: Array of MonitoringJobDefinitionSummary structures
A JSON array in which each element is a summary for a explainability bias jobs.
- NextToken
-
- Type: string
The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
Errors
There are no errors described for this operation.
ListModelMetadata
$result = $client->listModelMetadata([/* ... */]); $promise = $client->listModelMetadataAsync([/* ... */]);
Lists the domain, framework, task, and model name of standard machine learning models found in common model zoos.
Parameter Syntax
$result = $client->listModelMetadata([
'MaxResults' => ,
'NextToken' => '',
'SearchExpression' => [
'Filters' => [
[
'Name' => 'Domain|Framework|Task|FrameworkVersion', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
],
]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of models to return in the response.
- NextToken
-
- Type: string
If the response to a previous
ListModelMetadataResponserequest was truncated, the response includes a NextToken. To retrieve the next set of model metadata, use the token in the next request. - SearchExpression
-
- Type: ModelMetadataSearchExpression structure
One or more filters that searches for the specified resource or resources in a search. All resource objects that satisfy the expression's condition are included in the search results. Specify the Framework, FrameworkVersion, Domain or Task to filter supported. Filter names and values are case-sensitive.
Result Syntax
[
'ModelMetadataSummaries' => [
[
'Domain' => '',
'Framework' => '',
'FrameworkVersion' => '',
'Model' => '',
'Task' => '',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- ModelMetadataSummaries
-
- Required: Yes
- Type: Array of ModelMetadataSummary structures
A structure that holds model metadata.
- NextToken
-
- Type: string
A token for getting the next set of recommendations, if there are any.
Errors
There are no errors described for this operation.
ListModelPackageGroups
$result = $client->listModelPackageGroups([/* ... */]); $promise = $client->listModelPackageGroupsAsync([/* ... */]);
Gets a list of the model groups in your Amazon Web Services account.
Parameter Syntax
$result = $client->listModelPackageGroups([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'CrossAccountFilterOption' => 'SameAccount|CrossAccount',
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only model groups created after the specified time.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only model groups created before the specified time.
- CrossAccountFilterOption
-
- Type: string
A filter that returns either model groups shared with you or model groups in your own account. When the value is
CrossAccount, the results show the resources made discoverable to you from other accounts. When the value isSameAccountornull, the results show resources from your account. The default isSameAccount. - MaxResults
-
- Type: int
The maximum number of results to return in the response.
- NameContains
-
- Type: string
A string in the model group name. This filter returns only model groups whose name contains the specified string.
- NextToken
-
- Type: string
If the result of the previous
ListModelPackageGroupsrequest was truncated, the response includes aNextToken. To retrieve the next set of model groups, use the token in the next request. - SortBy
-
- Type: string
The field to sort results by. The default is
CreationTime. - SortOrder
-
- Type: string
The sort order for results. The default is
Ascending.
Result Syntax
[
'ModelPackageGroupSummaryList' => [
[
'CreationTime' => ,
'ManagedConfiguration' => [
'ManagedStorageType' => 'Restricted',
],
'ModelPackageGroupArn' => '',
'ModelPackageGroupDescription' => '',
'ModelPackageGroupName' => '',
'ModelPackageGroupStatus' => 'Pending|InProgress|Completed|Failed|Deleting|DeleteFailed',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- ModelPackageGroupSummaryList
-
- Required: Yes
- Type: Array of ModelPackageGroupSummary structures
A list of summaries of the model groups in your Amazon Web Services account.
- NextToken
-
- Type: string
If the response is truncated, SageMaker returns this token. To retrieve the next set of model groups, use it in the subsequent request.
Errors
There are no errors described for this operation.
ListModelPackages
$result = $client->listModelPackages([/* ... */]); $promise = $client->listModelPackagesAsync([/* ... */]);
Lists the model packages that have been created.
Parameter Syntax
$result = $client->listModelPackages([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'MaxResults' => ,
'ModelApprovalStatus' => 'Approved|Rejected|PendingManualApproval',
'ModelPackageGroupName' => '',
'ModelPackageType' => 'Versioned|Unversioned|Both',
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only model packages created after the specified time (timestamp).
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only model packages created before the specified time (timestamp).
- MaxResults
-
- Type: int
The maximum number of model packages to return in the response.
- ModelApprovalStatus
-
- Type: string
A filter that returns only the model packages with the specified approval status.
- ModelPackageGroupName
-
- Type: string
A filter that returns only model versions that belong to the specified model group.
- ModelPackageType
-
- Type: string
A filter that returns only the model packages of the specified type. This can be one of the following values.
-
UNVERSIONED- List only unversioined models. This is the default value if noModelPackageTypeis specified. -
VERSIONED- List only versioned models. -
BOTH- List both versioned and unversioned models.
- NameContains
-
- Type: string
A string in the model package name. This filter returns only model packages whose name contains the specified string.
- NextToken
-
- Type: string
If the response to a previous
ListModelPackagesrequest was truncated, the response includes aNextToken. To retrieve the next set of model packages, use the token in the next request. - SortBy
-
- Type: string
The parameter by which to sort the results. The default is
CreationTime. - SortOrder
-
- Type: string
The sort order for the results. The default is
Ascending.
Result Syntax
[
'ModelPackageSummaryList' => [
[
'CreationTime' => ,
'ModelApprovalStatus' => 'Approved|Rejected|PendingManualApproval',
'ModelLifeCycle' => [
'Stage' => '',
'StageDescription' => '',
'StageStatus' => '',
],
'ModelPackageArn' => '',
'ModelPackageDescription' => '',
'ModelPackageGroupName' => '',
'ModelPackageName' => '',
'ModelPackageRegistrationType' => 'Logged|Registered',
'ModelPackageStatus' => 'Pending|InProgress|Completed|Failed|Deleting',
'ModelPackageVersion' => ,
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- ModelPackageSummaryList
-
- Required: Yes
- Type: Array of ModelPackageSummary structures
An array of
ModelPackageSummaryobjects, each of which lists a model package. - NextToken
-
- Type: string
If the response is truncated, SageMaker returns this token. To retrieve the next set of model packages, use it in the subsequent request.
Errors
There are no errors described for this operation.
ListModelQualityJobDefinitions
$result = $client->listModelQualityJobDefinitions([/* ... */]); $promise = $client->listModelQualityJobDefinitionsAsync([/* ... */]);
Gets a list of model quality monitoring job definitions in your account.
Parameter Syntax
$result = $client->listModelQualityJobDefinitions([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'EndpointName' => '',
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only model quality monitoring job definitions created after the specified time.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only model quality monitoring job definitions created before the specified time.
- EndpointName
-
- Type: string
A filter that returns only model quality monitoring job definitions that are associated with the specified endpoint.
- MaxResults
-
- Type: int
The maximum number of results to return in a call to
ListModelQualityJobDefinitions. - NameContains
-
- Type: string
A string in the transform job name. This filter returns only model quality monitoring job definitions whose name contains the specified string.
- NextToken
-
- Type: string
If the result of the previous
ListModelQualityJobDefinitionsrequest was truncated, the response includes aNextToken. To retrieve the next set of model quality monitoring job definitions, use the token in the next request. - SortBy
-
- Type: string
The field to sort results by. The default is
CreationTime. - SortOrder
-
- Type: string
Whether to sort the results in
AscendingorDescendingorder. The default isDescending.
Result Syntax
[
'JobDefinitionSummaries' => [
[
'CreationTime' => ,
'EndpointName' => '',
'MonitoringJobDefinitionArn' => '',
'MonitoringJobDefinitionName' => '',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- JobDefinitionSummaries
-
- Required: Yes
- Type: Array of MonitoringJobDefinitionSummary structures
A list of summaries of model quality monitoring job definitions.
- NextToken
-
- Type: string
If the response is truncated, Amazon SageMaker AI returns this token. To retrieve the next set of model quality monitoring job definitions, use it in the next request.
Errors
There are no errors described for this operation.
ListModels
$result = $client->listModels([/* ... */]); $promise = $client->listModelsAsync([/* ... */]);
Lists models created with the CreateModel API.
Parameter Syntax
$result = $client->listModels([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only models created before the specified time (timestamp).
- MaxResults
-
- Type: int
The maximum number of models to return in the response.
- NameContains
-
- Type: string
A string in the model name. This filter returns only models whose name contains the specified string.
- NextToken
-
- Type: string
If the response to a previous
ListModelsrequest was truncated, the response includes aNextToken. To retrieve the next set of models, use the token in the next request. - SortBy
-
- Type: string
Sorts the list of results. The default is
CreationTime. - SortOrder
-
- Type: string
The sort order for results. The default is
Descending.
Result Syntax
[
'Models' => [
[
'CreationTime' => ,
'ModelArn' => '',
'ModelName' => '',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- Models
-
- Required: Yes
- Type: Array of ModelSummary structures
An array of
ModelSummaryobjects, each of which lists a model. - NextToken
-
- Type: string
If the response is truncated, SageMaker returns this token. To retrieve the next set of models, use it in the subsequent request.
Errors
There are no errors described for this operation.
ListMonitoringAlertHistory
$result = $client->listMonitoringAlertHistory([/* ... */]); $promise = $client->listMonitoringAlertHistoryAsync([/* ... */]);
Gets a list of past alerts in a model monitoring schedule.
Parameter Syntax
$result = $client->listMonitoringAlertHistory([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'MaxResults' => ,
'MonitoringAlertName' => '',
'MonitoringScheduleName' => '',
'NextToken' => '',
'SortBy' => 'CreationTime|Status',
'SortOrder' => 'Ascending|Descending',
'StatusEquals' => 'InAlert|OK',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only alerts created on or after the specified time.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only alerts created on or before the specified time.
- MaxResults
-
- Type: int
The maximum number of results to display. The default is 100.
- MonitoringAlertName
-
- Type: string
The name of a monitoring alert.
- MonitoringScheduleName
-
- Type: string
The name of a monitoring schedule.
- NextToken
-
- Type: string
If the result of the previous
ListMonitoringAlertHistoryrequest was truncated, the response includes aNextToken. To retrieve the next set of alerts in the history, use the token in the next request. - SortBy
-
- Type: string
The field used to sort results. The default is
CreationTime. - SortOrder
-
- Type: string
The sort order, whether
AscendingorDescending, of the alert history. The default isDescending. - StatusEquals
-
- Type: string
A filter that retrieves only alerts with a specific status.
Result Syntax
[
'MonitoringAlertHistory' => [
[
'AlertStatus' => 'InAlert|OK',
'CreationTime' => ,
'MonitoringAlertName' => '',
'MonitoringScheduleName' => '',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- MonitoringAlertHistory
-
- Type: Array of MonitoringAlertHistorySummary structures
An alert history for a model monitoring schedule.
- NextToken
-
- Type: string
If the response is truncated, SageMaker returns this token. To retrieve the next set of alerts, use it in the subsequent request.
Errors
- ResourceNotFound:
Resource being access is not found.
ListMonitoringAlerts
$result = $client->listMonitoringAlerts([/* ... */]); $promise = $client->listMonitoringAlertsAsync([/* ... */]);
Gets the alerts for a single monitoring schedule.
Parameter Syntax
$result = $client->listMonitoringAlerts([
'MaxResults' => ,
'MonitoringScheduleName' => '', // REQUIRED
'NextToken' => '',
]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of results to display. The default is 100.
- MonitoringScheduleName
-
- Required: Yes
- Type: string
The name of a monitoring schedule.
- NextToken
-
- Type: string
If the result of the previous
ListMonitoringAlertsrequest was truncated, the response includes aNextToken. To retrieve the next set of alerts in the history, use the token in the next request.
Result Syntax
[
'MonitoringAlertSummaries' => [
[
'Actions' => [
'ModelDashboardIndicator' => [
'Enabled' => true || false,
],
],
'AlertStatus' => 'InAlert|OK',
'CreationTime' => ,
'DatapointsToAlert' => ,
'EvaluationPeriod' => ,
'LastModifiedTime' => ,
'MonitoringAlertName' => '',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- MonitoringAlertSummaries
-
- Type: Array of MonitoringAlertSummary structures
A JSON array where each element is a summary for a monitoring alert.
- NextToken
-
- Type: string
If the response is truncated, SageMaker returns this token. To retrieve the next set of alerts, use it in the subsequent request.
Errors
- ResourceNotFound:
Resource being access is not found.
ListMonitoringExecutions
$result = $client->listMonitoringExecutions([/* ... */]); $promise = $client->listMonitoringExecutionsAsync([/* ... */]);
Returns list of all monitoring job executions.
Parameter Syntax
$result = $client->listMonitoringExecutions([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'EndpointName' => '',
'LastModifiedTimeAfter' => ,
'LastModifiedTimeBefore' => ,
'MaxResults' => ,
'MonitoringJobDefinitionName' => '',
'MonitoringScheduleName' => '',
'MonitoringTypeEquals' => 'DataQuality|ModelQuality|ModelBias|ModelExplainability',
'NextToken' => '',
'ScheduledTimeAfter' => ,
'ScheduledTimeBefore' => ,
'SortBy' => 'CreationTime|ScheduledTime|Status',
'SortOrder' => 'Ascending|Descending',
'StatusEquals' => 'Pending|Completed|CompletedWithViolations|InProgress|Failed|Stopping|Stopped',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only jobs created after a specified time.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only jobs created before a specified time.
- EndpointName
-
- Type: string
Name of a specific endpoint to fetch jobs for.
- LastModifiedTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only jobs modified before a specified time.
- LastModifiedTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only jobs modified after a specified time.
- MaxResults
-
- Type: int
The maximum number of jobs to return in the response. The default value is 10.
- MonitoringJobDefinitionName
-
- Type: string
Gets a list of the monitoring job runs of the specified monitoring job definitions.
- MonitoringScheduleName
-
- Type: string
Name of a specific schedule to fetch jobs for.
- MonitoringTypeEquals
-
- Type: string
A filter that returns only the monitoring job runs of the specified monitoring type.
- NextToken
-
- Type: string
The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
- ScheduledTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Filter for jobs scheduled after a specified time.
- ScheduledTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Filter for jobs scheduled before a specified time.
- SortBy
-
- Type: string
Whether to sort the results by the
Status,CreationTime, orScheduledTimefield. The default isCreationTime. - SortOrder
-
- Type: string
Whether to sort the results in
AscendingorDescendingorder. The default isDescending. - StatusEquals
-
- Type: string
A filter that retrieves only jobs with a specific status.
Result Syntax
[
'MonitoringExecutionSummaries' => [
[
'CreationTime' => ,
'EndpointName' => '',
'FailureReason' => '',
'LastModifiedTime' => ,
'MonitoringExecutionStatus' => 'Pending|Completed|CompletedWithViolations|InProgress|Failed|Stopping|Stopped',
'MonitoringJobDefinitionName' => '',
'MonitoringScheduleName' => '',
'MonitoringType' => 'DataQuality|ModelQuality|ModelBias|ModelExplainability',
'ProcessingJobArn' => '',
'ScheduledTime' => ,
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- MonitoringExecutionSummaries
-
- Required: Yes
- Type: Array of MonitoringExecutionSummary structures
A JSON array in which each element is a summary for a monitoring execution.
- NextToken
-
- Type: string
The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
Errors
There are no errors described for this operation.
ListMonitoringSchedules
$result = $client->listMonitoringSchedules([/* ... */]); $promise = $client->listMonitoringSchedulesAsync([/* ... */]);
Returns list of all monitoring schedules.
Parameter Syntax
$result = $client->listMonitoringSchedules([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'EndpointName' => '',
'LastModifiedTimeAfter' => ,
'LastModifiedTimeBefore' => ,
'MaxResults' => ,
'MonitoringJobDefinitionName' => '',
'MonitoringTypeEquals' => 'DataQuality|ModelQuality|ModelBias|ModelExplainability',
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime|Status',
'SortOrder' => 'Ascending|Descending',
'StatusEquals' => 'Pending|Failed|Scheduled|Stopped',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only monitoring schedules created after a specified time.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only monitoring schedules created before a specified time.
- EndpointName
-
- Type: string
Name of a specific endpoint to fetch schedules for.
- LastModifiedTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only monitoring schedules modified after a specified time.
- LastModifiedTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only monitoring schedules modified before a specified time.
- MaxResults
-
- Type: int
The maximum number of jobs to return in the response. The default value is 10.
- MonitoringJobDefinitionName
-
- Type: string
Gets a list of the monitoring schedules for the specified monitoring job definition.
- MonitoringTypeEquals
-
- Type: string
A filter that returns only the monitoring schedules for the specified monitoring type.
- NameContains
-
- Type: string
Filter for monitoring schedules whose name contains a specified string.
- NextToken
-
- Type: string
The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
- SortBy
-
- Type: string
Whether to sort the results by the
Status,CreationTime, orScheduledTimefield. The default isCreationTime. - SortOrder
-
- Type: string
Whether to sort the results in
AscendingorDescendingorder. The default isDescending. - StatusEquals
-
- Type: string
A filter that returns only monitoring schedules modified before a specified time.
Result Syntax
[
'MonitoringScheduleSummaries' => [
[
'CreationTime' => ,
'EndpointName' => '',
'LastModifiedTime' => ,
'MonitoringJobDefinitionName' => '',
'MonitoringScheduleArn' => '',
'MonitoringScheduleName' => '',
'MonitoringScheduleStatus' => 'Pending|Failed|Scheduled|Stopped',
'MonitoringType' => 'DataQuality|ModelQuality|ModelBias|ModelExplainability',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- MonitoringScheduleSummaries
-
- Required: Yes
- Type: Array of MonitoringScheduleSummary structures
A JSON array in which each element is a summary for a monitoring schedule.
- NextToken
-
- Type: string
The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
Errors
There are no errors described for this operation.
ListNotebookInstanceLifecycleConfigs
$result = $client->listNotebookInstanceLifecycleConfigs([/* ... */]); $promise = $client->listNotebookInstanceLifecycleConfigsAsync([/* ... */]);
Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.
Parameter Syntax
$result = $client->listNotebookInstanceLifecycleConfigs([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'LastModifiedTimeAfter' => ,
'LastModifiedTimeBefore' => ,
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime|LastModifiedTime',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only lifecycle configurations that were created after the specified time (timestamp).
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only lifecycle configurations that were created before the specified time (timestamp).
- LastModifiedTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only lifecycle configurations that were modified after the specified time (timestamp).
- LastModifiedTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only lifecycle configurations that were modified before the specified time (timestamp).
- MaxResults
-
- Type: int
The maximum number of lifecycle configurations to return in the response.
- NameContains
-
- Type: string
A string in the lifecycle configuration name. This filter returns only lifecycle configurations whose name contains the specified string.
- NextToken
-
- Type: string
If the result of a
ListNotebookInstanceLifecycleConfigsrequest was truncated, the response includes aNextToken. To get the next set of lifecycle configurations, use the token in the next request. - SortBy
-
- Type: string
Sorts the list of results. The default is
CreationTime. - SortOrder
-
- Type: string
The sort order for results.
Result Syntax
[
'NextToken' => '',
'NotebookInstanceLifecycleConfigs' => [
[
'CreationTime' => ,
'LastModifiedTime' => ,
'NotebookInstanceLifecycleConfigArn' => '',
'NotebookInstanceLifecycleConfigName' => '',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
If the response is truncated, SageMaker AI returns this token. To get the next set of lifecycle configurations, use it in the next request.
- NotebookInstanceLifecycleConfigs
-
- Type: Array of NotebookInstanceLifecycleConfigSummary structures
An array of
NotebookInstanceLifecycleConfigurationobjects, each listing a lifecycle configuration.
Errors
There are no errors described for this operation.
ListNotebookInstances
$result = $client->listNotebookInstances([/* ... */]); $promise = $client->listNotebookInstancesAsync([/* ... */]);
Returns a list of the SageMaker AI notebook instances in the requester's account in an Amazon Web Services Region.
Parameter Syntax
$result = $client->listNotebookInstances([
'AdditionalCodeRepositoryEquals' => '',
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'DefaultCodeRepositoryContains' => '',
'LastModifiedTimeAfter' => ,
'LastModifiedTimeBefore' => ,
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'NotebookInstanceLifecycleConfigNameContains' => '',
'SortBy' => 'Name|CreationTime|Status',
'SortOrder' => 'Ascending|Descending',
'StatusEquals' => 'Pending|InService|Stopping|Stopped|Failed|Deleting|Updating|PendingMaintenance|InMaintenance',
]);
Parameter Details
Members
- AdditionalCodeRepositoryEquals
-
- Type: string
A filter that returns only notebook instances with associated with the specified git repository.
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only notebook instances that were created after the specified time (timestamp).
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only notebook instances that were created before the specified time (timestamp).
- DefaultCodeRepositoryContains
-
- Type: string
A string in the name or URL of a Git repository associated with this notebook instance. This filter returns only notebook instances associated with a git repository with a name that contains the specified string.
- LastModifiedTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only notebook instances that were modified after the specified time (timestamp).
- LastModifiedTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only notebook instances that were modified before the specified time (timestamp).
- MaxResults
-
- Type: int
The maximum number of notebook instances to return.
- NameContains
-
- Type: string
A string in the notebook instances' name. This filter returns only notebook instances whose name contains the specified string.
- NextToken
-
- Type: string
If the previous call to the
ListNotebookInstancesis truncated, the response includes aNextToken. You can use this token in your subsequentListNotebookInstancesrequest to fetch the next set of notebook instances.You might specify a filter or a sort order in your request. When response is truncated, you must use the same values for the filer and sort order in the next request.
- NotebookInstanceLifecycleConfigNameContains
-
- Type: string
A string in the name of a notebook instances lifecycle configuration associated with this notebook instance. This filter returns only notebook instances associated with a lifecycle configuration with a name that contains the specified string.
- SortBy
-
- Type: string
The field to sort results by. The default is
Name. - SortOrder
-
- Type: string
The sort order for results.
- StatusEquals
-
- Type: string
A filter that returns only notebook instances with the specified status.
Result Syntax
[
'NextToken' => '',
'NotebookInstances' => [
[
'AdditionalCodeRepositories' => ['', ...],
'CreationTime' => ,
'DefaultCodeRepository' => '',
'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.8xlarge|ml.m5d.12xlarge|ml.m5d.16xlarge|ml.m5d.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p6-b200.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.m6id.large|ml.m6id.xlarge|ml.m6id.2xlarge|ml.m6id.4xlarge|ml.m6id.8xlarge|ml.m6id.12xlarge|ml.m6id.16xlarge|ml.m6id.24xlarge|ml.m6id.32xlarge|ml.c6id.large|ml.c6id.xlarge|ml.c6id.2xlarge|ml.c6id.4xlarge|ml.c6id.8xlarge|ml.c6id.12xlarge|ml.c6id.16xlarge|ml.c6id.24xlarge|ml.c6id.32xlarge|ml.r6id.large|ml.r6id.xlarge|ml.r6id.2xlarge|ml.r6id.4xlarge|ml.r6id.8xlarge|ml.r6id.12xlarge|ml.r6id.16xlarge|ml.r6id.24xlarge|ml.r6id.32xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.p5.4xlarge|ml.p5en.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge',
'LastModifiedTime' => ,
'NotebookInstanceArn' => '',
'NotebookInstanceLifecycleConfigName' => '',
'NotebookInstanceName' => '',
'NotebookInstanceStatus' => 'Pending|InService|Stopping|Stopped|Failed|Deleting|Updating|PendingMaintenance|InMaintenance',
'Url' => '',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
If the response to the previous
ListNotebookInstancesrequest was truncated, SageMaker AI returns this token. To retrieve the next set of notebook instances, use the token in the next request. - NotebookInstances
-
- Type: Array of NotebookInstanceSummary structures
An array of
NotebookInstanceSummaryobjects, one for each notebook instance.
Errors
There are no errors described for this operation.
ListOptimizationJobs
$result = $client->listOptimizationJobs([/* ... */]); $promise = $client->listOptimizationJobsAsync([/* ... */]);
Lists the optimization jobs in your account and their properties.
Parameter Syntax
$result = $client->listOptimizationJobs([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'LastModifiedTimeAfter' => ,
'LastModifiedTimeBefore' => ,
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'OptimizationContains' => '',
'SortBy' => 'Name|CreationTime|Status',
'SortOrder' => 'Ascending|Descending',
'StatusEquals' => 'INPROGRESS|COMPLETED|FAILED|STARTING|STOPPING|STOPPED',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Filters the results to only those optimization jobs that were created after the specified time.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Filters the results to only those optimization jobs that were created before the specified time.
- LastModifiedTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Filters the results to only those optimization jobs that were updated after the specified time.
- LastModifiedTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Filters the results to only those optimization jobs that were updated before the specified time.
- MaxResults
-
- Type: int
The maximum number of optimization jobs to return in the response. The default is 50.
- NameContains
-
- Type: string
Filters the results to only those optimization jobs with a name that contains the specified string.
- NextToken
-
- Type: string
A token that you use to get the next set of results following a truncated response. If the response to the previous request was truncated, that response provides the value for this token.
- OptimizationContains
-
- Type: string
Filters the results to only those optimization jobs that apply the specified optimization techniques. You can specify either
QuantizationorCompilation. - SortBy
-
- Type: string
The field by which to sort the optimization jobs in the response. The default is
CreationTime - SortOrder
-
- Type: string
The sort order for results. The default is
Ascending - StatusEquals
-
- Type: string
Filters the results to only those optimization jobs with the specified status.
Result Syntax
[
'NextToken' => '',
'OptimizationJobSummaries' => [
[
'CreationTime' => ,
'DeploymentInstanceType' => 'ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.p6-b200.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge',
'LastModifiedTime' => ,
'MaxInstanceCount' => ,
'OptimizationEndTime' => ,
'OptimizationJobArn' => '',
'OptimizationJobName' => '',
'OptimizationJobStatus' => 'INPROGRESS|COMPLETED|FAILED|STARTING|STOPPING|STOPPED',
'OptimizationStartTime' => ,
'OptimizationTypes' => ['', ...],
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token to use in a subsequent request to get the next set of results following a truncated response.
- OptimizationJobSummaries
-
- Required: Yes
- Type: Array of OptimizationJobSummary structures
A list of optimization jobs and their properties that matches any of the filters you specified in the request.
Errors
There are no errors described for this operation.
ListPartnerApps
$result = $client->listPartnerApps([/* ... */]); $promise = $client->listPartnerAppsAsync([/* ... */]);
Lists all of the SageMaker Partner AI Apps in an account.
Parameter Syntax
$result = $client->listPartnerApps([
'MaxResults' => ,
'NextToken' => '',
]);
Parameter Details
Members
- MaxResults
-
- Type: int
This parameter defines the maximum number of results that can be returned in a single response. The
MaxResultsparameter is an upper bound, not a target. If there are more results available than the value specified, aNextTokenis provided in the response. TheNextTokenindicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value forMaxResultsis 10. - NextToken
-
- Type: string
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
Result Syntax
[
'NextToken' => '',
'Summaries' => [
[
'Arn' => '',
'CreationTime' => ,
'Name' => '',
'Status' => 'Creating|Updating|Deleting|Available|Failed|UpdateFailed|Deleted',
'Type' => 'lakera-guard|comet|deepchecks-llm-evaluation|fiddler',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
- Summaries
-
- Type: Array of PartnerAppSummary structures
The information related to each of the SageMaker Partner AI Apps in an account.
Errors
There are no errors described for this operation.
ListPipelineExecutionSteps
$result = $client->listPipelineExecutionSteps([/* ... */]); $promise = $client->listPipelineExecutionStepsAsync([/* ... */]);
Gets a list of PipeLineExecutionStep objects.
Parameter Syntax
$result = $client->listPipelineExecutionSteps([
'MaxResults' => ,
'NextToken' => '',
'PipelineExecutionArn' => '',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of pipeline execution steps to return in the response.
- NextToken
-
- Type: string
If the result of the previous
ListPipelineExecutionStepsrequest was truncated, the response includes aNextToken. To retrieve the next set of pipeline execution steps, use the token in the next request. - PipelineExecutionArn
-
- Type: string
The Amazon Resource Name (ARN) of the pipeline execution.
- SortOrder
-
- Type: string
The field by which to sort results. The default is
CreatedTime.
Result Syntax
[
'NextToken' => '',
'PipelineExecutionSteps' => [
[
'AttemptCount' => ,
'CacheHitResult' => [
'SourcePipelineExecutionArn' => '',
],
'EndTime' => ,
'FailureReason' => '',
'Metadata' => [
'AutoMLJob' => [
'Arn' => '',
],
'BedrockCustomModel' => [
'Arn' => '',
],
'BedrockCustomModelDeployment' => [
'Arn' => '',
],
'BedrockModelImport' => [
'Arn' => '',
],
'BedrockProvisionedModelThroughput' => [
'Arn' => '',
],
'Callback' => [
'CallbackToken' => '',
'OutputParameters' => [
[
'Name' => '',
'Value' => '',
],
// ...
],
'SqsQueueUrl' => '',
],
'ClarifyCheck' => [
'BaselineUsedForDriftCheckConstraints' => '',
'CalculatedBaselineConstraints' => '',
'CheckJobArn' => '',
'CheckType' => '',
'ModelPackageGroupName' => '',
'RegisterNewBaseline' => true || false,
'SkipCheck' => true || false,
'ViolationReport' => '',
],
'Condition' => [
'Outcome' => 'True|False',
],
'EMR' => [
'ClusterId' => '',
'LogFilePath' => '',
'StepId' => '',
'StepName' => '',
],
'Endpoint' => [
'Arn' => '',
],
'EndpointConfig' => [
'Arn' => '',
],
'Fail' => [
'ErrorMessage' => '',
],
'InferenceComponent' => [
'Arn' => '',
],
'Job' => [
'Arn' => '',
],
'Lambda' => [
'Arn' => '',
'OutputParameters' => [
[
'Name' => '',
'Value' => '',
],
// ...
],
],
'Lineage' => [
'ActionArns' => ['', ...],
'ArtifactArns' => ['', ...],
'Associations' => [
[
'DestinationArn' => '',
'SourceArn' => '',
],
// ...
],
'ContextArns' => ['', ...],
],
'Model' => [
'Arn' => '',
],
'ProcessingJob' => [
'Arn' => '',
],
'QualityCheck' => [
'BaselineUsedForDriftCheckConstraints' => '',
'BaselineUsedForDriftCheckStatistics' => '',
'CalculatedBaselineConstraints' => '',
'CalculatedBaselineStatistics' => '',
'CheckJobArn' => '',
'CheckType' => '',
'ModelPackageGroupName' => '',
'RegisterNewBaseline' => true || false,
'SkipCheck' => true || false,
'ViolationReport' => '',
],
'RegisterModel' => [
'Arn' => '',
],
'TrainingJob' => [
'Arn' => '',
],
'TransformJob' => [
'Arn' => '',
],
'TuningJob' => [
'Arn' => '',
],
],
'SelectiveExecutionResult' => [
'SourcePipelineExecutionArn' => '',
],
'StartTime' => ,
'StepDescription' => '',
'StepDisplayName' => '',
'StepName' => '',
'StepStatus' => 'Starting|Executing|Stopping|Stopped|Failed|Succeeded',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
If the result of the previous
ListPipelineExecutionStepsrequest was truncated, the response includes aNextToken. To retrieve the next set of pipeline execution steps, use the token in the next request. - PipelineExecutionSteps
-
- Type: Array of PipelineExecutionStep structures
A list of
PipeLineExecutionStepobjects. EachPipeLineExecutionStepconsists of StepName, StartTime, EndTime, StepStatus, and Metadata. Metadata is an object with properties for each job that contains relevant information about the job created by the step.
Errors
- ResourceNotFound:
Resource being access is not found.
ListPipelineExecutions
$result = $client->listPipelineExecutions([/* ... */]); $promise = $client->listPipelineExecutionsAsync([/* ... */]);
Gets a list of the pipeline executions.
Parameter Syntax
$result = $client->listPipelineExecutions([
'CreatedAfter' => ,
'CreatedBefore' => ,
'MaxResults' => ,
'NextToken' => '',
'PipelineName' => '', // REQUIRED
'SortBy' => 'CreationTime|PipelineExecutionArn',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- CreatedAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns the pipeline executions that were created after a specified time.
- CreatedBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns the pipeline executions that were created before a specified time.
- MaxResults
-
- Type: int
The maximum number of pipeline executions to return in the response.
- NextToken
-
- Type: string
If the result of the previous
ListPipelineExecutionsrequest was truncated, the response includes aNextToken. To retrieve the next set of pipeline executions, use the token in the next request. - PipelineName
-
- Required: Yes
- Type: string
The name or Amazon Resource Name (ARN) of the pipeline.
- SortBy
-
- Type: string
The field by which to sort results. The default is
CreatedTime. - SortOrder
-
- Type: string
The sort order for results.
Result Syntax
[
'NextToken' => '',
'PipelineExecutionSummaries' => [
[
'PipelineExecutionArn' => '',
'PipelineExecutionDescription' => '',
'PipelineExecutionDisplayName' => '',
'PipelineExecutionFailureReason' => '',
'PipelineExecutionStatus' => 'Executing|Stopping|Stopped|Failed|Succeeded',
'StartTime' => ,
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
If the result of the previous
ListPipelineExecutionsrequest was truncated, the response includes aNextToken. To retrieve the next set of pipeline executions, use the token in the next request. - PipelineExecutionSummaries
-
- Type: Array of PipelineExecutionSummary structures
Contains a sorted list of pipeline execution summary objects matching the specified filters. Each run summary includes the Amazon Resource Name (ARN) of the pipeline execution, the run date, and the status. This list can be empty.
Errors
- ResourceNotFound:
Resource being access is not found.
ListPipelineParametersForExecution
$result = $client->listPipelineParametersForExecution([/* ... */]); $promise = $client->listPipelineParametersForExecutionAsync([/* ... */]);
Gets a list of parameters for a pipeline execution.
Parameter Syntax
$result = $client->listPipelineParametersForExecution([
'MaxResults' => ,
'NextToken' => '',
'PipelineExecutionArn' => '', // REQUIRED
]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of parameters to return in the response.
- NextToken
-
- Type: string
If the result of the previous
ListPipelineParametersForExecutionrequest was truncated, the response includes aNextToken. To retrieve the next set of parameters, use the token in the next request. - PipelineExecutionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the pipeline execution.
Result Syntax
[
'NextToken' => '',
'PipelineParameters' => [
[
'Name' => '',
'Value' => '',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
If the result of the previous
ListPipelineParametersForExecutionrequest was truncated, the response includes aNextToken. To retrieve the next set of parameters, use the token in the next request. - PipelineParameters
-
- Type: Array of Parameter structures
Contains a list of pipeline parameters. This list can be empty.
Errors
- ResourceNotFound:
Resource being access is not found.
ListPipelineVersions
$result = $client->listPipelineVersions([/* ... */]); $promise = $client->listPipelineVersionsAsync([/* ... */]);
Gets a list of all versions of the pipeline.
Parameter Syntax
$result = $client->listPipelineVersions([
'CreatedAfter' => ,
'CreatedBefore' => ,
'MaxResults' => ,
'NextToken' => '',
'PipelineName' => '', // REQUIRED
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- CreatedAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns the pipeline versions that were created after a specified time.
- CreatedBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns the pipeline versions that were created before a specified time.
- MaxResults
-
- Type: int
The maximum number of pipeline versions to return in the response.
- NextToken
-
- Type: string
If the result of the previous
ListPipelineVersionsrequest was truncated, the response includes aNextToken. To retrieve the next set of pipeline versions, use this token in your next request. - PipelineName
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the pipeline.
- SortOrder
-
- Type: string
The sort order for the results.
Result Syntax
[
'NextToken' => '',
'PipelineVersionSummaries' => [
[
'CreationTime' => ,
'LastExecutionPipelineExecutionArn' => '',
'PipelineArn' => '',
'PipelineVersionDescription' => '',
'PipelineVersionDisplayName' => '',
'PipelineVersionId' => ,
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
If the result of the previous
ListPipelineVersionsrequest was truncated, the response includes aNextToken. To retrieve the next set of pipeline versions, use this token in your next request. - PipelineVersionSummaries
-
- Type: Array of PipelineVersionSummary structures
Contains a sorted list of pipeline version summary objects matching the specified filters. Each version summary includes the pipeline version ID, the creation date, and the last pipeline execution created from that version. This list can be empty.
Errors
- ResourceNotFound:
Resource being access is not found.
ListPipelines
$result = $client->listPipelines([/* ... */]); $promise = $client->listPipelinesAsync([/* ... */]);
Gets a list of pipelines.
Parameter Syntax
$result = $client->listPipelines([
'CreatedAfter' => ,
'CreatedBefore' => ,
'MaxResults' => ,
'NextToken' => '',
'PipelineNamePrefix' => '',
'SortBy' => 'Name|CreationTime',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- CreatedAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns the pipelines that were created after a specified time.
- CreatedBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns the pipelines that were created before a specified time.
- MaxResults
-
- Type: int
The maximum number of pipelines to return in the response.
- NextToken
-
- Type: string
If the result of the previous
ListPipelinesrequest was truncated, the response includes aNextToken. To retrieve the next set of pipelines, use the token in the next request. - PipelineNamePrefix
-
- Type: string
The prefix of the pipeline name.
- SortBy
-
- Type: string
The field by which to sort results. The default is
CreatedTime. - SortOrder
-
- Type: string
The sort order for results.
Result Syntax
[
'NextToken' => '',
'PipelineSummaries' => [
[
'CreationTime' => ,
'LastExecutionTime' => ,
'LastModifiedTime' => ,
'PipelineArn' => '',
'PipelineDescription' => '',
'PipelineDisplayName' => '',
'PipelineName' => '',
'RoleArn' => '',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
If the result of the previous
ListPipelinesrequest was truncated, the response includes aNextToken. To retrieve the next set of pipelines, use the token in the next request. - PipelineSummaries
-
- Type: Array of PipelineSummary structures
Contains a sorted list of
PipelineSummaryobjects matching the specified filters. EachPipelineSummaryconsists of PipelineArn, PipelineName, ExperimentName, PipelineDescription, CreationTime, LastModifiedTime, LastRunTime, and RoleArn. This list can be empty.
Errors
There are no errors described for this operation.
ListProcessingJobs
$result = $client->listProcessingJobs([/* ... */]); $promise = $client->listProcessingJobsAsync([/* ... */]);
Lists processing jobs that satisfy various filters.
Parameter Syntax
$result = $client->listProcessingJobs([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'LastModifiedTimeAfter' => ,
'LastModifiedTimeBefore' => ,
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime|Status',
'SortOrder' => 'Ascending|Descending',
'StatusEquals' => 'InProgress|Completed|Failed|Stopping|Stopped',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only processing jobs created after the specified time.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only processing jobs created after the specified time.
- LastModifiedTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only processing jobs modified after the specified time.
- LastModifiedTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only processing jobs modified before the specified time.
- MaxResults
-
- Type: int
The maximum number of processing jobs to return in the response.
- NameContains
-
- Type: string
A string in the processing job name. This filter returns only processing jobs whose name contains the specified string.
- NextToken
-
- Type: string
If the result of the previous
ListProcessingJobsrequest was truncated, the response includes aNextToken. To retrieve the next set of processing jobs, use the token in the next request. - SortBy
-
- Type: string
The field to sort results by. The default is
CreationTime. - SortOrder
-
- Type: string
The sort order for results. The default is
Ascending. - StatusEquals
-
- Type: string
A filter that retrieves only processing jobs with a specific status.
Result Syntax
[
'NextToken' => '',
'ProcessingJobSummaries' => [
[
'CreationTime' => ,
'ExitMessage' => '',
'FailureReason' => '',
'LastModifiedTime' => ,
'ProcessingEndTime' => ,
'ProcessingJobArn' => '',
'ProcessingJobName' => '',
'ProcessingJobStatus' => 'InProgress|Completed|Failed|Stopping|Stopped',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of processing jobs, use it in the subsequent request.
- ProcessingJobSummaries
-
- Required: Yes
- Type: Array of ProcessingJobSummary structures
An array of
ProcessingJobSummaryobjects, each listing a processing job.
Errors
There are no errors described for this operation.
ListProjects
$result = $client->listProjects([/* ... */]); $promise = $client->listProjectsAsync([/* ... */]);
Gets a list of the projects in an Amazon Web Services account.
Parameter Syntax
$result = $client->listProjects([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns the projects that were created after a specified time.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns the projects that were created before a specified time.
- MaxResults
-
- Type: int
The maximum number of projects to return in the response.
- NameContains
-
- Type: string
A filter that returns the projects whose name contains a specified string.
- NextToken
-
- Type: string
If the result of the previous
ListProjectsrequest was truncated, the response includes aNextToken. To retrieve the next set of projects, use the token in the next request. - SortBy
-
- Type: string
The field by which to sort results. The default is
CreationTime. - SortOrder
-
- Type: string
The sort order for results. The default is
Ascending.
Result Syntax
[
'NextToken' => '',
'ProjectSummaryList' => [
[
'CreationTime' => ,
'ProjectArn' => '',
'ProjectDescription' => '',
'ProjectId' => '',
'ProjectName' => '',
'ProjectStatus' => 'Pending|CreateInProgress|CreateCompleted|CreateFailed|DeleteInProgress|DeleteFailed|DeleteCompleted|UpdateInProgress|UpdateCompleted|UpdateFailed',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
If the result of the previous
ListCompilationJobsrequest was truncated, the response includes aNextToken. To retrieve the next set of model compilation jobs, use the token in the next request. - ProjectSummaryList
-
- Required: Yes
- Type: Array of ProjectSummary structures
A list of summaries of projects.
Errors
There are no errors described for this operation.
ListResourceCatalogs
$result = $client->listResourceCatalogs([/* ... */]); $promise = $client->listResourceCatalogsAsync([/* ... */]);
Lists Amazon SageMaker Catalogs based on given filters and orders. The maximum number of ResourceCatalogs viewable is 1000.
Parameter Syntax
$result = $client->listResourceCatalogs([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'CreationTime',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Use this parameter to search for
ResourceCatalogs created after a specific date and time. - CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Use this parameter to search for
ResourceCatalogs created before a specific date and time. - MaxResults
-
- Type: int
The maximum number of results returned by
ListResourceCatalogs. - NameContains
-
- Type: string
A string that partially matches one or more
ResourceCatalogs names. FiltersResourceCatalogby name. - NextToken
-
- Type: string
A token to resume pagination of
ListResourceCatalogsresults. - SortBy
-
- Type: string
The value on which the resource catalog list is sorted.
- SortOrder
-
- Type: string
The order in which the resource catalogs are listed.
Result Syntax
[
'NextToken' => '',
'ResourceCatalogs' => [
[
'CreationTime' => ,
'Description' => '',
'ResourceCatalogArn' => '',
'ResourceCatalogName' => '',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
A token to resume pagination of
ListResourceCatalogsresults. - ResourceCatalogs
-
- Type: Array of ResourceCatalog structures
A list of the requested
ResourceCatalogs.
Errors
There are no errors described for this operation.
ListSpaces
$result = $client->listSpaces([/* ... */]); $promise = $client->listSpacesAsync([/* ... */]);
Lists spaces.
Parameter Syntax
$result = $client->listSpaces([
'DomainIdEquals' => '',
'MaxResults' => ,
'NextToken' => '',
'SortBy' => 'CreationTime|LastModifiedTime',
'SortOrder' => 'Ascending|Descending',
'SpaceNameContains' => '',
]);
Parameter Details
Members
- DomainIdEquals
-
- Type: string
A parameter to search for the domain ID.
- MaxResults
-
- Type: int
This parameter defines the maximum number of results that can be return in a single response. The
MaxResultsparameter is an upper bound, not a target. If there are more results available than the value specified, aNextTokenis provided in the response. TheNextTokenindicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value forMaxResultsis 10. - NextToken
-
- Type: string
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
- SortBy
-
- Type: string
The parameter by which to sort the results. The default is
CreationTime. - SortOrder
-
- Type: string
The sort order for the results. The default is
Ascending. - SpaceNameContains
-
- Type: string
A parameter by which to filter the results.
Result Syntax
[
'NextToken' => '',
'Spaces' => [
[
'CreationTime' => ,
'DomainId' => '',
'LastModifiedTime' => ,
'OwnershipSettingsSummary' => [
'OwnerUserProfileName' => '',
],
'SpaceDisplayName' => '',
'SpaceName' => '',
'SpaceSettingsSummary' => [
'AppType' => 'JupyterServer|KernelGateway|DetailedProfiler|TensorBoard|CodeEditor|JupyterLab|RStudioServerPro|RSessionGateway|Canvas',
'RemoteAccess' => 'ENABLED|DISABLED',
'SpaceStorageSettings' => [
'EbsStorageSettings' => [
'EbsVolumeSizeInGb' => ,
],
],
],
'SpaceSharingSettingsSummary' => [
'SharingType' => 'Private|Shared',
],
'Status' => 'Deleting|Failed|InService|Pending|Updating|Update_Failed|Delete_Failed',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
- Spaces
-
- Type: Array of SpaceDetails structures
The list of spaces.
Errors
There are no errors described for this operation.
ListStageDevices
$result = $client->listStageDevices([/* ... */]); $promise = $client->listStageDevicesAsync([/* ... */]);
Lists devices allocated to the stage, containing detailed device information and deployment status.
Parameter Syntax
$result = $client->listStageDevices([
'EdgeDeploymentPlanName' => '', // REQUIRED
'ExcludeDevicesDeployedInOtherStage' => true || false,
'MaxResults' => ,
'NextToken' => '',
'StageName' => '', // REQUIRED
]);
Parameter Details
Members
- EdgeDeploymentPlanName
-
- Required: Yes
- Type: string
The name of the edge deployment plan.
- ExcludeDevicesDeployedInOtherStage
-
- Type: boolean
Toggle for excluding devices deployed in other stages.
- MaxResults
-
- Type: int
The maximum number of requests to select.
- NextToken
-
- Type: string
The response from the last list when returning a list large enough to neeed tokening.
- StageName
-
- Required: Yes
- Type: string
The name of the stage in the deployment.
Result Syntax
[
'DeviceDeploymentSummaries' => [
[
'DeployedStageName' => '',
'DeploymentStartTime' => ,
'Description' => '',
'DeviceArn' => '',
'DeviceDeploymentStatus' => 'READYTODEPLOY|INPROGRESS|DEPLOYED|FAILED|STOPPING|STOPPED',
'DeviceDeploymentStatusMessage' => '',
'DeviceFleetName' => '',
'DeviceName' => '',
'EdgeDeploymentPlanArn' => '',
'EdgeDeploymentPlanName' => '',
'StageName' => '',
],
// ...
],
'NextToken' => '',
]
Result Details
Members
- DeviceDeploymentSummaries
-
- Required: Yes
- Type: Array of DeviceDeploymentSummary structures
List of summaries of devices allocated to the stage.
- NextToken
-
- Type: string
The token to use when calling the next page of results.
Errors
There are no errors described for this operation.
ListStudioLifecycleConfigs
$result = $client->listStudioLifecycleConfigs([/* ... */]); $promise = $client->listStudioLifecycleConfigsAsync([/* ... */]);
Lists the Amazon SageMaker AI Studio Lifecycle Configurations in your Amazon Web Services Account.
Parameter Syntax
$result = $client->listStudioLifecycleConfigs([
'AppTypeEquals' => 'JupyterServer|KernelGateway|CodeEditor|JupyterLab',
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'MaxResults' => ,
'ModifiedTimeAfter' => ,
'ModifiedTimeBefore' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'CreationTime|LastModifiedTime|Name',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- AppTypeEquals
-
- Type: string
A parameter to search for the App Type to which the Lifecycle Configuration is attached.
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only Lifecycle Configurations created on or after the specified time.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only Lifecycle Configurations created on or before the specified time.
- MaxResults
-
- Type: int
The total number of items to return in the response. If the total number of items available is more than the value specified, a
NextTokenis provided in the response. To resume pagination, provide theNextTokenvalue in the as part of a subsequent call. The default value is 10. - ModifiedTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only Lifecycle Configurations modified after the specified time.
- ModifiedTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only Lifecycle Configurations modified before the specified time.
- NameContains
-
- Type: string
A string in the Lifecycle Configuration name. This filter returns only Lifecycle Configurations whose name contains the specified string.
- NextToken
-
- Type: string
If the previous call to ListStudioLifecycleConfigs didn't return the full set of Lifecycle Configurations, the call returns a token for getting the next set of Lifecycle Configurations.
- SortBy
-
- Type: string
The property used to sort results. The default value is CreationTime.
- SortOrder
-
- Type: string
The sort order. The default value is Descending.
Result Syntax
[
'NextToken' => '',
'StudioLifecycleConfigs' => [
[
'CreationTime' => ,
'LastModifiedTime' => ,
'StudioLifecycleConfigAppType' => 'JupyterServer|KernelGateway|CodeEditor|JupyterLab',
'StudioLifecycleConfigArn' => '',
'StudioLifecycleConfigName' => '',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
- StudioLifecycleConfigs
-
- Type: Array of StudioLifecycleConfigDetails structures
A list of Lifecycle Configurations and their properties.
Errors
- ResourceInUse:
Resource being accessed is in use.
ListSubscribedWorkteams
$result = $client->listSubscribedWorkteams([/* ... */]); $promise = $client->listSubscribedWorkteamsAsync([/* ... */]);
Gets a list of the work teams that you are subscribed to in the Amazon Web Services Marketplace. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.
Parameter Syntax
$result = $client->listSubscribedWorkteams([
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of work teams to return in each page of the response.
- NameContains
-
- Type: string
A string in the work team name. This filter returns only work teams whose name contains the specified string.
- NextToken
-
- Type: string
If the result of the previous
ListSubscribedWorkteamsrequest was truncated, the response includes aNextToken. To retrieve the next set of labeling jobs, use the token in the next request.
Result Syntax
[
'NextToken' => '',
'SubscribedWorkteams' => [
[
'ListingId' => '',
'MarketplaceDescription' => '',
'MarketplaceTitle' => '',
'SellerName' => '',
'WorkteamArn' => '',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.
- SubscribedWorkteams
-
- Required: Yes
- Type: Array of SubscribedWorkteam structures
An array of
Workteamobjects, each describing a work team.
Errors
There are no errors described for this operation.
ListTags
$result = $client->listTags([/* ... */]); $promise = $client->listTagsAsync([/* ... */]);
Returns the tags for the specified SageMaker resource.
Parameter Syntax
$result = $client->listTags([
'MaxResults' => ,
'NextToken' => '',
'ResourceArn' => '', // REQUIRED
]);
Parameter Details
Members
- MaxResults
-
- Type: int
Maximum number of tags to return.
- NextToken
-
- Type: string
If the response to the previous
ListTagsrequest is truncated, SageMaker returns this token. To retrieve the next set of tags, use it in the subsequent request. - ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.
Result Syntax
[
'NextToken' => '',
'Tags' => [
[
'Key' => '',
'Value' => '',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
If response is truncated, SageMaker includes a token in the response. You can use this token in your subsequent request to fetch next set of tokens.
- Tags
-
- Type: Array of Tag structures
An array of
Tagobjects, each with a tag key and a value.
Errors
There are no errors described for this operation.
ListTrainingJobs
$result = $client->listTrainingJobs([/* ... */]); $promise = $client->listTrainingJobsAsync([/* ... */]);
Lists training jobs.
When StatusEquals and MaxResults are set at the same time, the MaxResults number of training jobs are first retrieved ignoring the StatusEquals parameter and then they are filtered by the StatusEquals parameter, which is returned as a response.
For example, if ListTrainingJobs is invoked with the following parameters:
{ ... MaxResults: 100, StatusEquals: InProgress ... }
First, 100 trainings jobs with any status, including those other than InProgress, are selected (sorted according to the creation time, from the most current to the oldest). Next, those with a status of InProgress are returned.
You can quickly test the API using the following Amazon Web Services CLI code.
aws sagemaker list-training-jobs --max-results 100 --status-equals InProgress
Parameter Syntax
$result = $client->listTrainingJobs([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'LastModifiedTimeAfter' => ,
'LastModifiedTimeBefore' => ,
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime|Status',
'SortOrder' => 'Ascending|Descending',
'StatusEquals' => 'InProgress|Completed|Failed|Stopping|Stopped|Deleting',
'TrainingPlanArnEquals' => '',
'WarmPoolStatusEquals' => 'Available|Terminated|Reused|InUse',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only training jobs created after the specified time (timestamp).
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only training jobs created before the specified time (timestamp).
- LastModifiedTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only training jobs modified after the specified time (timestamp).
- LastModifiedTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only training jobs modified before the specified time (timestamp).
- MaxResults
-
- Type: int
The maximum number of training jobs to return in the response.
- NameContains
-
- Type: string
A string in the training job name. This filter returns only training jobs whose name contains the specified string.
- NextToken
-
- Type: string
If the result of the previous
ListTrainingJobsrequest was truncated, the response includes aNextToken. To retrieve the next set of training jobs, use the token in the next request. - SortBy
-
- Type: string
The field to sort results by. The default is
CreationTime. - SortOrder
-
- Type: string
The sort order for results. The default is
Ascending. - StatusEquals
-
- Type: string
A filter that retrieves only training jobs with a specific status.
- TrainingPlanArnEquals
-
- Type: string
The Amazon Resource Name (ARN); of the training plan to filter training jobs by. For more information about reserving GPU capacity for your SageMaker training jobs using Amazon SageMaker Training Plan, see
CreateTrainingPlan. - WarmPoolStatusEquals
-
- Type: string
A filter that retrieves only training jobs with a specific warm pool status.
Result Syntax
[
'NextToken' => '',
'TrainingJobSummaries' => [
[
'CreationTime' => ,
'LastModifiedTime' => ,
'SecondaryStatus' => 'Starting|LaunchingMLInstances|PreparingTrainingStack|Downloading|DownloadingTrainingImage|Training|Uploading|Stopping|Stopped|MaxRuntimeExceeded|Completed|Failed|Interrupted|MaxWaitTimeExceeded|Updating|Restarting|Pending',
'TrainingEndTime' => ,
'TrainingJobArn' => '',
'TrainingJobName' => '',
'TrainingJobStatus' => 'InProgress|Completed|Failed|Stopping|Stopped|Deleting',
'TrainingPlanArn' => '',
'WarmPoolStatus' => [
'ResourceRetainedBillableTimeInSeconds' => ,
'ReusedByJob' => '',
'Status' => 'Available|Terminated|Reused|InUse',
],
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.
- TrainingJobSummaries
-
- Required: Yes
- Type: Array of TrainingJobSummary structures
An array of
TrainingJobSummaryobjects, each listing a training job.
Errors
There are no errors described for this operation.
ListTrainingJobsForHyperParameterTuningJob
$result = $client->listTrainingJobsForHyperParameterTuningJob([/* ... */]); $promise = $client->listTrainingJobsForHyperParameterTuningJobAsync([/* ... */]);
Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.
Parameter Syntax
$result = $client->listTrainingJobsForHyperParameterTuningJob([
'HyperParameterTuningJobName' => '', // REQUIRED
'MaxResults' => ,
'NextToken' => '',
'SortBy' => 'Name|CreationTime|Status|FinalObjectiveMetricValue',
'SortOrder' => 'Ascending|Descending',
'StatusEquals' => 'InProgress|Completed|Failed|Stopping|Stopped|Deleting',
]);
Parameter Details
Members
- HyperParameterTuningJobName
-
- Required: Yes
- Type: string
The name of the tuning job whose training jobs you want to list.
- MaxResults
-
- Type: int
The maximum number of training jobs to return. The default value is 10.
- NextToken
-
- Type: string
If the result of the previous
ListTrainingJobsForHyperParameterTuningJobrequest was truncated, the response includes aNextToken. To retrieve the next set of training jobs, use the token in the next request. - SortBy
-
- Type: string
The field to sort results by. The default is
Name.If the value of this field is
FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed. - SortOrder
-
- Type: string
The sort order for results. The default is
Ascending. - StatusEquals
-
- Type: string
A filter that returns only training jobs with the specified status.
Result Syntax
[
'NextToken' => '',
'TrainingJobSummaries' => [
[
'CreationTime' => ,
'FailureReason' => '',
'FinalHyperParameterTuningJobObjectiveMetric' => [
'MetricName' => '',
'Type' => 'Maximize|Minimize',
'Value' => ,
],
'ObjectiveStatus' => 'Succeeded|Pending|Failed',
'TrainingEndTime' => ,
'TrainingJobArn' => '',
'TrainingJobDefinitionName' => '',
'TrainingJobName' => '',
'TrainingJobStatus' => 'InProgress|Completed|Failed|Stopping|Stopped|Deleting',
'TrainingStartTime' => ,
'TunedHyperParameters' => ['', ...],
'TuningJobName' => '',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
If the result of this
ListTrainingJobsForHyperParameterTuningJobrequest was truncated, the response includes aNextToken. To retrieve the next set of training jobs, use the token in the next request. - TrainingJobSummaries
-
- Required: Yes
- Type: Array of HyperParameterTrainingJobSummary structures
A list of TrainingJobSummary objects that describe the training jobs that the
ListTrainingJobsForHyperParameterTuningJobrequest returned.
Errors
- ResourceNotFound:
Resource being access is not found.
ListTrainingPlans
$result = $client->listTrainingPlans([/* ... */]); $promise = $client->listTrainingPlansAsync([/* ... */]);
Retrieves a list of training plans for the current account.
Parameter Syntax
$result = $client->listTrainingPlans([
'Filters' => [
[
'Name' => 'Status', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
'MaxResults' => ,
'NextToken' => '',
'SortBy' => 'TrainingPlanName|StartTime|Status',
'SortOrder' => 'Ascending|Descending',
'StartTimeAfter' => ,
'StartTimeBefore' => ,
]);
Parameter Details
Members
- Filters
-
- Type: Array of TrainingPlanFilter structures
Additional filters to apply to the list of training plans.
- MaxResults
-
- Type: int
The maximum number of results to return in the response.
- NextToken
-
- Type: string
A token to continue pagination if more results are available.
- SortBy
-
- Type: string
The training plan field to sort the results by (e.g., StartTime, Status).
- SortOrder
-
- Type: string
The order to sort the results (Ascending or Descending).
- StartTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Filter to list only training plans with an actual start time after this date.
- StartTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Filter to list only training plans with an actual start time before this date.
Result Syntax
[
'NextToken' => '',
'TrainingPlanSummaries' => [
[
'AvailableInstanceCount' => ,
'CurrencyCode' => '',
'DurationHours' => ,
'DurationMinutes' => ,
'EndTime' => ,
'InUseInstanceCount' => ,
'ReservedCapacitySummaries' => [
[
'AvailabilityZone' => '',
'AvailabilityZoneId' => '',
'DurationHours' => ,
'DurationMinutes' => ,
'EndTime' => ,
'InstanceType' => 'ml.p4d.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.trn1.32xlarge|ml.trn2.48xlarge|ml.p6-b200.48xlarge|ml.p4de.24xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge',
'ReservedCapacityArn' => '',
'ReservedCapacityType' => 'UltraServer|Instance',
'StartTime' => ,
'Status' => 'Pending|Active|Scheduled|Expired|Failed',
'TotalInstanceCount' => ,
'UltraServerCount' => ,
'UltraServerType' => '',
],
// ...
],
'StartTime' => ,
'Status' => 'Pending|Active|Scheduled|Expired|Failed',
'StatusMessage' => '',
'TargetResources' => ['', ...],
'TotalInstanceCount' => ,
'TotalUltraServerCount' => ,
'TrainingPlanArn' => '',
'TrainingPlanName' => '',
'UpfrontFee' => '',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
A token to continue pagination if more results are available.
- TrainingPlanSummaries
-
- Required: Yes
- Type: Array of TrainingPlanSummary structures
A list of summary information for the training plans.
Errors
There are no errors described for this operation.
ListTransformJobs
$result = $client->listTransformJobs([/* ... */]); $promise = $client->listTransformJobsAsync([/* ... */]);
Lists transform jobs.
Parameter Syntax
$result = $client->listTransformJobs([
'CreationTimeAfter' => ,
'CreationTimeBefore' => ,
'LastModifiedTimeAfter' => ,
'LastModifiedTimeBefore' => ,
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreationTime|Status',
'SortOrder' => 'Ascending|Descending',
'StatusEquals' => 'InProgress|Completed|Failed|Stopping|Stopped',
]);
Parameter Details
Members
- CreationTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only transform jobs created after the specified time.
- CreationTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only transform jobs created before the specified time.
- LastModifiedTimeAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only transform jobs modified after the specified time.
- LastModifiedTimeBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only transform jobs modified before the specified time.
- MaxResults
-
- Type: int
The maximum number of transform jobs to return in the response. The default value is
10. - NameContains
-
- Type: string
A string in the transform job name. This filter returns only transform jobs whose name contains the specified string.
- NextToken
-
- Type: string
If the result of the previous
ListTransformJobsrequest was truncated, the response includes aNextToken. To retrieve the next set of transform jobs, use the token in the next request. - SortBy
-
- Type: string
The field to sort results by. The default is
CreationTime. - SortOrder
-
- Type: string
The sort order for results. The default is
Descending. - StatusEquals
-
- Type: string
A filter that retrieves only transform jobs with a specific status.
Result Syntax
[
'NextToken' => '',
'TransformJobSummaries' => [
[
'CreationTime' => ,
'FailureReason' => '',
'LastModifiedTime' => ,
'TransformEndTime' => ,
'TransformJobArn' => '',
'TransformJobName' => '',
'TransformJobStatus' => 'InProgress|Completed|Failed|Stopping|Stopped',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of transform jobs, use it in the next request.
- TransformJobSummaries
-
- Required: Yes
- Type: Array of TransformJobSummary structures
An array of
TransformJobSummaryobjects.
Errors
There are no errors described for this operation.
ListTrialComponents
$result = $client->listTrialComponents([/* ... */]); $promise = $client->listTrialComponentsAsync([/* ... */]);
Lists the trial components in your account. You can sort the list by trial component name or creation time. You can filter the list to show only components that were created in a specific time range. You can also filter on one of the following:
-
ExperimentName -
SourceArn -
TrialName
Parameter Syntax
$result = $client->listTrialComponents([
'CreatedAfter' => ,
'CreatedBefore' => ,
'ExperimentName' => '',
'MaxResults' => ,
'NextToken' => '',
'SortBy' => 'Name|CreationTime',
'SortOrder' => 'Ascending|Descending',
'SourceArn' => '',
'TrialName' => '',
]);
Parameter Details
Members
- CreatedAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only components created after the specified time.
- CreatedBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only components created before the specified time.
- ExperimentName
-
- Type: string
A filter that returns only components that are part of the specified experiment. If you specify
ExperimentName, you can't filter bySourceArnorTrialName. - MaxResults
-
- Type: int
The maximum number of components to return in the response. The default value is 10.
- NextToken
-
- Type: string
If the previous call to
ListTrialComponentsdidn't return the full set of components, the call returns a token for getting the next set of components. - SortBy
-
- Type: string
The property used to sort results. The default value is
CreationTime. - SortOrder
-
- Type: string
The sort order. The default value is
Descending. - SourceArn
-
- Type: string
A filter that returns only components that have the specified source Amazon Resource Name (ARN). If you specify
SourceArn, you can't filter byExperimentNameorTrialName. - TrialName
-
- Type: string
A filter that returns only components that are part of the specified trial. If you specify
TrialName, you can't filter byExperimentNameorSourceArn.
Result Syntax
[
'NextToken' => '',
'TrialComponentSummaries' => [
[
'CreatedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'CreationTime' => ,
'DisplayName' => '',
'EndTime' => ,
'LastModifiedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'LastModifiedTime' => ,
'StartTime' => ,
'Status' => [
'Message' => '',
'PrimaryStatus' => 'InProgress|Completed|Failed|Stopping|Stopped',
],
'TrialComponentArn' => '',
'TrialComponentName' => '',
'TrialComponentSource' => [
'SourceArn' => '',
'SourceType' => '',
],
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
A token for getting the next set of components, if there are any.
- TrialComponentSummaries
-
- Type: Array of TrialComponentSummary structures
A list of the summaries of your trial components.
Errors
- ResourceNotFound:
Resource being access is not found.
ListTrials
$result = $client->listTrials([/* ... */]); $promise = $client->listTrialsAsync([/* ... */]);
Lists the trials in your account. Specify an experiment name to limit the list to the trials that are part of that experiment. Specify a trial component name to limit the list to the trials that associated with that trial component. The list can be filtered to show only trials that were created in a specific time range. The list can be sorted by trial name or creation time.
Parameter Syntax
$result = $client->listTrials([
'CreatedAfter' => ,
'CreatedBefore' => ,
'ExperimentName' => '',
'MaxResults' => ,
'NextToken' => '',
'SortBy' => 'Name|CreationTime',
'SortOrder' => 'Ascending|Descending',
'TrialComponentName' => '',
]);
Parameter Details
Members
- CreatedAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only trials created after the specified time.
- CreatedBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A filter that returns only trials created before the specified time.
- ExperimentName
-
- Type: string
A filter that returns only trials that are part of the specified experiment.
- MaxResults
-
- Type: int
The maximum number of trials to return in the response. The default value is 10.
- NextToken
-
- Type: string
If the previous call to
ListTrialsdidn't return the full set of trials, the call returns a token for getting the next set of trials. - SortBy
-
- Type: string
The property used to sort results. The default value is
CreationTime. - SortOrder
-
- Type: string
The sort order. The default value is
Descending. - TrialComponentName
-
- Type: string
A filter that returns only trials that are associated with the specified trial component.
Result Syntax
[
'NextToken' => '',
'TrialSummaries' => [
[
'CreationTime' => ,
'DisplayName' => '',
'LastModifiedTime' => ,
'TrialArn' => '',
'TrialName' => '',
'TrialSource' => [
'SourceArn' => '',
'SourceType' => '',
],
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
A token for getting the next set of trials, if there are any.
- TrialSummaries
-
- Type: Array of TrialSummary structures
A list of the summaries of your trials.
Errors
- ResourceNotFound:
Resource being access is not found.
ListUltraServersByReservedCapacity
$result = $client->listUltraServersByReservedCapacity([/* ... */]); $promise = $client->listUltraServersByReservedCapacityAsync([/* ... */]);
Lists all UltraServers that are part of a specified reserved capacity.
Parameter Syntax
$result = $client->listUltraServersByReservedCapacity([
'MaxResults' => ,
'NextToken' => '',
'ReservedCapacityArn' => '', // REQUIRED
]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of UltraServers to return in the response. The default value is 10.
- NextToken
-
- Type: string
If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
- ReservedCapacityArn
-
- Required: Yes
- Type: string
The ARN of the reserved capacity to list UltraServers for.
Result Syntax
[
'NextToken' => '',
'UltraServers' => [
[
'AvailabilityZone' => '',
'AvailableInstanceCount' => ,
'AvailableSpareInstanceCount' => ,
'ConfiguredSpareInstanceCount' => ,
'HealthStatus' => 'OK|Impaired|Insufficient-Data',
'InUseInstanceCount' => ,
'InstanceType' => 'ml.p4d.24xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.trn1.32xlarge|ml.trn2.48xlarge|ml.p6-b200.48xlarge|ml.p4de.24xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge|ml.p6-b300.48xlarge',
'TotalInstanceCount' => ,
'UltraServerId' => '',
'UltraServerType' => '',
'UnhealthyInstanceCount' => ,
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
If the response is truncated, SageMaker returns this token. Use it in the next request to retrieve the next set of UltraServers.
- UltraServers
-
- Required: Yes
- Type: Array of UltraServer structures
A list of UltraServers that are part of the specified reserved capacity.
Errors
- ResourceNotFound:
Resource being access is not found.
ListUserProfiles
$result = $client->listUserProfiles([/* ... */]); $promise = $client->listUserProfilesAsync([/* ... */]);
Lists user profiles.
Parameter Syntax
$result = $client->listUserProfiles([
'DomainIdEquals' => '',
'MaxResults' => ,
'NextToken' => '',
'SortBy' => 'CreationTime|LastModifiedTime',
'SortOrder' => 'Ascending|Descending',
'UserProfileNameContains' => '',
]);
Parameter Details
Members
- DomainIdEquals
-
- Type: string
A parameter by which to filter the results.
- MaxResults
-
- Type: int
This parameter defines the maximum number of results that can be return in a single response. The
MaxResultsparameter is an upper bound, not a target. If there are more results available than the value specified, aNextTokenis provided in the response. TheNextTokenindicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value forMaxResultsis 10. - NextToken
-
- Type: string
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
- SortBy
-
- Type: string
The parameter by which to sort the results. The default is CreationTime.
- SortOrder
-
- Type: string
The sort order for the results. The default is Ascending.
- UserProfileNameContains
-
- Type: string
A parameter by which to filter the results.
Result Syntax
[
'NextToken' => '',
'UserProfiles' => [
[
'CreationTime' => ,
'DomainId' => '',
'LastModifiedTime' => ,
'Status' => 'Deleting|Failed|InService|Pending|Updating|Update_Failed|Delete_Failed',
'UserProfileName' => '',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
- UserProfiles
-
- Type: Array of UserProfileDetails structures
The list of user profiles.
Errors
There are no errors described for this operation.
ListWorkforces
$result = $client->listWorkforces([/* ... */]); $promise = $client->listWorkforcesAsync([/* ... */]);
Use this operation to list all private and vendor workforces in an Amazon Web Services Region. Note that you can only have one private workforce per Amazon Web Services Region.
Parameter Syntax
$result = $client->listWorkforces([
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreateDate',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of workforces returned in the response.
- NameContains
-
- Type: string
A filter you can use to search for workforces using part of the workforce name.
- NextToken
-
- Type: string
A token to resume pagination.
- SortBy
-
- Type: string
Sort workforces using the workforce name or creation date.
- SortOrder
-
- Type: string
Sort workforces in ascending or descending order.
Result Syntax
[
'NextToken' => '',
'Workforces' => [
[
'CognitoConfig' => [
'ClientId' => '',
'UserPool' => '',
],
'CreateDate' => ,
'FailureReason' => '',
'IpAddressType' => 'ipv4|dualstack',
'LastUpdatedDate' => ,
'OidcConfig' => [
'AuthenticationRequestExtraParams' => ['', ...],
'AuthorizationEndpoint' => '',
'ClientId' => '',
'Issuer' => '',
'JwksUri' => '',
'LogoutEndpoint' => '',
'Scope' => '',
'TokenEndpoint' => '',
'UserInfoEndpoint' => '',
],
'SourceIpConfig' => [
'Cidrs' => ['', ...],
],
'Status' => 'Initializing|Updating|Deleting|Failed|Active',
'SubDomain' => '',
'WorkforceArn' => '',
'WorkforceName' => '',
'WorkforceVpcConfig' => [
'SecurityGroupIds' => ['', ...],
'Subnets' => ['', ...],
'VpcEndpointId' => '',
'VpcId' => '',
],
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
A token to resume pagination.
- Workforces
-
- Required: Yes
- Type: Array of Workforce structures
A list containing information about your workforce.
Errors
There are no errors described for this operation.
ListWorkteams
$result = $client->listWorkteams([/* ... */]); $promise = $client->listWorkteamsAsync([/* ... */]);
Gets a list of private work teams that you have defined in a region. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.
Parameter Syntax
$result = $client->listWorkteams([
'MaxResults' => ,
'NameContains' => '',
'NextToken' => '',
'SortBy' => 'Name|CreateDate',
'SortOrder' => 'Ascending|Descending',
]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of work teams to return in each page of the response.
- NameContains
-
- Type: string
A string in the work team's name. This filter returns only work teams whose name contains the specified string.
- NextToken
-
- Type: string
If the result of the previous
ListWorkteamsrequest was truncated, the response includes aNextToken. To retrieve the next set of labeling jobs, use the token in the next request. - SortBy
-
- Type: string
The field to sort results by. The default is
CreationTime. - SortOrder
-
- Type: string
The sort order for results. The default is
Ascending.
Result Syntax
[
'NextToken' => '',
'Workteams' => [
[
'CreateDate' => ,
'Description' => '',
'LastUpdatedDate' => ,
'MemberDefinitions' => [
[
'CognitoMemberDefinition' => [
'ClientId' => '',
'UserGroup' => '',
'UserPool' => '',
],
'OidcMemberDefinition' => [
'Groups' => ['', ...],
],
],
// ...
],
'NotificationConfiguration' => [
'NotificationTopicArn' => '',
],
'ProductListingIds' => ['', ...],
'SubDomain' => '',
'WorkerAccessConfiguration' => [
'S3Presign' => [
'IamPolicyConstraints' => [
'SourceIp' => 'Enabled|Disabled',
'VpcSourceIp' => 'Enabled|Disabled',
],
],
],
'WorkforceArn' => '',
'WorkteamArn' => '',
'WorkteamName' => '',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.
- Workteams
-
- Required: Yes
- Type: Array of Workteam structures
An array of
Workteamobjects, each describing a work team.
Errors
There are no errors described for this operation.
PutModelPackageGroupPolicy
$result = $client->putModelPackageGroupPolicy([/* ... */]); $promise = $client->putModelPackageGroupPolicyAsync([/* ... */]);
Adds a resouce policy to control access to a model group. For information about resoure policies, see Identity-based policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..
Parameter Syntax
$result = $client->putModelPackageGroupPolicy([
'ModelPackageGroupName' => '', // REQUIRED
'ResourcePolicy' => '', // REQUIRED
]);
Parameter Details
Members
- ModelPackageGroupName
-
- Required: Yes
- Type: string
The name of the model group to add a resource policy to.
- ResourcePolicy
-
- Required: Yes
- Type: string
The resource policy for the model group.
Result Syntax
[
'ModelPackageGroupArn' => '',
]
Result Details
Members
- ModelPackageGroupArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the model package group.
Errors
- ConflictException:
There was a conflict when you attempted to modify a SageMaker entity such as an
ExperimentorArtifact.
QueryLineage
$result = $client->queryLineage([/* ... */]); $promise = $client->queryLineageAsync([/* ... */]);
Use this action to inspect your lineage and discover relationships between entities. For more information, see Querying Lineage Entities in the Amazon SageMaker Developer Guide.
Parameter Syntax
$result = $client->queryLineage([
'Direction' => 'Both|Ascendants|Descendants',
'Filters' => [
'CreatedAfter' => ,
'CreatedBefore' => ,
'LineageTypes' => ['', ...],
'ModifiedAfter' => ,
'ModifiedBefore' => ,
'Properties' => ['', ...],
'Types' => ['', ...],
],
'IncludeEdges' => true || false,
'MaxDepth' => ,
'MaxResults' => ,
'NextToken' => '',
'StartArns' => ['', ...],
]);
Parameter Details
Members
- Direction
-
- Type: string
Associations between lineage entities have a direction. This parameter determines the direction from the StartArn(s) that the query traverses.
- Filters
-
- Type: QueryFilters structure
A set of filtering parameters that allow you to specify which entities should be returned.
-
Properties - Key-value pairs to match on the lineage entities' properties.
-
LineageTypes - A set of lineage entity types to match on. For example:
TrialComponent,Artifact, orContext. -
CreatedBefore - Filter entities created before this date.
-
ModifiedBefore - Filter entities modified before this date.
-
ModifiedAfter - Filter entities modified after this date.
- IncludeEdges
-
- Type: boolean
Setting this value to
Trueretrieves not only the entities of interest but also the Associations and lineage entities on the path. Set toFalseto only return lineage entities that match your query. - MaxDepth
-
- Type: int
The maximum depth in lineage relationships from the
StartArnsthat are traversed. Depth is a measure of the number ofAssociationsfrom theStartArnentity to the matched results. - MaxResults
-
- Type: int
Limits the number of vertices in the results. Use the
NextTokenin a response to to retrieve the next page of results. - NextToken
-
- Type: string
Limits the number of vertices in the request. Use the
NextTokenin a response to to retrieve the next page of results. - StartArns
-
- Type: Array of strings
A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.
Result Syntax
[
'Edges' => [
[
'AssociationType' => 'ContributedTo|AssociatedWith|DerivedFrom|Produced|SameAs',
'DestinationArn' => '',
'SourceArn' => '',
],
// ...
],
'NextToken' => '',
'Vertices' => [
[
'Arn' => '',
'LineageType' => 'TrialComponent|Artifact|Context|Action',
'Type' => '',
],
// ...
],
]
Result Details
Members
- Edges
-
- Type: Array of Edge structures
A list of edges that connect vertices in the response.
- NextToken
-
- Type: string
Limits the number of vertices in the response. Use the
NextTokenin a response to to retrieve the next page of results. - Vertices
-
- Type: Array of Vertex structures
A list of vertices connected to the start entity(ies) in the lineage graph.
Errors
- ResourceNotFound:
Resource being access is not found.
RegisterDevices
$result = $client->registerDevices([/* ... */]); $promise = $client->registerDevicesAsync([/* ... */]);
Register devices.
Parameter Syntax
$result = $client->registerDevices([
'DeviceFleetName' => '', // REQUIRED
'Devices' => [ // REQUIRED
[
'Description' => '',
'DeviceName' => '', // REQUIRED
'IotThingName' => '',
],
// ...
],
'Tags' => [
[
'Key' => '', // REQUIRED
'Value' => '', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
- ResourceLimitExceeded:
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
RenderUiTemplate
$result = $client->renderUiTemplate([/* ... */]); $promise = $client->renderUiTemplateAsync([/* ... */]);
Renders the UI template so that you can preview the worker's experience.
Parameter Syntax
$result = $client->renderUiTemplate([
'HumanTaskUiArn' => '',
'RoleArn' => '', // REQUIRED
'Task' => [ // REQUIRED
'Input' => '', // REQUIRED
],
'UiTemplate' => [
'Content' => '', // REQUIRED
],
]);
Parameter Details
Members
- HumanTaskUiArn
-
- Type: string
The
HumanTaskUiArnof the worker UI that you want to render. Do not provide aHumanTaskUiArnif you use theUiTemplateparameter.See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.
- Task
-
- Required: Yes
- Type: RenderableTask structure
A
RenderableTaskobject containing a representative task to render. - UiTemplate
-
- Type: UiTemplate structure
A
Templateobject containing the worker UI template to render.
Result Syntax
[
'Errors' => [
[
'Code' => '',
'Message' => '',
],
// ...
],
'RenderedContent' => '',
]
Result Details
Members
- Errors
-
- Required: Yes
- Type: Array of RenderingError structures
A list of one or more
RenderingErrorobjects if any were encountered while rendering the template. If there were no errors, the list is empty. - RenderedContent
-
- Required: Yes
- Type: string
A Liquid template that renders the HTML for the worker UI.
Errors
- ResourceNotFound:
Resource being access is not found.
RetryPipelineExecution
$result = $client->retryPipelineExecution([/* ... */]); $promise = $client->retryPipelineExecutionAsync([/* ... */]);
Retry the execution of the pipeline.
Parameter Syntax
$result = $client->retryPipelineExecution([
'ClientRequestToken' => '', // REQUIRED
'ParallelismConfiguration' => [
'MaxParallelExecutionSteps' => , // REQUIRED
],
'PipelineExecutionArn' => '', // REQUIRED
]);
Parameter Details
Members
- ClientRequestToken
-
- Required: Yes
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.
- ParallelismConfiguration
-
- Type: ParallelismConfiguration structure
This configuration, if specified, overrides the parallelism configuration of the parent pipeline.
- PipelineExecutionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the pipeline execution.
Result Syntax
[
'PipelineExecutionArn' => '',
]
Result Details
Members
- PipelineExecutionArn
-
- Type: string
The Amazon Resource Name (ARN) of the pipeline execution.
Errors
- ConflictException:
There was a conflict when you attempted to modify a SageMaker entity such as an
ExperimentorArtifact.- 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.
Search
$result = $client->search([/* ... */]); $promise = $client->searchAsync([/* ... */]);
Finds SageMaker resources that match a search query. Matching resources are returned as a list of SearchRecord objects in the response. You can sort the search results by any resource property in a ascending or descending order.
You can query against the following value types: numeric, text, Boolean, and timestamp.
The Search API may provide access to otherwise restricted data. See Amazon SageMaker API Permissions: Actions, Permissions, and Resources Reference for more information.
Parameter Syntax
$result = $client->search([
'CrossAccountFilterOption' => 'SameAccount|CrossAccount',
'MaxResults' => ,
'NextToken' => '',
'Resource' => 'TrainingJob|Experiment|ExperimentTrial|ExperimentTrialComponent|Endpoint|Model|ModelPackage|ModelPackageGroup|Pipeline|PipelineExecution|FeatureGroup|FeatureMetadata|Image|ImageVersion|Project|HyperParameterTuningJob|ModelCard|PipelineVersion|Job|HubContent', // REQUIRED
'SearchExpression' => [
'Filters' => [
[
'Name' => '', // REQUIRED
'Operator' => 'Equals|NotEquals|GreaterThan|GreaterThanOrEqualTo|LessThan|LessThanOrEqualTo|Contains|Exists|NotExists|In',
'Value' => '',
],
// ...
],
'NestedFilters' => [
[
'Filters' => [ // REQUIRED
[
'Name' => '', // REQUIRED
'Operator' => 'Equals|NotEquals|GreaterThan|GreaterThanOrEqualTo|LessThan|LessThanOrEqualTo|Contains|Exists|NotExists|In',
'Value' => '',
],
// ...
],
'NestedPropertyName' => '', // REQUIRED
],
// ...
],
'Operator' => 'And|Or',
'SubExpressions' => [
[...], // RECURSIVE
// ...
],
],
'SortBy' => '',
'SortOrder' => 'Ascending|Descending',
'VisibilityConditions' => [
[
'Key' => '',
'Value' => '',
],
// ...
],
]);
Parameter Details
Members
- CrossAccountFilterOption
-
- Type: string
A cross account filter option. When the value is
"CrossAccount"the search results will only include resources made discoverable to you from other accounts. When the value is"SameAccount"ornullthe search results will only include resources from your account. Default isnull. For more information on searching for resources made discoverable to your account, see Search discoverable resources in the SageMaker Developer Guide. The maximum number ofResourceCatalogs viewable is 1000. - MaxResults
-
- Type: int
The maximum number of results to return.
- NextToken
-
- Type: string
If more than
MaxResultsresources match the specifiedSearchExpression, the response includes aNextToken. TheNextTokencan be passed to the nextSearchRequestto continue retrieving results. - Resource
-
- Required: Yes
- Type: string
The name of the SageMaker resource to search for.
- SearchExpression
-
- Type: SearchExpression structure
A Boolean conditional statement. Resources must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive
SubExpressions,NestedFilters, andFiltersthat can be included in aSearchExpressionobject is 50. - SortBy
-
- Type: string
The name of the resource property used to sort the
SearchResults. The default isLastModifiedTime. - SortOrder
-
- Type: string
How
SearchResultsare ordered. Valid values areAscendingorDescending. The default isDescending. - VisibilityConditions
-
- Type: Array of VisibilityConditions structures
Limits the results of your search request to the resources that you can access.
Result Syntax
[
'NextToken' => '',
'Results' => [
[
'Endpoint' => [
'CreationTime' => ,
'DataCaptureConfig' => [
'CaptureStatus' => 'Started|Stopped',
'CurrentSamplingPercentage' => ,
'DestinationS3Uri' => '',
'EnableCapture' => true || false,
'KmsKeyId' => '',
],
'EndpointArn' => '',
'EndpointConfigName' => '',
'EndpointName' => '',
'EndpointStatus' => 'OutOfService|Creating|Updating|SystemUpdating|RollingBack|InService|Deleting|Failed|UpdateRollbackFailed',
'FailureReason' => '',
'LastModifiedTime' => ,
'MonitoringSchedules' => [
[
'CreationTime' => ,
'EndpointName' => '',
'FailureReason' => '',
'LastModifiedTime' => ,
'LastMonitoringExecutionSummary' => [
'CreationTime' => ,
'EndpointName' => '',
'FailureReason' => '',
'LastModifiedTime' => ,
'MonitoringExecutionStatus' => 'Pending|Completed|CompletedWithViolations|InProgress|Failed|Stopping|Stopped',
'MonitoringJobDefinitionName' => '',
'MonitoringScheduleName' => '',
'MonitoringType' => 'DataQuality|ModelQuality|ModelBias|ModelExplainability',
'ProcessingJobArn' => '',
'ScheduledTime' => ,
],
'MonitoringScheduleArn' => '',
'MonitoringScheduleConfig' => [
'MonitoringJobDefinition' => [
'BaselineConfig' => [
'BaseliningJobName' => '',
'ConstraintsResource' => [
'S3Uri' => '',
],
'StatisticsResource' => [
'S3Uri' => '',
],
],
'Environment' => ['', ...],
'MonitoringAppSpecification' => [
'ContainerArguments' => ['', ...],
'ContainerEntrypoint' => ['', ...],
'ImageUri' => '',
'PostAnalyticsProcessorSourceUri' => '',
'RecordPreprocessorSourceUri' => '',
],
'MonitoringInputs' => [
[
'BatchTransformInput' => [
'DataCapturedDestinationS3Uri' => '',
'DatasetFormat' => [
'Csv' => [
'Header' => true || false,
],
'Json' => [
'Line' => true || false,
],
'Parquet' => [
],
],
'EndTimeOffset' => '',
'ExcludeFeaturesAttribute' => '',
'FeaturesAttribute' => '',
'InferenceAttribute' => '',
'LocalPath' => '',
'ProbabilityAttribute' => '',
'ProbabilityThresholdAttribute' => ,
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3InputMode' => 'Pipe|File',
'StartTimeOffset' => '',
],
'EndpointInput' => [
'EndTimeOffset' => '',
'EndpointName' => '',
'ExcludeFeaturesAttribute' => '',
'FeaturesAttribute' => '',
'InferenceAttribute' => '',
'LocalPath' => '',
'ProbabilityAttribute' => '',
'ProbabilityThresholdAttribute' => ,
'S3DataDistributionType' => 'FullyReplicated|ShardedByS3Key',
'S3InputMode' => 'Pipe|File',
'StartTimeOffset' => '',
],
],
// ...
],
'MonitoringOutputConfig' => [
'KmsKeyId' => '',
'MonitoringOutputs' => [
[
'S3Output' => [
'LocalPath' => '',
'S3UploadMode' => 'Continuous|EndOfJob',
'S3Uri' => '',
],
],
// ...
],
],
'MonitoringResources' => [
'ClusterConfig' => [
'InstanceCount' => ,
'InstanceType' => 'ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.p5.4xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.m8i.large|ml.m8i.xlarge|ml.m8i.2xlarge|ml.m8i.4xlarge|ml.m8i.8xlarge|ml.m8i.12xlarge|ml.m8i.16xlarge|ml.m8i.24xlarge|ml.m8i.32xlarge|ml.m8i.48xlarge|ml.m8i.96xlarge|ml.c8i.xlarge|ml.c8i.2xlarge|ml.c8i.4xlarge|ml.c8i.8xlarge|ml.c8i.12xlarge|ml.c8i.16xlarge|ml.c8i.24xlarge|ml.c8i.32xlarge|ml.c8i.48xlarge|ml.c8i.96xlarge|ml.r8i.large|ml.r8i.xlarge|ml.r8i.2xlarge|ml.r8i.4xlarge|ml.r8i.8xlarge|ml.r8i.12xlarge|ml.r8i.16xlarge|ml.r8i.24xlarge|ml.r8i.32xlarge|ml.r8i.48xlarge|ml.r8i.96xlarge|ml.m7i-flex.large|ml.m7i-flex.xlarge|ml.m7i-flex.2xlarge|ml.m7i-flex.4xlarge|ml.m7i-flex.8xlarge|ml.m7i-flex.12xlarge|ml.m7i-flex.16xlarge|ml.c7i-flex.xlarge|ml.c7i-flex.2xlarge|ml.c7i-flex.4xlarge|ml.c7i-flex.8xlarge|ml.c7i-flex.12xlarge|ml.c7i-flex.16xlarge|ml.m8i-flex.large|ml.m8i-flex.xlarge|ml.m8i-flex.2xlarge|ml.m8i-flex.4xlarge|ml.m8i-flex.8xlarge|ml.m8i-flex.12xlarge|ml.m8i-flex.16xlarge|ml.c8i-flex.xlarge|ml.c8i-flex.2xlarge|ml.c8i-flex.4xlarge|ml.c8i-flex.8xlarge|ml.c8i-flex.12xlarge|ml.c8i-flex.16xlarge|ml.r8i-flex.large|ml.r8i-flex.xlarge|ml.r8i-flex.2xlarge|ml.r8i-flex.4xlarge|ml.r8i-flex.8xlarge|ml.r8i-flex.12xlarge|ml.r8i-flex.16xlarge',
'VolumeKmsKeyId' => '',
'VolumeSizeInGB' => ,
],
],
'NetworkConfig' => [
'EnableInterContainerTrafficEncryption' => true || false,
'EnableNetworkIsolation' => true || false,
'VpcConfig' => [
'SecurityGroupIds' => ['', ...],
'Subnets' => ['', ...],
],
],
'RoleArn' => '',
'StoppingCondition' => [
'MaxRuntimeInSeconds' => ,
],
],
'MonitoringJobDefinitionName' => '',
'MonitoringType' => 'DataQuality|ModelQuality|ModelBias|ModelExplainability',
'ScheduleConfig' => [
'DataAnalysisEndTime' => '',
'DataAnalysisStartTime' => '',
'ScheduleExpression' => '',
],
],
'MonitoringScheduleName' => '',
'MonitoringScheduleStatus' => 'Pending|Failed|Scheduled|Stopped',
'MonitoringType' => 'DataQuality|ModelQuality|ModelBias|ModelExplainability',
'Tags' => [
[
'Key' => '',
'Value' => '',
],
// ...
],
],
// ...
],
'ProductionVariants' => [
[
'CapacityReservationConfig' => [
'AvailableInstanceCount' => ,
'CapacityReservationPreference' => 'capacity-reservations-only',
'Ec2CapacityReservations' => [
[
'AvailableInstanceCount' => ,
'Ec2CapacityReservationId' => '',
'TotalInstanceCount' => ,
'UsedByCurrentEndpoint' => ,
],
// ...
],
'MlReservationArn' => '',
'TotalInstanceCount' => ,
'UsedByCurrentEndpoint' => ,
],
'CurrentInstanceCount' => ,
'CurrentServerlessConfig' => [
'MaxConcurrency' => ,
'MemorySizeInMB' => ,
'ProvisionedConcurrency' => ,
],
'CurrentWeight' => ,
'DeployedImages' => [
[
'ResolutionTime' => ,
'ResolvedImage' => '',
'SpecifiedImage' => '',
],
// ...
],
'DesiredInstanceCount' => ,
'DesiredServerlessConfig' => [
'MaxConcurrency' => ,
'MemorySizeInMB' => ,
'ProvisionedConcurrency' => ,
],
'DesiredWeight' => ,
'InstancePools' => [
[
'CurrentInstanceCount' => ,
'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.12xlarge|ml.m5d.24xlarge|ml.c4.large|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.large|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.12xlarge|ml.r5.24xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.12xlarge|ml.r5d.24xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.dl1.24xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.r8g.medium|ml.r8g.large|ml.r8g.xlarge|ml.r8g.2xlarge|ml.r8g.4xlarge|ml.r8g.8xlarge|ml.r8g.12xlarge|ml.r8g.16xlarge|ml.r8g.24xlarge|ml.r8g.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.p4d.24xlarge|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m6gd.large|ml.m6gd.xlarge|ml.m6gd.2xlarge|ml.m6gd.4xlarge|ml.m6gd.8xlarge|ml.m6gd.12xlarge|ml.m6gd.16xlarge|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c6gd.large|ml.c6gd.xlarge|ml.c6gd.2xlarge|ml.c6gd.4xlarge|ml.c6gd.8xlarge|ml.c6gd.12xlarge|ml.c6gd.16xlarge|ml.c6gn.large|ml.c6gn.xlarge|ml.c6gn.2xlarge|ml.c6gn.4xlarge|ml.c6gn.8xlarge|ml.c6gn.12xlarge|ml.c6gn.16xlarge|ml.r6g.large|ml.r6g.xlarge|ml.r6g.2xlarge|ml.r6g.4xlarge|ml.r6g.8xlarge|ml.r6g.12xlarge|ml.r6g.16xlarge|ml.r6gd.large|ml.r6gd.xlarge|ml.r6gd.2xlarge|ml.r6gd.4xlarge|ml.r6gd.8xlarge|ml.r6gd.12xlarge|ml.r6gd.16xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.r7gd.medium|ml.r7gd.large|ml.r7gd.xlarge|ml.r7gd.2xlarge|ml.r7gd.4xlarge|ml.r7gd.8xlarge|ml.r7gd.12xlarge|ml.r7gd.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.c6in.large|ml.c6in.xlarge|ml.c6in.2xlarge|ml.c6in.4xlarge|ml.c6in.8xlarge|ml.c6in.12xlarge|ml.c6in.16xlarge|ml.c6in.24xlarge|ml.c6in.32xlarge|ml.p6-b200.48xlarge|ml.p6-b300.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge',
],
// ...
],
'ManagedInstanceScaling' => [
'MaxInstanceCount' => ,
'MinInstanceCount' => ,
'ScaleInPolicy' => [
'CooldownInMinutes' => ,
'MaximumStepSize' => ,
'Strategy' => 'IDLE_RELEASE|CONSOLIDATION',
],
'Status' => 'ENABLED|DISABLED',
],
'RoutingConfig' => [
'PrefixAwareRoutingConfig' => [
'ConcurrencyThreshold' => ,
'PrefixLength' => ,
],
'RoutingStrategy' => 'LEAST_OUTSTANDING_REQUESTS|RANDOM|PREFIX_AWARE',
],
'VariantName' => '',
'VariantStatus' => [
[
'StartTime' => ,
'Status' => 'Creating|Updating|Deleting|ActivatingTraffic|Baking',
'StatusMessage' => '',
],
// ...
],
],
// ...
],
'ShadowProductionVariants' => [
[
'CapacityReservationConfig' => [
'AvailableInstanceCount' => ,
'CapacityReservationPreference' => 'capacity-reservations-only',
'Ec2CapacityReservations' => [
[
'AvailableInstanceCount' => ,
'Ec2CapacityReservationId' => '',
'TotalInstanceCount' => ,
'UsedByCurrentEndpoint' => ,
],
// ...
],
'MlReservationArn' => '',
'TotalInstanceCount' => ,
'UsedByCurrentEndpoint' => ,
],
'CurrentInstanceCount' => ,
'CurrentServerlessConfig' => [
'MaxConcurrency' => ,
'MemorySizeInMB' => ,
'ProvisionedConcurrency' => ,
],
'CurrentWeight' => ,
'DeployedImages' => [
[
'ResolutionTime' => ,
'ResolvedImage' => '',
'SpecifiedImage' => '',
],
// ...
],
'DesiredInstanceCount' => ,
'DesiredServerlessConfig' => [
'MaxConcurrency' => ,
'MemorySizeInMB' => ,
'ProvisionedConcurrency' => ,
],
'DesiredWeight' => ,
'InstancePools' => [
[
'CurrentInstanceCount' => ,
'InstanceType' => 'ml.t2.medium|ml.t2.large|ml.t2.xlarge|ml.t2.2xlarge|ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.m5d.large|ml.m5d.xlarge|ml.m5d.2xlarge|ml.m5d.4xlarge|ml.m5d.12xlarge|ml.m5d.24xlarge|ml.c4.large|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.c5.large|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5d.large|ml.c5d.xlarge|ml.c5d.2xlarge|ml.c5d.4xlarge|ml.c5d.9xlarge|ml.c5d.18xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.12xlarge|ml.r5.24xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.12xlarge|ml.r5d.24xlarge|ml.inf1.xlarge|ml.inf1.2xlarge|ml.inf1.6xlarge|ml.inf1.24xlarge|ml.dl1.24xlarge|ml.c6i.large|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.4xlarge|ml.c6i.8xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.r6i.large|ml.r6i.xlarge|ml.r6i.2xlarge|ml.r6i.4xlarge|ml.r6i.8xlarge|ml.r6i.12xlarge|ml.r6i.16xlarge|ml.r6i.24xlarge|ml.r6i.32xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.12xlarge|ml.g5.16xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.g6.xlarge|ml.g6.2xlarge|ml.g6.4xlarge|ml.g6.8xlarge|ml.g6.12xlarge|ml.g6.16xlarge|ml.g6.24xlarge|ml.g6.48xlarge|ml.r8g.medium|ml.r8g.large|ml.r8g.xlarge|ml.r8g.2xlarge|ml.r8g.4xlarge|ml.r8g.8xlarge|ml.r8g.12xlarge|ml.r8g.16xlarge|ml.r8g.24xlarge|ml.r8g.48xlarge|ml.g6e.xlarge|ml.g6e.2xlarge|ml.g6e.4xlarge|ml.g6e.8xlarge|ml.g6e.12xlarge|ml.g6e.16xlarge|ml.g6e.24xlarge|ml.g6e.48xlarge|ml.g7e.2xlarge|ml.g7e.4xlarge|ml.g7e.8xlarge|ml.g7e.12xlarge|ml.g7e.24xlarge|ml.g7e.48xlarge|ml.g7.2xlarge|ml.g7.4xlarge|ml.g7.8xlarge|ml.g7.12xlarge|ml.g7.24xlarge|ml.g7.48xlarge|ml.p4d.24xlarge|ml.c7g.large|ml.c7g.xlarge|ml.c7g.2xlarge|ml.c7g.4xlarge|ml.c7g.8xlarge|ml.c7g.12xlarge|ml.c7g.16xlarge|ml.m6g.large|ml.m6g.xlarge|ml.m6g.2xlarge|ml.m6g.4xlarge|ml.m6g.8xlarge|ml.m6g.12xlarge|ml.m6g.16xlarge|ml.m6gd.large|ml.m6gd.xlarge|ml.m6gd.2xlarge|ml.m6gd.4xlarge|ml.m6gd.8xlarge|ml.m6gd.12xlarge|ml.m6gd.16xlarge|ml.c6g.large|ml.c6g.xlarge|ml.c6g.2xlarge|ml.c6g.4xlarge|ml.c6g.8xlarge|ml.c6g.12xlarge|ml.c6g.16xlarge|ml.c6gd.large|ml.c6gd.xlarge|ml.c6gd.2xlarge|ml.c6gd.4xlarge|ml.c6gd.8xlarge|ml.c6gd.12xlarge|ml.c6gd.16xlarge|ml.c6gn.large|ml.c6gn.xlarge|ml.c6gn.2xlarge|ml.c6gn.4xlarge|ml.c6gn.8xlarge|ml.c6gn.12xlarge|ml.c6gn.16xlarge|ml.r6g.large|ml.r6g.xlarge|ml.r6g.2xlarge|ml.r6g.4xlarge|ml.r6g.8xlarge|ml.r6g.12xlarge|ml.r6g.16xlarge|ml.r6gd.large|ml.r6gd.xlarge|ml.r6gd.2xlarge|ml.r6gd.4xlarge|ml.r6gd.8xlarge|ml.r6gd.12xlarge|ml.r6gd.16xlarge|ml.p4de.24xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.trn2.48xlarge|ml.inf2.xlarge|ml.inf2.8xlarge|ml.inf2.24xlarge|ml.inf2.48xlarge|ml.p5.48xlarge|ml.p5e.48xlarge|ml.p5en.48xlarge|ml.m7i.large|ml.m7i.xlarge|ml.m7i.2xlarge|ml.m7i.4xlarge|ml.m7i.8xlarge|ml.m7i.12xlarge|ml.m7i.16xlarge|ml.m7i.24xlarge|ml.m7i.48xlarge|ml.c7i.large|ml.c7i.xlarge|ml.c7i.2xlarge|ml.c7i.4xlarge|ml.c7i.8xlarge|ml.c7i.12xlarge|ml.c7i.16xlarge|ml.c7i.24xlarge|ml.c7i.48xlarge|ml.r7i.large|ml.r7i.xlarge|ml.r7i.2xlarge|ml.r7i.4xlarge|ml.r7i.8xlarge|ml.r7i.12xlarge|ml.r7i.16xlarge|ml.r7i.24xlarge|ml.r7i.48xlarge|ml.c8g.medium|ml.c8g.large|ml.c8g.xlarge|ml.c8g.2xlarge|ml.c8g.4xlarge|ml.c8g.8xlarge|ml.c8g.12xlarge|ml.c8g.16xlarge|ml.c8g.24xlarge|ml.c8g.48xlarge|ml.r7gd.medium|ml.r7gd.large|ml.r7gd.xlarge|ml.r7gd.2xlarge|ml.r7gd.4xlarge|ml.r7gd.8xlarge|ml.r7gd.12xlarge|ml.r7gd.16xlarge|ml.m8g.medium|ml.m8g.large|ml.m8g.xlarge|ml.m8g.2xlarge|ml.m8g.4xlarge|ml.m8g.8xlarge|ml.m8g.12xlarge|ml.m8g.16xlarge|ml.m8g.24xlarge|ml.m8g.48xlarge|ml.c6in.large|ml.c6in.xlarge|ml.c6in.2xlarge|ml.c6in.4xlarge|ml.c6in.8xlarge|ml.c6in.12xlarge|ml.c6in.16xlarge|ml.c6in.24xlarge|ml.c6in.32xlarge|ml.p6-b200.48xlarge|ml.p6-b300.48xlarge|ml.p6e-gb200.36xlarge|ml.p5.4xlarge',
],
// ...
],
'ManagedInstanceScaling' => [
'MaxInstanceCount' => ,
'MinInstanceCount' => ,
'ScaleInPolicy' => [
'CooldownInMinutes' => ,
'MaximumStepSize' => ,
'Strategy' => 'IDLE_RELEASE|CONSOLIDATION',
],
'Status' => 'ENABLED|DISABLED',
],
'RoutingConfig' => [
'PrefixAwareRoutingConfig' => [
'ConcurrencyThreshold' => ,
'PrefixLength' => ,
],
'RoutingStrategy' => 'LEAST_OUTSTANDING_REQUESTS|RANDOM|PREFIX_AWARE',
],
'VariantName' => '',
'VariantStatus' => [
[
'StartTime' => ,
'Status' => 'Creating|Updating|Deleting|ActivatingTraffic|Baking',
'StatusMessage' => '',
],
// ...
],
],
// ...
],
'Tags' => [
[
'Key' => '',
'Value' => '',
],
// ...
],
],
'Experiment' => [
'CreatedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'CreationTime' => ,
'Description' => '',
'DisplayName' => '',
'ExperimentArn' => '',
'ExperimentName' => '',
'LastModifiedBy' => [
'DomainId' => '',
'IamIdentity' => [
'Arn' => '',
'PrincipalId' => '',
'SourceIdentity' => '',
],
'UserProfileArn' => '',
'UserProfileName' => '',
],
'LastModifiedTime' => ,
'Source' => [
'SourceArn' => '',
'SourceType' => '',
],
'Tags' => [
[
'Key' => '',
'Value' => '',
],
// ...
],
],
'FeatureGroup' => [
'CreationTime' => ,
'Description' => '',
'EventTimeFeatureName' => '',
'FailureReason' => '',
'FeatureDefinitions' => [
[
'CollectionConfig' => [
'VectorConfig' => [
'Dimension' => ,
],
],
'CollectionType' => 'List|Set|Vector',
'FeatureName' => '',
'FeatureType' => 'Integral|Fractional|String',
],
// ...
],
'FeatureGroupArn' => '',
'FeatureGroupName' => '',
'FeatureGroupStatus' => 'Creating|Created|CreateFailed|Deleting|DeleteFailed',
'LastModifiedTime' => ,
'LastUpdateStatus' => [
'FailureReason' => '',
'Status' => 'Successful|Failed|InProgress',
],
'OfflineStoreConfig' => [
'DataCatalogConfig' => [
'Catalog' => '',
'Database' => '',
'TableName' => '',
],
'DisableGlueTableCreation' => true || false,
'S3StorageConfig' => [
'KmsKeyId' => '',
'ResolvedOutputS3Uri' => '',
'S3Uri' => '',
],
'TableFormat' => 'Default|Glue|Iceberg',
],
'OfflineStoreStatus' => [
'BlockedReason' => '',
'Status' => 'Active|Blocked|Disabled',
],
'OnlineStoreConfig' => [
'EnableOnlineStore' => true || false,
'SecurityConfig' => [
'KmsKeyId' => '',
],
'StorageType' => 'Standard|Standard_V2|InMemory',
'TtlDuration' => [
'Unit' => 'Seconds|Minutes|Hours|Days|Weeks',
'Value' => ,
],
],
'RecordIdentifierFeatureName' => '',
'RoleArn' => '',
'Tags' => [
[
'Key' => '',
'Value' => '',
],
// ...
],
],
'FeatureMetadata' => [
'CreationTime' => ,
'Description' => '',
'FeatureGroupArn' => '',
'FeatureGroupName' => '',
'FeatureName' => '',
'FeatureType' => 'Integral|Fractional|String',
'LastModifiedTime' => ,
'Parameters' => [
[
'Key' => '',
'Value' => '',
],
// ...
],
],
'HubContent' => [
'CreationTime' => ,
'DocumentSchemaVersion' => '',
'FailureReason' => '',
'HubArn' => '',
'HubContentArn' => '',
'HubContentDependencies' => [
[
'DependencyCopyPath' => '',
'DependencyOriginPath' => '',
],
// ...
],
'HubContentDescription' => '',
'HubContentDisplayName' => '',
'HubContentDocument' => '',
'HubContentMarkdown' => '',
'HubContentName' => '',
'HubContentSearchKeywords' => ['', ...],
'HubContentStatus' => 'Available|Importing|Deleting|ImportFailed|DeleteFailed|PendingImport|PendingDelete',
'HubContentType' => 'Model|Notebook|ModelReference|DataSet|JsonDoc',
'HubContentVersion' => '',
'HubName' => '',
'LastModifiedTime' => ,
'ReferenceMinVersion' => '',
'SageMakerPublicHubContentArn' => '',
'SupportStatus' => 'Supported|Deprecated|Restricted',
'Tags' => [
[
'Key' => '',
'Value' => '',
],
// ...
],
],
'HyperParameterTuningJob' => [
'BestTrainingJob' => [
'CreationTime' => ,
'FailureReason' => '',
'FinalHyperParameterTuningJobObjectiveMetric' => [
'MetricName' => '',
'Type' => 'Maximize|Minimize',
'Value' => ,
],
'ObjectiveStatus' => 'Succeeded|Pending|Failed',
'TrainingEndTime' => ,
'TrainingJobArn' => '',
'TrainingJobDefinitionName' => '',
'TrainingJobName' => '',
'TrainingJobStatus' => 'InProgress|Completed|Failed|Stopping|Stopped|Deleting',
'TrainingStartTime' => ,
'TunedHyperParameters' => ['', ...],
'TuningJobName' => '',
],
'ConsumedResources' => [
'RuntimeInSeconds' => ,
],
'CreationTime' => ,
'FailureReason' => '',
'HyperParameterTuningEndTime' => ,
'HyperParameterTuningJobArn' => '',
'HyperParameterTuningJobConfig' => [
'HyperParameterTuningJobObjective' => [
'MetricName' => '',
'Type' => 'Maximize|Minimize',
],
'ParameterRanges' => [
'AutoParameters' => [
[
'Name' => '',
'ValueHint' => '',
],
// ...
],
'CategoricalParameterRanges' => [
[
'Name' => '',
'Values' => ['', ...],
],
// ...
],
'ContinuousParameterRanges' => [
[
'MaxValue' => '',
'MinValue' => '',
'Name' => '',
'ScalingType' => 'Auto|Linear|Logarithmic|ReverseLogarithmic',
],
// ...
],
'IntegerParameterRanges' => [
[
'MaxValue' => '',
'MinValue' => '',
'Name' => '',
'ScalingType' => 'Auto|Linear|Logarithmic|ReverseLogarithmic',
],
// ...
],
],
'RandomSeed' => ,
'ResourceLimits' => [
'MaxNumberOfTrainingJobs' => ,
'MaxParallelTrainingJobs' => ,
'MaxRuntimeInSeconds' => ,
],
'Strategy' => 'Bayesian|Random|Hyperband|Grid',
'StrategyConfig' => [
'HyperbandStrategyConfig' => [
'MaxResource' => ,
'MinResource' => ,
],
],
'TrainingJobEarlyStoppingType' => 'Off|Auto',
'TuningJobCompletionCriteria' => [
'BestObjectiveNotImproving' => [
'MaxNumberOfTrainingJobsNotImproving' => ,
],
'ConvergenceDetected' => [
'CompleteOnConvergence' => 'Disabled|Enabled',
],
'TargetObjectiveMetricValue' => ,
],
],
'HyperParameterTuningJobName' => '',
'HyperParameterTuningJobStatus' => 'Completed|InProgress|Failed|Stopped|Stopping|Deleting|DeleteFailed',
'LastModifiedTime' => ,
'ObjectiveStatusCounters' => [
'Failed' => ,
'Pending' => ,
'Succeeded' => ,
],
'OverallBestTrainingJob' => [
'CreationTime' => ,
'FailureReason' => '',
'FinalHyperParameterTuningJobObjectiveMetric' => [
'MetricName' => '',
'Type' => 'Maximize|Minimize',
'Value' =>